Skip to content

API / geotoolkit / axis / AxisDimension / AxisDimension

Class: AxisDimension

axis.AxisDimension.AxisDimension

Define axis model dimension.

Hierarchy

Table of contents

Constructors
  • [new AxisDimension(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.axis.axisdimension.axisdimension.md#new axisdimension(options))
Methods

Contents

Constructors

new AxisDimension(options)

• new AxisDimension(options?)

Parameters

Name Type
Optional optionsOptions

Overrides

EventDispatcher.constructor

Methods

dispose

▸ dispose(): void

Dispose.

Returns

void

Inherited from

EventDispatcher.dispose


getClassName

▸ getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName


getMax

▸ getMax(): number

Return maximum value

Returns

number


getMin

▸ getMin(): number

Return minimum value

Returns

number


getNeatLimits

▸ getNeatLimits(): boolean

Returns true if neat limits is enabled.

Returns

boolean


getOptions

▸ getOptions(): Required<Options&gt;

Return options

Returns

Required<Options&gt;

The options


getOrientation

▸ getOrientation(): Orientation

Gets axis orientation

Returns

Orientation


getOrigin

▸ getOrigin(): number

Return origin value

Returns

number


hasEventListener

▸ hasEventListener(type, callback?): boolean

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

Parameters

Name Type Description
typestringtype of event or property
Optional callbackFunctionto be called, if null, check if any callback is registered

Returns

boolean

Inherited from

EventDispatcher.hasEventListener


isDisposed

▸ isDisposed(): boolean

Returns whether this object has been disposed

Returns

boolean

Inherited from

EventDispatcher.isDisposed


isSilent

▸ isSilent(): boolean

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

Returns

boolean

Inherited from

EventDispatcher.isSilent


notify

▸ notify<E&gt;(type, source, args?): AxisDimension

Notify listeners

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEevent types
sourceAxisDimensionof the event
Optional argsEventMap[E]arguments of the event

Returns

AxisDimension

this

Overrides

EventDispatcher.notify


off

▸ off<E&gt;(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.

Type parameters

NameType
Eextends string

Parameters

Name Type Description
Optional typeEtype of the event
Optional callback(eventType: E, sender: AxisDimension, args: EventMap[E]) => voidfunction to be called

Returns

AxisDimension

this

Overrides

EventDispatcher.off


on

▸ on<E&gt;(type, callback): AxisDimension

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>

Type parameters

NameType
Eextends string

Parameters

Name Type Description
typeEtype of event or property
callback(eventType: E, sender: AxisDimension, args: EventMap[E]) => voidto be called

Returns

AxisDimension

this

Overrides

EventDispatcher.on


setNeatLimits

▸ setNeatLimits(enable): AxisDimension

Enable / disable neat limits

Parameters

Name Type Description
enablebooleanenable or disable neat limits

Returns

AxisDimension

this


setOptions

▸ setOptions(options?): AxisDimension

Sets options

Parameters

Name Type Description
Optional optionsOptionsThe options

Returns

AxisDimension

this


setOrientation

▸ setOrientation(orientation): AxisDimension

Sets axis orientation

Parameters

Name Type Description
orientationOrientationaxis orientation

Returns

AxisDimension

this


setSilent

▸ setSilent(bool): AxisDimension

Set silent mode

Parameters

Name Type Description
boolbooleanflag to enable silent mode

Returns

AxisDimension

this

Inherited from

EventDispatcher.setSilent


updateLimits

▸ updateLimits(min, max, options?): void

Update limits

Parameters

Name Type Description
minnumberminimum value
maxnumbermaximum value
Optional optionsTransformation | Limitsfrom model range to device or addition properties

Returns

void


getClassName

▸ Static getClassName(): string

Returns

string

Inherited from

EventDispatcher.getClassName