Class: ColorMap

• new ColorMap(options, name)

• new ColorMap(options?, name?)

ColorProvider.constructor

▸ clone(): ColorMap

Return clone of the color map

ColorMap

clone

ColorProvider.clone

▸ Protected copyConstructor(src, deepCopy?): ColorMap

Copy constructor

ColorMap

this

ColorProvider.copyConstructor

▸ dispose(): void

Dispose.

void

ColorProvider.dispose

▸ exportToImage(width, height, isVertical, surface?): Surface

returns surface that represents color map

Surface

surface The canvas surface

ColorProvider.exportToImage

▸ getClassName(): string

string

ColorProvider.getClassName

▸ getColor(value): RgbaColor

Return color for the current value

RgbaColor

the RgbaColor.

ColorProvider.getColor

▸ getColors(): RgbaColor[]

Return color array

RgbaColor[]

▸ getMaxValue(): number

Return max

number

Maximum of ColorProvider

ColorProvider.getMaxValue

▸ getMinValue(): number

Return min

number

Minimum of ColorProvider

ColorProvider.getMinValue

▸ getName(): string

Return name

string

▸ getNamedColor(colorName): string | NamedColorValue

Returns known color value

string | NamedColorValue

color

ColorProvider.getNamedColor

▸ getNamedColors(): NamedColor[]

Returns known colors

NamedColor[]

array of color pair

ColorProvider.getNamedColors

▸ getNegativeFillStyle(): FillStyle

Return negative fill style to be used instead of negative fill style

FillStyle

▸ getPositiveFillStyle(): FillStyle

Return positive fill style to be used instead of positive color

FillStyle

▸ getProperties(): OptionsOut

Returns properties

OptionsOut

Json object with properties

ColorProvider.getProperties

▸ getRaster(xMin?, yMin?, xMax?, yMax?): Raster

Returns a new instance of Raster

Raster

ColorProvider.getRaster

▸ getSize(): number

Return size

number

▸ getStopPoints(): { color: string ; value: number }[]

Return list of used Stop Points

{ color: string ; value: number }[]

ColorProvider.getStopPoints

▸ getTraceLineStyle(): LineStyle

Return trace line style to be used instead of trace color

LineStyle

▸ getTraceStatusLineStyle(status): LineStyle

Returns trace line style for specified status

LineStyle

▸ getTraceStatusLineStyle(): Partial<Record<Status, LineStyle>>

Returns an object with all statuses

Partial<Record<Status, LineStyle>>

▸ hasEventListener(type, callback?): boolean

Check if a list of event listeners for this type contains this listener

boolean

ColorProvider.hasEventListener

▸ hasNamedColor(colorName): boolean

Check if specified named color exists

boolean

true if color exists

ColorProvider.hasNamedColor

▸ invalidate(): ColorMap

Invalidate Default ColorProvider and notify visuals for update

ColorMap

ColorProvider.invalidate

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

ColorProvider.isDisposed

▸ isNotificationEnabled(): boolean

Return state of notification

boolean

ColorProvider.isNotificationEnabled

▸ isReversed(): boolean

Return reversed flag

boolean

▸ isSilent(): boolean

Return true if the event dispatcher doesn't notify any events

boolean

ColorProvider.isSilent

▸ notify<E>(type, source, args?): ColorMap

Notify listeners

ColorMap

this

ColorProvider.notify

▸ off<E>(type?, callback?): ColorMap

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.

ColorMap

this

ColorProvider.off

▸ on<E>(type, callback): ColorMap

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.

ColorMap

this

ColorProvider.on

▸ reverse(): ColorMap

Reverse color map

ColorMap

this

▸ setAlpha(alpha): ColorMap

Set alpha value for all colors

ColorMap

this

▸ setColors(colors, rampSize?): ColorMap

Sets colors

Throws

if color is null

ColorMap

this

▸ setName(name): ColorMap

Set name

ColorMap

this

▸ setNamedColor(colorName, colorValue): ColorMap

Set color value

Example

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

// use 'red' color for values greater than maxValue (default '+∞' title is used)
colorProvider.setNamedColor(KnownColors.PositiveInfinity, 'red');

ColorMap

this

ColorProvider.setNamedColor

▸ setNegativeFillStyle(style): ColorMap

Set negative fill style to be used instead of negative fill color

ColorMap

this

▸ setNotification(enable, force?): ColorMap

Enable / disable notification

ColorMap

this

ColorProvider.setNotification

▸ setPositiveFillStyle(style): ColorMap

Set positive fill style to be used instead of positive color

ColorMap

this

▸ setProperties(properties?): ColorMap

Sets properties

ColorMap

this

ColorProvider.setProperties

▸ setRange(min, max): ColorMap

Set min and max value

ColorMap

▸ setSilent(bool): ColorMap

Set silent mode

ColorMap

this

ColorProvider.setSilent

▸ setTraceLineStyle(style): ColorMap

Set trace line style to be used instead of trace color

ColorMap

this

▸ setTraceStatusLineStyle(status, linestyle): ColorMap

Sets trace line style for given status

ColorMap

this

▸ Static getClassName(): string

string

ColorProvider.getClassName

▸ Static getColorProviderType(objectType?): ClassType<any>

Return ColorProvider constructor from the object class name or type.

Deprecated

since 4.1 Use ColorProvider implementation directly

ClassType<any>

ColorProvider constructor

ColorProvider.getColorProviderType