API / geotoolkit / data / DiscreteDataMap / DiscreteDataMap
data.DiscreteDataMap.DiscreteDataMap
Defines log discrete value map. It maps value ranges or value codes to corresponding values based on continues or discrete type of the map.
| Name | Type |
|---|---|
T | any |
↳
DiscreteDataMap
Constructors
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
type | MapType | Data type to specify usage codes or ranges |
Constructors
• new DiscreteDataMap<T>(options?)
| Name | Type |
|---|---|
T | any |
| Name | Type |
|---|---|
Optional options | Options<T> |
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getCodes(): number[]
Returns array of ranges
number[]
codes array of codes
▸ getMapType(): MapType
Returns data map type
map type
▸ getProperties(): OptionsOut<T>
Gets all the properties pertaining to this object
OptionsOut<T>
▸ getRanges(): number[][]
Returns array of ranges
number[][]
ranges array of ranges
▸ getValueAt(value): T
Return mapped object for specified value
| Name | Type | Description |
|---|---|---|
value | number | value index |
T
corresponding value
▸ getValues(): T[]
Returns array of values
T[]
values list of values
▸ 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
EventDispatcher.hasEventListener
▸ isDisposed(): boolean
Returns whether this object has been disposed
boolean
▸ isSilent(): boolean
Return true if the event dispatcher doesn't notify any events
boolean
▸ notify(type, source, args?): DiscreteDataMap<T>
Notify listeners
| Name | Type | Description |
|---|---|---|
type | string | event types |
source | any | of the event |
Optional args | any | arguments of the event |
this
▸ off(type?, callback?): DiscreteDataMap<T>
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 | Description |
|---|---|---|
Optional type | string | type of the event |
Optional callback | EventListener | function to be called |
this
▸ off<E>(type, callback): DiscreteDataMap<T>
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DiscreteDataMap<T>, args: EventMap[E]) => void |
▸ on(type, callback, options?): DiscreteDataMap<T>
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 | Description |
|---|---|---|
type | string | type of event or property |
callback | EventListener | to be called |
Optional options | Options | options of subscription |
this
▸ on<E>(type, callback, options?): DiscreteDataMap<T>
| Name | Type |
|---|---|
E | extends string |
| Name | Type |
|---|---|
type | E |
callback | (eventType: E, sender: DiscreteDataMap<T>, args: EventMap[E]) => void |
Optional options | Options |
▸ setCodes(codes): DiscreteDataMap<T>
Sets array of codes
| Name | Type | Description |
|---|---|---|
codes | number[] | array of codes |
this
▸ setMapType(mapType): DiscreteDataMap<T>
Sets data map type
| Name | Type | Description |
|---|---|---|
mapType | MapType | map type |
this
▸ setProperties(properties?): DiscreteDataMap<T>
Sets all the properties pertaining to this object
| Name | Type | Description |
|---|---|---|
Optional properties | Options<T> | An object containing the properties to set |
this
▸ setRanges(ranges): DiscreteDataMap<T>
Sets array of ranges
| Name | Type | Description |
|---|---|---|
ranges | number[][] | array of ranges |
this
▸ setSilent(bool): DiscreteDataMap<T>
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ setValues(values): DiscreteDataMap<T>
Sets array of values
| Name | Type | Description |
|---|---|---|
values | T[] | list of values |
this
▸ Static getClassName(): string
string