Last updated

API / geotoolkit / axis / TickGenerator / TickGenerator

Namespace: TickGenerator

axis.TickGenerator.TickGenerator

Table of contents

Type Aliases

Contents

Type Aliases

AnchorStyleHandler

Ƭ AnchorStyleHandler: (grade: string, transformation: Transformation) => AnchorType

Type declaration

▸ (grade, transformation): AnchorType

Callback for TickGenerator to get label anchor type

Parameters
Name Type
gradestring
transformationTransformation
Returns

AnchorType


EventMap

Ƭ EventMap: EventMap & { Invalidate: void }


Grades

Ƭ Grades: typeof GRADES[number]


LabelFormatHandler

Ƭ LabelFormatHandler: (tickGenerator: TickGenerator, parent: IModel, orientation: Orientation, tickInfo: TickInfo, tickIndex: number, value: number) => string

Type declaration

▸ (tickGenerator, parent, orientation, tickInfo, tickIndex, value): string

Callback for TickGenerator to build a label for a given model value

Parameters
Name Type
tickGeneratorTickGenerator
parentIModel
orientationOrientation
tickInfoTickInfo
tickIndexnumber
valuenumber
Returns

string


Options

Ƭ Options: Partial<Record<Grades, TickOptions>> & { formatlabelhandler?: LabelFormatHandler ; labelanchortypes?: Record<string, AnchorType | AnchorStyleHandler> ; labelangles?: Record<string, number> ; labelstyles?: TextStyle | Record<string, Type> ; tag?: any ; ticksizes?: Record<string, number> ; tickstyles?: LineStyle | Record<string, Type> ; transformer?: ValueTransformer | (modelValue: number) => number | null ; visiblelabels?: Record<string, boolean> ; visibleticks?: Record<string, boolean> }

An object containing the properties to set


OptionsOut

Ƭ OptionsOut: Record<Grades, TickOptions> & { formatlabelhandler: LabelFormatHandler ; labelanchortypes: Record<string, AnchorType | AnchorStyleHandler> ; labelangles: Record<string, number> ; labelstyles: Record<string, TextStyle> ; tag: any ; ticksizes: Record<string, number> ; tickstyles: Record<string, LineStyle | Options> ; transformer: ValueTransformer | (modelValue: number) => number | null ; visiblelabels: Record<string, boolean> ; visibleticks: Record<string, boolean> }

properties


TickOptions

Ƭ TickOptions: Object

An object containing the properties to set

Type declaration

NameTypeDescription
adjustlabelanchor?booleanadjust position of the label anchor
labelanchor?AnchorType | AnchorStyleHandleroptional label anchor
labelangle?numberangle label rotation angle, in radians
labelstyle?Typeobject containing the properties to set TextStyle of label. See TextStyle.setProperties for details
labelvisible?booleanlabel visibility
ticksize?numbertick size
tickstyle?LineStyle | Optionsobject containing the properties to set LineStyle of tick. See LineStyle.setProperties for details
tickvisible?booleantick visibility