Class: SecondaryTickGenerator

• new SecondaryTickGenerator(options?)

NumericTickGenerator.constructor

• new SecondaryTickGenerator(options, secondaryValues, majorStep, minorStep)

NumericTickGenerator.constructor

▸ clone(): SecondaryTickGenerator

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

SecondaryTickGenerator

clone

NumericTickGenerator.clone

▸ connectStyle(style, type, callback): SecondaryTickGenerator

Connects style.

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

SecondaryTickGenerator

NumericTickGenerator.connectStyle

▸ Protected copyConstructor(src, deepCopy?): SecondaryTickGenerator

Copy constructor

SecondaryTickGenerator

this

NumericTickGenerator.copyConstructor

▸ disconnectStyle(style, type, callback): SecondaryTickGenerator

Disconnect style

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

SecondaryTickGenerator

NumericTickGenerator.disconnectStyle

▸ dispose(): void

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

void

NumericTickGenerator.dispose

▸ execute(delegate): SecondaryTickGenerator

Executes delegate and returns the result

SecondaryTickGenerator

NumericTickGenerator.execute

▸ execute<T>(delegate): T

T

NumericTickGenerator.execute

▸ formatLabel(parent, orient, tickInfo, tickIndex, labelPos): string

Formats label text positioned at "labelPos" in primary model space. IMPORTANT: Textual content of the label is formatted out of its position in secondary space.

string

label text

NumericTickGenerator.formatLabel

▸ Protected formatLabelInternal(tickType, modelValue): string

Format label

string

NumericTickGenerator.formatLabelInternal

▸ getAdjustLabelAnchor(grade): boolean

Gets adjust label anchor flag for specified label grade

boolean

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

NumericTickGenerator.getAdjustLabelAnchor

▸ getBoundingBox(tickInfo, orient, labelPos, labelText?): Rect

Returns bounding box of label

Rect

bbox bounding box

NumericTickGenerator.getBoundingBox

▸ getClassName(): string

string

NumericTickGenerator.getClassName

▸ getFormatLabelHandler(): LabelFormatHandler

Returns label format handler

LabelFormatHandler

NumericTickGenerator.getFormatLabelHandler

▸ getGrades(): string[]

Returns supported tick grades: ["major", "minor", "majorreversed" and "minorreversed"]

string[]

supported tick grades: ["major", "minor", "majorreversed" and "minorreversed"]

NumericTickGenerator.getGrades

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

invalidate Method

AttributeCallback<EventDispatcher>

method to invalidate this object

NumericTickGenerator.getInvalidateMethod

▸ getLabelAnchorType(grade, transformation?): AnchorType

Gets label anchor type

AnchorType

NumericTickGenerator.getLabelAnchorType

▸ getLabelFormat(tickGrade): Format

Returns label format

Format

label format

NumericTickGenerator.getLabelFormat

▸ getLabelRotationAngle(tickGrade): number

Returns label rotation angle

number

label rotation angle

NumericTickGenerator.getLabelRotationAngle

▸ getLabelStyle(tickGrade): TextStyle

Returns label style

TextStyle

label style

NumericTickGenerator.getLabelStyle

▸ getLabelValueTransformer(): ValueTransformer | (modelValue: number) => number

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

ValueTransformer | (modelValue: number) => number

transformer label value transformer

NumericTickGenerator.getLabelValueTransformer

▸ getLabelsDecimation(): boolean

Gets labels decimation state

boolean

labelsDecimation labels decimation state

▸ getLocale(): string | Locale

Return the current locale

string | Locale

NumericTickGenerator.getLocale

▸ getMapping(): Mapping

Gets primary-to-secondary values mapping.

Mapping

▸ getMaxLabelHandler(): MaxLabelEventHandler

Gets handler to return max label position

MaxLabelEventHandler

handler is called to specify max label

NumericTickGenerator.getMaxLabelHandler

