[API](/solutions/geotoolkit/geotoolkit_js/apis/readme) / [geotoolkit](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit) / [axis](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis) / [TickGenerator](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator) / TickGenerator

# Class: TickGenerator

[axis](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis).[TickGenerator](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator).TickGenerator

Define a base class for tick generators. Toolkit provides several tick generators to help generate numeric labels.<br>
It generates ticks and labels based on the tick info and tickgrades. [Axis](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.axis.axis) uses the TickGenerator while creating the axis.
Please refer to Axes and Grids Tutorial in CarnacJS for examples of the different tick generators supported.<br>
A tick generator mainly provides the positions of sequential ticks as well as the informational data associated with tick positions.

## Hierarchy

- [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)
↳ **`TickGenerator`**
↳↳ [`AdaptiveDateTimeTickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.adaptivedatetimetickgenerator.adaptivedatetimetickgenerator)
↳↳ [`DateTimeTickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.datetimetickgenerator.datetimetickgenerator)
↳↳ [`NumericTickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.numerictickgenerator.numerictickgenerator)
↳↳ [`HistogramTickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.controls.axis-1.histogramtickgenerator.histogramtickgenerator)
↳↳ [`IndexTickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.seismic.axis-3.indextickgenerator.indextickgenerator)
↳↳ [`DateTimeTickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.welllog.axis-4.datetimetickgenerator.datetimetickgenerator)


## Implements

- [`IStyleListener`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.iattributenode.istylelistener)
- [`INeatLimitsProvider`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.ineatlimitsprovider.ineatlimitsprovider)


## Table of contents

