API / geotoolkit / util / LogColorProvider / LogColorProvider
util.LogColorProvider.LogColorProvider
Creates a representation of Log color provider
Example
// Log Color Provider emulates logarithmic behavior
const logCP = new LogColorProvider({
'values' : [ 1 , 10 , 100 , 300 , 1000 ],
'colors' : ['orange', 'yellow', 'blue', 'green', 'gray'],
'bins': 16
});↳
LogColorProvider
Constructors
Methods
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 | |
scale | KnownScales | A predefined set of colors |
style | DisplayStyle | Display style |
Constructors
• new LogColorProvider(values?, colors?, bins?)
Creates color provider
| Name | Type | Description |
|---|---|---|
Optional values | number[] | Options | list of values |
Optional colors | (string | RgbaColor)[] | list of colors |
Optional bins | number | number of bins |
DiscreteGradientColorProvider.constructor
Methods
▸ addColor(value, color): LogColorProvider
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
| Name | Type | Description |
|---|---|---|
value | number | index of this color on the colorbar |
color | string | RgbaColor | CSS color string or RgbaColor object |
this
DiscreteGradientColorProvider.addColor
▸ addColor(json): LogColorProvider
Deprecated
| Name | Type |
|---|---|
json | Object |
Optional json.alpha | number |
Optional json.blue | number |
json.color | string | RgbaColor |
Optional json.green | number |
Optional json.red | number |
json.value | number |
DiscreteGradientColorProvider.addColor
▸ clone(): ColorProvider
Returns clone of color provider
DiscreteGradientColorProvider.clone
▸ Protected copyConstructor(src): LogColorProvider
Copy constructor
| Name | Type | Description |
|---|---|---|
src | ColorProvider | Source to copy from |
this
DiscreteGradientColorProvider.copyConstructor
▸ dispose(): void
Dispose.
void
DiscreteGradientColorProvider.dispose
▸ exportToImage(width, height, isVertical, surface?): Surface
returns surface that represents color map
| Name | Type | Description |
|---|---|---|
width | number | The image width |
height | number | The image height |
isVertical | boolean | True if image is oriented vertically |
Optional surface | Surface | output surface |
surface The canvas surface
DiscreteGradientColorProvider.exportToImage
▸ getClassName(): string
string
DiscreteGradientColorProvider.getClassName
▸ getColor(value): RgbaColor
Return color for the current value
| Name | Type | Description |
|---|---|---|
value | number | value |
color
DiscreteGradientColorProvider.getColor
▸ getColorNumber(): number
Returns how many colors can be provided
number
DiscreteGradientColorProvider.getColorNumber
▸ getColors(): RgbaColor[]
an array of the colors
DiscreteGradientColorProvider.getColors
▸ Protected getColorsProperties(): ColorsOptions
Returns colors and values to be serialized
colors and values
DiscreteGradientColorProvider.getColorsProperties
▸ Protected getDataMaxValue(): number
Returns the maximum data value set in this collection
number
DiscreteGradientColorProvider.getDataMaxValue
▸ Protected getDataMinValue(): number
Returns the minimum data value set in this collection
number
DiscreteGradientColorProvider.getDataMinValue
▸ getDisplayStyle(): DisplayStyle
display style.
▸ getMaxValue(): number
Returns the maximum value set in this collection
number
DiscreteGradientColorProvider.getMaxValue
▸ getMinValue(): number
Returns minimum value set in the collection
number
DiscreteGradientColorProvider.getMinValue
▸ getNamedColor(colorName): string | NamedColorValue
Returns known color value
| Name | Type | Description |
|---|---|---|
colorName | string | color name, if not specified then returns list of known colors |
string | NamedColorValue
color
DiscreteGradientColorProvider.getNamedColor
▸ getNamedColors(): NamedColor[]
Returns known colors
array of color pair
DiscreteGradientColorProvider.getNamedColors
▸ getProperties(): OptionsOut
Gets all the properties pertaining to this object
DiscreteGradientColorProvider.getProperties
▸ getRaster(xMin?, yMin?, xMax?, yMax?): Raster
Returns a new instance of Raster
| 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 |
DiscreteGradientColorProvider.getRaster
▸ getScale(): KnownScales
scale scale being used
DiscreteGradientColorProvider.getScale
▸ getStopPoints(): { color: string ; value: number }[]
{ color: string ; value: number }[]
an array of the {color,values} couples
DiscreteGradientColorProvider.getStopPoints
▸ getValues(): number[]
Always return a reference to sorted array of values. Don't change this array.
number[]
an array of the values
DiscreteGradientColorProvider.getValues
▸ hasEventListener(type, callback?): boolean
Check if a list of event listeners for this type contains this listener
| Name | Type | Description |
|---|---|---|
type | string | type of event or property |
Optional callback | Function | to be called, if null, check if any callback is registered |
boolean
DiscreteGradientColorProvider.hasEventListener
▸ hasNamedColor(colorName): boolean
Check if specified named color exists
| Name | Type | Description |
|---|---|---|
colorName | string | color name |
boolean
true if color exists
DiscreteGradientColorProvider.hasNamedColor
▸ invalidate(): LogColorProvider
Invalidate Default ColorProvider and notify visuals for update
DiscreteGradientColorProvider.invalidate
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
DiscreteGradientColorProvider.isDisposed
▸ isNotificationEnabled(): boolean
Return state of notification
boolean
current notification state
DiscreteGradientColorProvider.isNotificationEnabled
▸ isReversed(): boolean
return true if the min / max is reversed
boolean
DiscreteGradientColorProvider.isReversed
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
DiscreteGradientColorProvider.isSilent
▸ logToVal(t): number
convert logarithmic t to value v
| Name | Type | Description |
|---|---|---|
t | number | logarithmic value |
number
▸ notify<E>(type, source, args?): LogColorProvider
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | ColorProvider | of the event |
Optional args | EventMap[E] | arguments of the event |
this
DiscreteGradientColorProvider.notify
▸ off<E>(type?, callback?): LogColorProvider
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
Optional type | E | type of the event |
Optional callback | (eventType: E, sender: LogColorProvider, args: EventMap[E]) => void | function to be called |
this
DiscreteGradientColorProvider.off
▸ on<E>(type, callback): LogColorProvider
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.
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: LogColorProvider, args: EventMap[E]) => void | to be called |
this
DiscreteGradientColorProvider.on
▸ removeColor(value): LogColorProvider
Remove color from the collection
| Name | Type | Description |
|---|---|---|
value | number | value to remove color |
this
DiscreteGradientColorProvider.removeColor
▸ reverse(): LogColorProvider
reverse the axis
DiscreteGradientColorProvider.reverse
▸ scaleTo(start, end, logValue?): LogColorProvider
set the min/max of the color provider, interpolating all values on the way.
| Name | Type | Description |
|---|---|---|
start | number | Start value to use |
end | number | End value to use |
Optional logValue | boolean | apply scale for logarithm of values |
this
DiscreteGradientColorProvider.scaleTo
▸ setColorNumber(colorNumber): LogColorProvider
Sets how many colors can be provided
| Name | Type | Description |
|---|---|---|
colorNumber | number | number of colors that can be provided |
this
DiscreteGradientColorProvider.setColorNumber
▸ setColors(values, colors): LogColorProvider
Replace all colors in the collection by this set
| Name | Type | Description |
|---|---|---|
values | number[] | new values |
colors | (string | RgbaColor)[] | new colors |
this
DiscreteGradientColorProvider.setColors
▸ setDisplayStyle(style): LogColorProvider
Method used to set graphical representation of LogColorProvider in a fillStyle
| Name | Type | Description |
|---|---|---|
style | DisplayStyle | display style |
this
▸ setNamedColor(colorName, colorValue): LogColorProvider
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');| Name | Type | Description |
|---|---|---|
colorName | string | color name |
colorValue | string | NamedColorValue | color or title/value settings object |
this
DiscreteGradientColorProvider.setNamedColor
▸ setNotification(enable, force?): LogColorProvider
Enable / disable notification
| Name | Type | Description |
|---|---|---|
enable | boolean | enable or disable notifications |
Optional force | boolean | true if parent should be invalidated immediately |
this
DiscreteGradientColorProvider.setNotification
▸ setProperties(properties?): LogColorProvider
set Properties of the object
| Name | Type | Description |
|---|---|---|
Optional properties | Options | properties |
this
DiscreteGradientColorProvider.setProperties
▸ setScale(scale, min?, max?, logValue?): LogColorProvider
Replace all colors in the collection by this scale
| Name | Type | Description |
|---|---|---|
scale | string | { logValue?: boolean ; max: number ; min: number ; values: number[] } | Scale to Use |
Optional min | number | Minimum to Use |
Optional max | number | Maximum to Use |
Optional logValue | boolean | apply scale for logarithm of values |
this
DiscreteGradientColorProvider.setScale
▸ setSilent(bool): LogColorProvider
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
DiscreteGradientColorProvider.setSilent
▸ valToLog(v): number
convert value v to logarithmic t
| Name | Type | Description |
|---|---|---|
v | number | value |
number
▸ Static fromObject(object): LogColorProvider
Create or get LogColorProvider from an object
| Name | Type | Description |
|---|---|---|
object | any | object to create from |
provider
DiscreteGradientColorProvider.fromObject
▸ Static getClassName(): string
string
DiscreteGradientColorProvider.getClassName
▸ Static getColorProviderType(objectType?): ClassType<any>
Return ColorProvider constructor from the object class name or type.
Deprecated
since 4.1 Use ColorProvider implementation directly
| Name | Type | Description |
|---|---|---|
Optional objectType | string | ColorProvider class name |
ClassType<any>
ColorProvider constructor