API / geotoolkit / axis / AxisMappingDimension / AxisMappingDimension
axis.AxisMappingDimension.AxisMappingDimension
Define axis model dimension.
↳
AxisMappingDimension
Constructors
- [new AxisMappingDimension(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.axis.axismappingdimension.axismappingdimension.md#new axismappingdimension(options))
Methods
Css Properties
| Name | Type | Description |
|---|---|---|
desiredmodelstep | number | Desired model step |
logarithmic | boolean | True for logarithmic axis |
max | number | Maximum value |
min | number | Minimum value |
minspan | number | Desired minimum distance between ticks in pixels |
name | string | Name of the dimension |
neatlimits | boolean | Enable or disable neat limits |
orientation | Orientation | Axis orientation |
origin | number | |
preciselimits | boolean | Enable keeping the precise limits and calculate only step |
spacing | number | Desired model spacing |
Constructors
• new AxisMappingDimension(options?)
| Name | Type |
|---|---|
Optional options | Options |
AxisDimension.constructor
Methods
▸ dispose(): void
Dispose.
void
▸ getClassName(): string
string
▸ getLogarithmic(): boolean
Gets logarithmic mode
boolean
true if logarithmic mode enabled
▸ getMax(): number
Return maximum value
number
▸ getMin(): number
Return minimum value
number
▸ getNeatLimits(): boolean
Returns true if neat limits is enabled.
boolean
▸ getNiceLimits(min, max, desiredModelStep): Limits
Get nice limits
| Name | Type | Description |
|---|---|---|
min | number | minimum value |
max | number | maximum value |
desiredModelStep | number | desired model space between ticks |
calculated limits
▸ getNiceLimitsByCount(min, max, maxNumberOfTicks): Limits
Get nice limits by count
| Name | Type | Description |
|---|---|---|
min | number | minimum value |
max | number | maximum value |
maxNumberOfTicks | number | maximum number of ticks |
calculated limits
▸ getOptions(): Required<Options>
Return options
Required<Options>
The options
▸ getOrientation(): Orientation
Gets axis orientation
▸ getOrigin(): number
Return origin value
number
▸ getPreciseLimits(): boolean
Return mode to support precise limits
boolean
▸ getProperties(): Required<Options>
Required<Options>
▸ getSpacing(): number
Return desired model spacing
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
AxisDimension.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?): AxisMappingDimension
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?): AxisMappingDimension
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: AxisMappingDimension, args: EventMap[E]) => void | function to be called |
this
▸ on<E>(type, callback): AxisMappingDimension
Attach listener on event that will be called whenever the specified event is delivered to the target <p> If the callback function is already in the list of event listeners for this target, the function is not added a second time. </p> <p> 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. </p>
| Name | Type |
|---|---|
E | extends string |
| Name | Type | Description |
|---|---|---|
type | E | type of event or property |
callback | (eventType: E, sender: AxisMappingDimension, args: EventMap[E]) => void | to be called |
this
▸ setLogarithmic(enable): AxisMappingDimension
Sets logarithmic mode.
| Name | Type | Description |
|---|---|---|
enable | boolean | enable logarithmic mode |
this
▸ setNeatLimits(enable): AxisMappingDimension
Enable / disable neat limits
| Name | Type | Description |
|---|---|---|
enable | boolean | enable or disable neat limits |
this
▸ setOptions(options?): AxisMappingDimension
Sets options
| Name | Type | Description |
|---|---|---|
Optional options | Options | The options |
this
▸ setOrientation(orientation): AxisMappingDimension
Sets axis orientation
| Name | Type | Description |
|---|---|---|
orientation | Orientation | axis orientation |
this
▸ setPreciseLimits(enable): AxisMappingDimension
Sets mode for precise limits support for neat limits. This mode works only with neat limits mode
| Name | Type | Description |
|---|---|---|
enable | boolean | enable keeping the precise limits and calculate only step |
this
▸ setProperties(options?): AxisMappingDimension
| Name | Type |
|---|---|
Optional options | Options |
▸ setSilent(bool): AxisMappingDimension
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