▸ getMaxLabelMetrics(parent, orientation, tickInfo, fromValue, toValue): Dimension

Returns maximum label metrics. For internal use only

Dimension

NumericTickGenerator.getMaxLabelMetrics

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

Returns max labels for each type of grades

{ type: string ; value: number }[]

array of {'type':tickGrade, 'value':maxValue}

NumericTickGenerator.getMaxLabels

▸ getNeatLimits(min, max, options): Limits

Return nice limits, default implementation is for linear model space

Limits

NumericTickGenerator.getNeatLimits

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

An object containing the properties to set

NumericTickGenerator.getProperties

▸ getTag(): any

Returns tag

any

the tag

NumericTickGenerator.getTag

▸ getTickSize(tickGrade): number

Gets tick size (length)

number

tickSize tick size

NumericTickGenerator.getTickSize

▸ getTickStep(tickGrade): number

Gets tick step (in secondary space)

number

tick step

▸ getTickStyle(tickGrade): LineStyle

Returns tick style

LineStyle

line style

NumericTickGenerator.getTickStyle

▸ getVisibleLabelGrades(supported): string[]

Return an array of the visible label grades

string[]

the visible grades

NumericTickGenerator.getVisibleLabelGrades

▸ getVisibleTickGrades(supported): string[]

Returns an array of the visible tick grades

string[]

the visible grades

NumericTickGenerator.getVisibleTickGrades

▸ hasEventListener(type, callback?): boolean

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

boolean

NumericTickGenerator.hasEventListener

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

NumericTickGenerator.isDisposed

▸ isSilent(): boolean

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

boolean

NumericTickGenerator.isSilent

▸ isValid(parent, orient, tickInfo): boolean

Verify tick generator parameters to have better label distribution

boolean

true if no label intersection

NumericTickGenerator.isValid

▸ isVisibleLabelGrade(tickGrade): boolean

Returns visibility of label for a specific tick grade

boolean

true if label is visible

NumericTickGenerator.isVisibleLabelGrade

▸ isVisibleTickGrade(tickGrade): boolean

Returns visibility of tick for a specific tick grade

boolean

true if the tick is visible

NumericTickGenerator.isVisibleTickGrade

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

Generates information about next label

number

the model position of the label

NumericTickGenerator.nextLabel

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

Generates information about next tick

number

the model position of the tick

NumericTickGenerator.nextTick

▸ notify<E>(type, source, args?): SecondaryTickGenerator

Notify listeners

SecondaryTickGenerator

this

NumericTickGenerator.notify

▸ off<E>(type?, callback?): SecondaryTickGenerator

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.

SecondaryTickGenerator

this

NumericTickGenerator.off

▸ on<E>(type, callback): SecondaryTickGenerator

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.

SecondaryTickGenerator

this

NumericTickGenerator.on

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

Resets tick generator

string[]

a supported tick grade list

NumericTickGenerator.reset

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

Resets tick generator asynchronously

void

NumericTickGenerator.resetAsync

▸ resetLabels(parent, orient, tickInfo): number

Resets labels. This method is called to start iterating through labels.

number

labels count for the current tick type

NumericTickGenerator.resetLabels

▸ resetMaxLabels(): SecondaryTickGenerator

Reset max label info

SecondaryTickGenerator

this

NumericTickGenerator.resetMaxLabels

▸ resetTicks(parent, orient, tickInfo): number

Resets ticks. This method is called to start iteration by ticks. The implementation also sets appropriate LineStyle on the ticks as well as their tick size.

number

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

NumericTickGenerator.resetTicks

▸ setAdjustLabelAnchor(grade, flag): SecondaryTickGenerator

Sets adjust label anchor flag for specified label grade

SecondaryTickGenerator

this

NumericTickGenerator.setAdjustLabelAnchor

▸ setFormatLabelHandler(handler): SecondaryTickGenerator

Sets label format handler

SecondaryTickGenerator

this

NumericTickGenerator.setFormatLabelHandler

