API / geotoolkit / axis / AxisDimension / AxisDimension
axis.AxisDimension.AxisDimension
Define axis model dimension.
↳
AxisDimension
Constructors
Methods
Constructors
• new AxisDimension(options?)
| Name | Type |
|---|---|
Optional options | Options |
EventDispatcher.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getMax(): number
Return maximum value
number
▸ getMin(): number
Return minimum value
number
▸ getNeatLimits(): boolean
Returns true if neat limits is enabled.
boolean
▸ getOptions(): Required<Options>
Return options
Required<Options>
The options
▸ getOrientation(): Orientation
Gets axis orientation
▸ getOrigin(): number
Return origin value
number
▸ 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<E>(type, source, args?): AxisDimension
Notify listeners
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | event types |
source | AxisDimension | of the event |
Optional args | EventMap[E] | arguments of the event |
this
▸ off<E>(type?, callback?): AxisDimension
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: AxisDimension, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): AxisDimension
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: AxisDimension, args: EventMap[E]) => void | to be called |
this
▸ setNeatLimits(enable): AxisDimension
Enable / disable neat limits
| Name | Type | Description |
|---|---|---|
enable | boolean | enable or disable neat limits |
this
▸ setOptions(options?): AxisDimension
Sets options
| Name | Type | Description |
|---|---|---|
Optional options | Options | The options |
this
▸ setOrientation(orientation): AxisDimension
Sets axis orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | axis orientation |
this
▸ setSilent(bool): AxisDimension
Set silent mode
| Name | Type | Description |
|---|---|---|
bool | boolean | flag to enable silent mode |
this
▸ updateLimits(min, max, options?): void
Update limits
| Name | Type | Description |
|---|---|---|
min | number | minimum value |
max | number | maximum value |
Optional options | Transformation | Limits | from model range to device or addition properties |
void
▸ Static getClassName(): string
string