Class: TickGenerator

• new TickGenerator(options)

• new TickGenerator(options?)

EventDispatcher.constructor

▸ clone(): TickGenerator

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

TickGenerator

clone

▸ connectStyle(style, type, callback): TickGenerator

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

TickGenerator

IStyleListener.connectStyle

▸ Protected copyConstructor(src, deepCopy?): TickGenerator

Copy constructor

TickGenerator

this

▸ disconnectStyle(style, type, callback): TickGenerator

Disconnect style

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

TickGenerator

IStyleListener.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

EventDispatcher.dispose

▸ execute(delegate): TickGenerator

Executes delegate and returns the result

TickGenerator

▸ execute<T>(delegate): T

T

▸ 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.

string

formatted label text

▸ getAdjustLabelAnchor(grade): boolean

Gets adjust label anchor flag for specified label grade

boolean

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

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

Returns bounding box of label

Rect

bbox bounding box

▸ getClassName(): string

string

EventDispatcher.getClassName

▸ getFormatLabelHandler(): LabelFormatHandler

Returns label format handler

LabelFormatHandler

▸ getGrades(): string[]

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

string[]

array of known Tick string

▸ Protected getInvalidateMethod(): AttributeCallback<EventDispatcher>

invalidate Method

AttributeCallback<EventDispatcher>

method to invalidate this object

▸ getLabelAnchorType(grade, transformation?): AnchorType

Gets label anchor type

AnchorType

▸ getLabelRotationAngle(tickGrade): number

Returns label rotation angle

number

label rotation angle

▸ getLabelStyle(tickGrade): TextStyle

Returns label style

TextStyle

label style

▸ 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

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

Returns maximum label metrics. For internal use only

Dimension

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

Returns max labels for each type of grades

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

▸ getNeatLimits(min, max, options): Limits

Return nice limits, default implementation is for linear model space

Limits

INeatLimitsProvider.getNeatLimits

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

OptionsOut

properties

▸ getTag(): any

Returns tag

any

the tag

▸ getTickSize(grade): number

Returns the size of specified tick

number

▸ getTickStyle(tickGrade): LineStyle

Returns tick style

LineStyle

line style

▸ getVisibleLabelGrades(supported): string[]

Return an array of the visible label grades

string[]

the visible grades

▸ getVisibleTickGrades(supported): string[]

Returns an array of the visible tick grades

string[]

the visible grades

▸ hasEventListener(type, callback?): boolean

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

boolean

EventDispatcher.hasEventListener

▸ isDisposed(): boolean

Returns whether this object has been disposed

boolean

EventDispatcher.isDisposed

▸ isSilent(): boolean

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

boolean

EventDispatcher.isSilent

▸ isValid(parent, orient, tickInfo): boolean

Verify tick generator parameters to have better label distribution

boolean

true if no label intersection

▸ isVisibleLabelGrade(tickGrade): boolean

Returns visibility of label for a specific tick grade

boolean

true if label is visible

▸ isVisibleTickGrade(tickGrade): boolean

Returns visibility of tick for a specific tick grade

boolean

true if the tick is visible

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

Generates information about next label

number

the model position of the label

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

Generates information about next tick

number

the model position of the tick

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

Notify listeners

TickGenerator

this

EventDispatcher.notify

▸ off<E>(type?, callback?): 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.

TickGenerator

this

EventDispatcher.off

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

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.

TickGenerator

this

EventDispatcher.on

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

Resets tick generator

string[]

a supported tick grade list

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

Resets tick generator asynchronously

void

▸ resetLabels(parent, orient, tickInfo): number

Reset labels. This method is called to start iteration by labels. The implementation also sets appropriate TextStyle on labels.

number

labels count for the current tick type

▸ resetMaxLabels(): TickGenerator

Reset max label info

TickGenerator

this

▸ 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.

▸ setAdjustLabelAnchor(grade, flag): TickGenerator

Sets adjust label anchor flag for specified label grade

TickGenerator

this

▸ setFormatLabelHandler(handler): TickGenerator

Sets label format handler

TickGenerator

this

▸ setLabelAnchorType(grade, anchorType): TickGenerator

Sets label anchor type

TickGenerator

this

▸ setLabelRotationAngle(tickGrade, angle): TickGenerator

Sets label rotation angle

Example

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

TickGenerator

this

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

Sets label style

TickGenerator

this

▸ setLabelValueTransformer(transformer): TickGenerator

Sets label value transformer (optional)

TickGenerator

this

▸ setProperties(properties?): TickGenerator

Sets all the properties pertaining to this object

TickGenerator

this

▸ setSilent(bool): TickGenerator

Set silent mode

TickGenerator

this

EventDispatcher.setSilent

▸ setTag(tag): TickGenerator

Sets tag

TickGenerator

this

▸ setTickOptions(properties?, tickGrade?): TickGenerator

Sets all the properties pertaining to this tick

TickGenerator

this

▸ setTickSize(grade, size): TickGenerator

Changes the size of specified ticks

TickGenerator

this

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

Sets tick style

TickGenerator

this

▸ setVisibleLabelGrade(tickGrade, visible): TickGenerator

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

TickGenerator

this

▸ setVisibleTickGrade(tickGrade, visible): TickGenerator

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

TickGenerator

this

▸ Static getClassName(): string

string

EventDispatcher.getClassName