Constructors
- [new TickGenerator(options)](/solutions/geotoolkit/GeoToolkit_JS/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator.md#new tickgenerator(options))


Methods
| [clone](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#clone) | [connectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#connectstyle) | [copyConstructor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#copyconstructor) |
|  --- | --- | --- |
| [disconnectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#disconnectstyle) | [dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#dispose) | [execute](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#execute) |
| [formatLabel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#formatlabel) | [getAdjustLabelAnchor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getadjustlabelanchor) | [getBoundingBox](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getboundingbox) |
| [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getclassname) | [getFormatLabelHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getformatlabelhandler) | [getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) |
| [getInvalidateMethod](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getinvalidatemethod) | [getLabelAnchorType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getlabelanchortype) | [getLabelRotationAngle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getlabelrotationangle) |
| [getLabelStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getlabelstyle) | [getLabelValueTransformer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getlabelvaluetransformer) | [getMaxLabelMetrics](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getmaxlabelmetrics) |
| [getMaxLabels](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getmaxlabels) | [getNeatLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getneatlimits) | [getProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getproperties) |
| [getTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#gettag) | [getTickSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getticksize) | [getTickStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#gettickstyle) |
| [getVisibleLabelGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getvisiblelabelgrades) | [getVisibleTickGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getvisibletickgrades) | [hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#haseventlistener) |
| [isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#isdisposed) | [isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#issilent) | [isValid](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#isvalid) |
| [isVisibleLabelGrade](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#isvisiblelabelgrade) | [isVisibleTickGrade](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#isvisibletickgrade) | [nextLabel](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#nextlabel) |
| [nextTick](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#nexttick) | [notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#notify) | [off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#off) |
| [on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#on) | [reset](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#reset) | [resetAsync](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#resetasync) |
| [resetLabels](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#resetlabels) | [resetMaxLabels](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#resetmaxlabels) | [resetTicks](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#resetticks) |
| [setAdjustLabelAnchor](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setadjustlabelanchor) | [setFormatLabelHandler](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setformatlabelhandler) | [setLabelAnchorType](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setlabelanchortype) |
| [setLabelRotationAngle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setlabelrotationangle) | [setLabelStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setlabelstyle) | [setLabelValueTransformer](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setlabelvaluetransformer) |
| [setProperties](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setproperties) | [setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setsilent) | [setTag](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#settag) |
| [setTickOptions](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#settickoptions) | [setTickSize](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setticksize) | [setTickStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#settickstyle) |
| [setVisibleLabelGrade](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setvisiblelabelgrade) | [setVisibleTickGrade](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#setvisibletickgrade) | [getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getclassname-1) |


Css Properties
| Name  | Type  | Description |
|  --- | --- | --- |
| `labelstyles` | [`TextStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle#css-props) | An object containing label style for specified grades |
| `labelstyles-alignment` | [`AlignmentStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#alignmentstyle) | Alignment |
| `labelstyles-autosize` | `boolean` | Auto font size on high definition display |
| `labelstyles-background` | `string` | Background style |
| `labelstyles-background` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Background style |
| `labelstyles-background-color` | `string` | Color in CSS form |
| `labelstyles-background-evenoddmode` | `boolean` | Even-odd fill mode |
| `labelstyles-background-fillpattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `labelstyles-background-fillpattern-containername` | `string` | An optional container name, which creates an image pattern. This
parameter is used for serialization if you want to save are reference to pattern instead of the pattern itself |
| `labelstyles-background-fillpattern-patternname` | `string` | Name of this pattern for indexing |
| `labelstyles-background-fillpattern-scalable` | `boolean` | Flag that sets scalability of the pattern
coordinates, or relative to the shape it is filling (It is not supported) |
| `labelstyles-background-foreground` | `string` | Foreground color |
| `labelstyles-background-pattern` | [`Pattern`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.pattern.pattern#css-props) | Pattern |
| `labelstyles-baseline` | [`BaseLineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#baselinestyle) | Base line |
| `labelstyles-color` | `string` | Color in CSS form |
| `labelstyles-fill` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Text fill style |
| `labelstyles-font` | `string` | Font see |
| `labelstyles-fonturl` | `string` | The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword |
| `labelstyles-lineheight` | `string | number` | Line height |
| `labelstyles-multiline` | `boolean` | Allow multi-line text |
| `labelstyles-outline` | `string` | Outline style |
| `labelstyles-outline` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Outline style |
| `labelstyles-outline-color` | `string` | Color in CSS form |
| `labelstyles-outline-fill` | `string` | Optional fill style to be used to fill lines generated with this style |
| `labelstyles-outline-fill` | [`FillStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.fillstyle.fillstyle#css-props) | Optional fill style to be used to fill lines generated with this style |
| `labelstyles-outline-linecap` | [`CapStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#capstyle) | The line cap style |
| `labelstyles-outline-linedashoffset` | `number` | Line dash offset of dashed line |
| `labelstyles-outline-linejoin` | [`JoinStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#joinstyle) | The line join style |
| `labelstyles-outline-pixelsnapmode` | `boolean` | Pixel Snap Mode, default( |
| `labelstyles-outline-scalable` | `boolean` | True if width should depend on transformation |
| `labelstyles-outline-unit` | `string` | Optional unit for the width |
| `labelstyles-outline-width` | `number | string` | The line thickness |
| `labelstyles-overflowwrap` | [`OverflowWrapStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#overflowwrapstyle) | Overflow wrap |
| `labelstyles-strikethrough` | `string` | Strikethrough style |
| `labelstyles-strikethrough` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Strikethrough style |
| `labelstyles-textoverflow` | [`TextOverflowStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#textoverflowstyle) | Text overflow |
| `labelstyles-underline` | `string` | Underline style |
| `labelstyles-underline` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | Underline style |
| `labelstyles-underlineoffset` | `string | number` | Underline offset distance |
| `labelstyles-whitespace` | [`WhiteSpaceStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#whitespacestyle) | White space |
| `labelstyles-wordbreak` | [`WordBreakStyle`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#wordbreakstyle) | Word break |
| `tag` | `any` | Tag user can specify info associated with current object |
| `tickstyles` | [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle#css-props) | An object containing tick styles for specified grades |


## Contents

Constructors
#### new TickGenerator(options)

• **new TickGenerator**(`options?`)

#### Parameters

| Name  | Type  |
|  --- | --- |
| `Optional` `options` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#options) |


#### Overrides

EventDispatcher.constructor

Methods
#### clone

▸ **clone**(): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

All subclasses should override copyConstructor or provide custom implementation for this method

#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

clone

#### connectStyle

▸ **connectStyle**(`style`, `type`, `callback`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Connects style.<br>
<br>
This convenience method subscribes a listener to given style for the specified type.<br>
And automatically un-subscribes listener if node is disposed to prevent memory leaks

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `style` | [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher) | connect style |
| `type` | `string` | type of event or property |
| `callback` | [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt; | function to be called |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

#### Implementation of

[IStyleListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.iattributenode.istylelistener).[connectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.iattributenode.istylelistener#connectstyle)

#### copyConstructor

▸ `Protected` **copyConstructor**(`src`, `deepCopy?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Copy constructor

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `src` | [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator) | Source to copy from |
| `Optional` `deepCopy` | `boolean` | deep copy |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### disconnectStyle

▸ **disconnectStyle**(`style`, `type`, `callback`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Disconnect style<br>
<br>
This convenience method un-subscribes a listener to given style for the specified type.<br>

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `style` | [`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher) | connect style |
| `type` | `string` | type of event or property |
| `callback` | [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt; | function to be called |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

#### Implementation of

[IStyleListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.iattributenode.istylelistener).[disconnectStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.iattributenode.istylelistener#disconnectstyle)

#### dispose

▸ **dispose**(): `void`

Disposes this node, once disposes a node should not be used anymore.<br>
Clear all listeners, and disconnect styles to avoid memory leaks.<br>
Also aggressively 'cleanup' this node by setting some of its members to null.

#### Returns

`void`

#### Overrides

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[dispose](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#dispose)

#### execute

▸ **execute**(`delegate`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Executes delegate and returns the result

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `delegate` | (`this`: [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)) => `void` | execute delegate and return the result |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

▸ **execute**<`T`&gt;(`delegate`): `T`

#### Type parameters

| Name |
|  --- |
| `T` |


#### Parameters

| Name  | Type  |
|  --- | --- |
| `delegate` | (`this`: [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)) => `T` |


#### Returns

`T`

#### formatLabel

▸ **formatLabel**(`parent`, `orient`, `tickInfo`, `tickIndex`, `modelValue`): `string`

Formats label text. This method must be overridden in the base classes and the the base class method must be called first.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | an info about tick |
| `tickIndex` | `number` | tickIndex tick index from 0 to count-1, which resetLabels returns |
| `modelValue` | `number` | model value |


#### Returns

`string`

formatted label text

#### getAdjustLabelAnchor

▸ **getAdjustLabelAnchor**(`grade`): `boolean`

Gets adjust label anchor flag for specified label grade

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `grade` | `string` | label grade |


#### Returns

`boolean`

label anchor flag ("true" by default for any grade)

#### getBoundingBox

▸ **getBoundingBox**(`tickInfo`, `orient`, `labelPos`, `labelText?`): [`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)

Returns bounding box of label

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | info about the tick |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `labelPos` | `number` | label position along index direction |
| `Optional` `labelText` | `string` | label text. If not defined labelPos.toString() is used. |


#### Returns

[`Rect`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.rect.rect)

bbox bounding box

#### getClassName

▸ **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#getclassname)

#### getFormatLabelHandler

▸ **getFormatLabelHandler**(): [`LabelFormatHandler`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#labelformathandler)

Returns label format handler

#### Returns

[`LabelFormatHandler`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#labelformathandler)

#### getGrades

▸ **getGrades**(): `string`[]

Returns valid Tick string : "edge", "major", "intermediate", "minor"

#### Returns

`string`[]

array of known Tick string

#### getInvalidateMethod

▸ `Protected` **getInvalidateMethod**(): [`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt;

invalidate Method

#### Returns

[`AttributeCallback`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#istylelistener#attributecallback)<[`EventDispatcher`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher)&gt;

method to invalidate this object

#### getLabelAnchorType

▸ **getLabelAnchorType**(`grade`, `transformation?`): [`AnchorType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#anchortype)

Gets label anchor type

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `grade` | `string` | tick grade |
| `Optional` `transformation` | [`Transformation`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.transformation.transformation) | optional transformation from model to device. It is used only for custom label anchor handler |


#### Returns

[`AnchorType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#anchortype)

#### getLabelRotationAngle

▸ **getLabelRotationAngle**(`tickGrade`): `number`

Returns label rotation angle

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

`number`

label rotation angle

#### getLabelStyle

▸ **getLabelStyle**(`tickGrade`): [`TextStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle)

Returns label style

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

[`TextStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle)

label style

#### getLabelValueTransformer

▸ **getLabelValueTransformer**(): [`ValueTransformer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.valuetransformer.valuetransformer) | (`modelValue`: `number`) => `number`

Gets label value transformer (by default: 'undefined' - no transformation is applied to a value)

#### Returns

[`ValueTransformer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.valuetransformer.valuetransformer) | (`modelValue`: `number`) => `number`

transformer label value transformer

#### getMaxLabelMetrics

▸ **getMaxLabelMetrics**(`parent`, `orientation`, `tickInfo`, `fromValue`, `toValue`): [`Dimension`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.dimension.dimension)

Returns maximum label metrics. For internal use only

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orientation` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | info about tick position |
| `fromValue` | `number` | generate labels from |
| `toValue` | `number` | generate labels to |


#### Returns

[`Dimension`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.dimension.dimension)

#### getMaxLabels

▸ `Protected` **getMaxLabels**(`tickInfo`, `orient`, `fromValue`, `toValue`): { `type`: `string` ; `value`: `string` | `number`  }[]

Returns max labels for each type of grades

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | info about the tick |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `fromValue` | `number` | generate labels from |
| `toValue` | `number` | generate labels to |


#### Returns

{ `type`: `string` ; `value`: `string` | `number`  }[]

#### getNeatLimits

▸ **getNeatLimits**(`min`, `max`, `options`): [`Limits`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util.mathutil#mathutil#limits)

Return nice limits, default implementation is for linear model space

#### Parameters

| Name  | Type  |
|  --- | --- |
| `min` | `number` |
| `max` | `number` |
| `options` | `Object` |
| `Optional` `options.precise` | `boolean` |
| `options.size` | `number` |
| `options.span` | `number` |


#### Returns

[`Limits`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util.mathutil#mathutil#limits)

#### Implementation of

[INeatLimitsProvider](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.ineatlimitsprovider.ineatlimitsprovider).[getNeatLimits](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.ineatlimitsprovider.ineatlimitsprovider#getneatlimits)

#### getProperties

▸ **getProperties**(): [`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#optionsout)

Gets all the properties pertaining to this object

#### Returns

[`OptionsOut`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#optionsout)

properties

#### getTag

▸ **getTag**(): `any`

Returns tag

#### Returns

`any`

the tag

#### getTickSize

▸ **getTickSize**(`grade`): `number`

Returns the size of specified tick

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `grade` | `string` | Grade of the tick to get the size see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

`number`

#### getTickStyle

▸ **getTickStyle**(`tickGrade`): [`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle)

Returns tick style

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick Grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

[`LineStyle`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle)

line style

#### getVisibleLabelGrades

▸ **getVisibleLabelGrades**(`supported`): `string`[]

Return an array of the visible label grades

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `supported` | `string`[] | supported grades see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

`string`[]

the visible grades

#### getVisibleTickGrades

▸ **getVisibleTickGrades**(`supported`): `string`[]

Returns an array of the visible tick grades

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `supported` | `string`[] | supported grades see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

`string`[]

the visible grades

#### hasEventListener

▸ **hasEventListener**(`type`, `callback?`): `boolean`

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

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `string` | type of event or property |
| `Optional` `callback` | `Function` | to be called, if null, check if any callback is registered |


#### Returns

`boolean`

#### Inherited from

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[hasEventListener](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#haseventlistener)

#### isDisposed

▸ **isDisposed**(): `boolean`

Returns whether this object has been disposed

#### Returns

`boolean`

#### Inherited from

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[isDisposed](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#isdisposed)

#### isSilent

▸ **isSilent**(): `boolean`

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

#### Returns

`boolean`

#### Inherited from

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[isSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#issilent)

#### isValid

▸ **isValid**(`parent`, `orient`, `tickInfo`): `boolean`

Verify tick generator parameters to have better label distribution

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | tick info |


#### Returns

`boolean`

true if no label intersection

#### isVisibleLabelGrade

▸ **isVisibleLabelGrade**(`tickGrade`): `boolean`

Returns visibility of label for a specific tick grade

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

`boolean`

true if label is visible

#### isVisibleTickGrade

▸ **isVisibleTickGrade**(`tickGrade`): `boolean`

Returns visibility of tick for a specific tick grade

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |


#### Returns

`boolean`

true if the tick is visible

#### nextLabel

▸ **nextLabel**(`parent`, `orient`, `tickInfo`, `tickIndex`): `number`

Generates information about next label

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | info about tick |
| `tickIndex` | `number` | tickIndex tick index from 0 to count-1, which resetLabels returns |


#### Returns

`number`

the model position of the label

#### nextTick

▸ **nextTick**(`parent`, `orient`, `tickInfo`, `tickIndex`): `number`

Generates information about next tick

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | info about tick |
| `tickIndex` | `number` | tick index from 0 to count-1, which resetTicks returns |


#### Returns

`number`

the model position of the tick

#### notify

▸ **notify**<`E`&gt;(`type`, `source`, `args?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Notify listeners

#### Type parameters

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `E` | event types |
| `source` | [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator) | of the event |
| `Optional` `args` | [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#eventmap)[`E`] | arguments of the event |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### Overrides

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[notify](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#notify)

#### off

▸ **off**<`E`&gt;(`type?`, `callback?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

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

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `type` | `E` | type of the event |
| `Optional` `callback` | (`eventType`: `E`, `sender`: [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#eventmap)[`E`]) => `void` | function to be called |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### Overrides

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[off](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#off)

#### on

▸ **on**<`E`&gt;(`type`, `callback`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

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

| Name | Type |
|  --- | --- |
| `E` | extends `string` |


#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `type` | `E` | type of event or property |
| `callback` | (`eventType`: `E`, `sender`: [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator), `args`: [`EventMap`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#eventmap)[`E`]) => `void` | to be called |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### Overrides

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[on](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#on)

#### reset

▸ **reset**(`parent`, `orient`, `tickInfo`): `string`[]

Resets tick generator

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | tick info |


#### Returns

`string`[]

a supported tick grade list

#### resetAsync

▸ **resetAsync**(`parent`, `orient`, `tickInfo`, `callback`): `void`

Resets tick generator asynchronously

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | tick info |
| `callback` | (`x`: `string`[]) => `void` | calls when asynchronous reset is done |


#### Returns

`void`

#### resetLabels

▸ **resetLabels**(`parent`, `orient`, `tickInfo`): `number`

Reset labels. This method is called to start iteration by labels.
The implementation also sets appropriate [TextStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.textstyle.textstyle) on labels.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | an info about labels. This information is used to pass and receive information about the current tick or label |


#### Returns

`number`

labels count for the current tick type

#### resetMaxLabels

▸ **resetMaxLabels**(): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Reset max label info

#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### resetTicks

▸ **resetTicks**(`parent`, `orient`, `tickInfo`): `number`

Resets ticks. This method is called to start iteration by ticks.
The implementation also sets appropriate [LineStyle](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.attributes.linestyle.linestyle) on the ticks
as well as their tick size.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `parent` | [`IModel`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.scene.imodel.imodel) | parent axis or grid |
| `orient` | [`Orientation`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#orientation) | orientation |
| `tickInfo` | [`TickInfo`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickinfo.tickinfo) | an info about labels. This information is used to pass and receive information about the current tick or label |


#### Returns

`number`

ticks count for the current tick type. The implementation returns 0 if the ticks can not be drawn; a positive number otherwise.

#### setAdjustLabelAnchor

▸ **setAdjustLabelAnchor**(`grade`, `flag`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets adjust label anchor flag for specified label grade

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `grade` | `string` | label grade |
| `flag` | `boolean` | adjust label anchor flag |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setFormatLabelHandler

▸ **setFormatLabelHandler**(`handler`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets label format handler

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `handler` | [`LabelFormatHandler`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#labelformathandler) | handler |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setLabelAnchorType

▸ **setLabelAnchorType**(`grade`, `anchorType`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets label anchor type

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `grade` | `string` | tick grade |
| `anchorType` | [`AnchorType`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.util#anchortype) | [`AnchorStyleHandler`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#anchorstylehandler) | anchorType |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setLabelRotationAngle

▸ **setLabelRotationAngle**(`tickGrade`, `angle`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets label rotation angle

**`Example`**

```ts
// user can customize the label rotation angle based on tick grade.
tickGenerator.setLabelRotationAngle('major', -Math.PI / 2);
```

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |
| `angle` | `number` | label rotation angle, in radians |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setLabelStyle

▸ **setLabelStyle**(`tickGrade`, `labelStyle?`, `merge?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets label style

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |
| `Optional` `labelStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes#textstyle#type) | tick text style |
| `Optional` `merge` | `boolean` | true if you want to merge labelStyle with existing attribute, false by default |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setLabelValueTransformer

▸ **setLabelValueTransformer**(`transformer`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets label value transformer (optional)

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `transformer` | [`ValueTransformer`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.valuetransformer.valuetransformer) | (`modelValue`: `number`) => `number` | label value transformer |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setProperties

▸ **setProperties**(`properties?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets all the properties pertaining to this object

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `properties` | [`Options`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#options) | An object containing the properties to set |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setSilent

▸ **setSilent**(`bool`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Set silent mode

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `bool` | `boolean` | flag to enable silent mode |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### Inherited from

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[setSilent](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#setsilent)

#### setTag

▸ **setTag**(`tag`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets tag

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tag` | `any` | user can specify info associated with current object |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setTickOptions

▸ **setTickOptions**(`properties?`, `tickGrade?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets all the properties pertaining to this tick

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `Optional` `properties` | `Record`<`string`, [`TickOptions`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.axis.tickgenerator#tickgenerator#tickoptions)&gt; | An object containing the properties to set |
| `Optional` `tickGrade` | `string` | Tick grade |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setTickSize

▸ **setTickSize**(`grade`, `size`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Changes the size of specified ticks

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `grade` | `string` | Grade of the tick to set the size see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |
| `size` | `number` | New size |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setTickStyle

▸ **setTickStyle**(`tickGrade`, `lineStyle?`, `merge?`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets tick style

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |
| `Optional` `lineStyle` | [`Type`](/solutions/geotoolkit/geotoolkit_js/apis/modules/geotoolkit.attributes.linestyle#linestyle#type) | line style for the tick |
| `Optional` `merge` | `boolean` | true if you want to merge lineStyle with existing attribute, false by default |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setVisibleLabelGrade

▸ **setVisibleLabelGrade**(`tickGrade`, `visible`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets visibility of label for a specific tick grade
Implementation of the reset should check visibility of the labels.

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |
| `visible` | `boolean` | tick label visibility flag |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### setVisibleTickGrade

▸ **setVisibleTickGrade**(`tickGrade`, `visible`): [`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

Sets visibility of tick for a specific tick grade
Implementation of the reset should check visibility of the ticks

#### Parameters

| Name  | Type  | Description  |
|  --- | --- | --- |
| `tickGrade` | `string` | Tick grade see [TickGenerator.getGrades](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator#getgrades) for valid Tick types |
| `visible` | `boolean` | tick grade visibility flag |


#### Returns

[`TickGenerator`](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.axis.tickgenerator.tickgenerator)

this

#### getClassName

▸ `Static` **getClassName**(): `string`

#### Returns

`string`

#### Inherited from

[EventDispatcher](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher).[getClassName](/solutions/geotoolkit/geotoolkit_js/apis/classes/geotoolkit.util.eventdispatcher.eventdispatcher#getclassname-1)