▸ setLabelAnchorType(grade, anchorType): SecondaryTickGenerator

Sets label anchor type

SecondaryTickGenerator

this

NumericTickGenerator.setLabelAnchorType

▸ setLabelFormat(tickGrade, format): SecondaryTickGenerator

Sets label format

Throws

Error if labelformat is not supported

Example

// to set the precision of the tickGenerator labels use the following
import {NumberFormat} from '@int/geotoolkit/util/NumberFormat';
...
axis.getTickGenerator().setLabelFormat('major', new NumberFormat({'maximumfractiondigits':2}));

SecondaryTickGenerator

this

NumericTickGenerator.setLabelFormat

▸ setLabelRotationAngle(tickGrade, angle): SecondaryTickGenerator

Sets label rotation angle

Example

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

SecondaryTickGenerator

this

NumericTickGenerator.setLabelRotationAngle

▸ setLabelStyle(tickGrade, labelStyle?, merge?): SecondaryTickGenerator

Sets label style

SecondaryTickGenerator

this

NumericTickGenerator.setLabelStyle

▸ setLabelValueTransformer(transformer): SecondaryTickGenerator

Sets label value transformer (optional)

SecondaryTickGenerator

this

NumericTickGenerator.setLabelValueTransformer

▸ setLabelsDecimation(labelsDecimation): SecondaryTickGenerator

Sets labels decimation state

SecondaryTickGenerator

this

▸ setLocale(locale): SecondaryTickGenerator

Sets locale

SecondaryTickGenerator

this

NumericTickGenerator.setLocale

▸ setMapping(primaryValues, secondaryValues): SecondaryTickGenerator

Gets primary-to-secondary values mapping.

SecondaryTickGenerator

this

▸ setMaxLabelHandler(handler): SecondaryTickGenerator

Sets handler to return max label values

Example

// Return text
tickGenerator.setMaxLabelHandler((axis, tickInfo, orient, fromValue, toValue, array) => {
return [{'type': 'major', 'value': 'Buffalo Gap'}];
});

Example

// Return number
tickGenerator.setMaxLabelHandler((axis, tickInfo, orient, fromValue, toValue, array) => {
return [{'type': 'major', 'value': 1000}];
});

SecondaryTickGenerator

this

NumericTickGenerator.setMaxLabelHandler

▸ setProperties(properties?): SecondaryTickGenerator

Sets all the properties pertaining to this object

SecondaryTickGenerator

NumericTickGenerator.setProperties

▸ setSilent(bool): SecondaryTickGenerator

Set silent mode

SecondaryTickGenerator

this

NumericTickGenerator.setSilent

▸ setTag(tag): SecondaryTickGenerator

Sets tag

SecondaryTickGenerator

this

NumericTickGenerator.setTag

▸ setTickOptions(properties?, tickGrade?): SecondaryTickGenerator

Sets all the properties pertaining to this tick

SecondaryTickGenerator

this

NumericTickGenerator.setTickOptions

▸ setTickSize(tickGrade, tickSize): SecondaryTickGenerator

Sets tick size (length)

SecondaryTickGenerator

this

NumericTickGenerator.setTickSize

▸ setTickStep(tickGrade, tickStep): SecondaryTickGenerator

Sets tick step (in secondary space)

SecondaryTickGenerator

this

▸ setTickStyle(tickGrade, lineStyle?, merge?): SecondaryTickGenerator

Sets tick style

SecondaryTickGenerator

this

NumericTickGenerator.setTickStyle

▸ setVisibleLabelGrade(tickGrade, visible): SecondaryTickGenerator

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

SecondaryTickGenerator

this

NumericTickGenerator.setVisibleLabelGrade

▸ setVisibleTickGrade(tickGrade, visible): SecondaryTickGenerator

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

SecondaryTickGenerator

this

NumericTickGenerator.setVisibleTickGrade

▸ Static getClassName(): string

string

NumericTickGenerator.getClassName