API / geotoolkit / axis / TickInfo / TickInfo

Class: TickInfo

axis.TickInfo.TickInfo

Define information about tick, which is used in tick generator

Constructors

[new TickInfo(options)](/solutions/geotoolkit/apis/classes/geotoolkit.axis.tickinfo.tickinfo.md#new tickinfo(options))	[new TickInfo(tickType, tickPosition, tickSize, lineStyle, textStyle)](/solutions/geotoolkit/apis/classes/geotoolkit.axis.tickinfo.tickinfo.md#new tickinfo(ticktype, tickposition, ticksize, linestyle, textstyle))

Methods

cancel	getAnchorType	getAxisDimension
getClassName	getContextTransformation	getDeviceBounds
getGrade	getLineStyle	getModelBounds
getProperties	getRotationAngle	getTextStyle
getTickEnd	getTickOrigin	getTickPosition
getTickSize	getVisibleDeviceBounds	getVisibleModelBounds
isCanceled	repeat	setAnchorType
setAxisDimension	setContextTransformation	setDeviceBounds
setGrade	setLineStyle	setModelBounds
setProperties	setRotationAngle	setTextStyle
setTickEnd	setTickOrigin	setTickPosition
setTickSize	setVisibleDeviceBounds	setVisibleModelBounds
getClassName

Css Properties

Name	Type	Description
`anchortype`	`AnchorType`	Anchor position of the label
`cancel`	`boolean`	Cancel flag
`contexttransformation`	`Transformation`	Transformation from model space to device space
`contexttransformation-dx`	`number`	X axis translation
`contexttransformation-dy`	`number`	Y axis translation
`contexttransformation-xx`	`number`	X scale
`contexttransformation-xy`	`number`	Xy skew
`contexttransformation-yx`	`number`	Yx skew
`contexttransformation-yy`	`number`	Y scale
`devicebounds`	`Rect`	Bounds of the device
`devicebounds-height`	`number`	Height
`devicebounds-readonly`	`boolean`	Readonly
`devicebounds-width`	`number`	Width
`devicebounds-x`	`number`	Left
`devicebounds-y`	`number`	Top
`devicevisiblebounds`	`Rect`	Visible device bounds
`linestyle`	`LineStyle`	Line style
`linestyle-color`	`string`	Color in CSS form
`linestyle-fill`	`string`	Optional fill style to be used to fill lines generated with this style
`linestyle-fill`	`FillStyle`	Optional fill style to be used to fill lines generated with this style
`linestyle-fill-color`	`string`	Color in CSS form
`linestyle-fill-evenoddmode`	`boolean`	Even-odd fill mode
`linestyle-fill-fillpattern`	`Pattern`	Pattern
`linestyle-fill-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
`linestyle-fill-fillpattern-patternname`	`string`	Name of this pattern for indexing
`linestyle-fill-fillpattern-scalable`	`boolean`	Flag that sets scalability of the pattern coordinates, or relative to the shape it is filling (It is not supported)
`linestyle-fill-foreground`	`string`	Foreground color
`linestyle-fill-pattern`	`Pattern`	Pattern
`linestyle-linecap`	`CapStyle`	The line cap style
`linestyle-linedashoffset`	`number`	Line dash offset of dashed line
`linestyle-linejoin`	`JoinStyle`	The line join style
`linestyle-pixelsnapmode`	`boolean`	Pixel Snap Mode, default(
`linestyle-scalable`	`boolean`	True if width should depend on transformation
`linestyle-unit`	`string`	Optional unit for the width
`linestyle-width`	`number \| string`	The line thickness
`modelbounds`	`Rect`	Model bounds
`rotationangle`	`number`	Rotation angle
`textstyle`	`TextStyle`	Text style
`textstyle-alignment`	`AlignmentStyle`	Alignment
`textstyle-autosize`	`boolean`	Auto font size on high definition display
`textstyle-background`	`string`	Background style
`textstyle-background`	`FillStyle`	Background style
`textstyle-baseline`	`BaseLineStyle`	Base line
`textstyle-color`	`string`	Color in CSS form
`textstyle-fill`	`FillStyle`	Text fill style
`textstyle-font`	`string`	Font see
`textstyle-fonturl`	`string`	The place from which the font will be loaded, if null - uses system fonts. It can be base64 with url keyword
`textstyle-lineheight`	`string \| number`	Line height
`textstyle-multiline`	`boolean`	Allow multi-line text
`textstyle-outline`	`string`	Outline style
`textstyle-outline`	`LineStyle`	Outline style
`textstyle-overflowwrap`	`OverflowWrapStyle`	Overflow wrap
`textstyle-strikethrough`	`string`	Strikethrough style
`textstyle-strikethrough`	`LineStyle`	Strikethrough style
`textstyle-textoverflow`	`TextOverflowStyle`	Text overflow
`textstyle-underline`	`string`	Underline style
`textstyle-underline`	`LineStyle`	Underline style
`textstyle-underlineoffset`	`string \| number`	Underline offset distance
`textstyle-whitespace`	`WhiteSpaceStyle`	White space
`textstyle-wordbreak`	`WordBreakStyle`	Word break
`tickend`	`number`	Tick end
`tickorigin`	`number`	Tick origin
`tickposition`	`TickPosition`	Tick position
`ticksize`	`number`	A tick size
`ticktype`	`string`	Tick type like major, minor, edge
`visiblemodelbounds`	`Rect`	Visible model bounds

Constructors

new TickInfo(options)

• new TickInfo(options?)

Parameters

Name	Type	Description
`Optional` `options`	`Options`	options

new TickInfo(tickType, tickPosition, tickSize, lineStyle, textStyle)

• new TickInfo(tickType?, tickPosition?, tickSize?, lineStyle?, textStyle?)

Parameters

Name	Type	Description
`Optional` `tickType`	`string`	tick type like major, minor, edge
`Optional` `tickPosition`	`TickPosition`	Enum of axis tick positions
`Optional` `tickSize`	`number`	size of the tick
`Optional` `lineStyle`	`LineStyle`	line style
`Optional` `textStyle`	`TextStyle`	text style

Methods

cancel

▸ cancel(): void

Cancel

Returns

void

getAnchorType

▸ getAnchorType(): AnchorType

Get anchor type

Returns

AnchorType

getAxisDimension

▸ getAxisDimension(): AxisMappingDimension

Return axis dimension

Returns

AxisMappingDimension

getClassName

▸ getClassName(): string

Returns

string

getContextTransformation

▸ getContextTransformation(): Transformation

Get context transform

Returns

Transformation

getDeviceBounds

▸ getDeviceBounds(): Rect

Get device bounds

Returns

Rect

getGrade

▸ getGrade(): string

Return tick grade as string

Returns

string

type

getLineStyle

▸ getLineStyle(): LineStyle

Return line style

Returns

LineStyle

getModelBounds

▸ getModelBounds(): Rect

Get model bounds

Returns

Rect

getProperties

▸ getProperties(): OptionsOut

Gets all the properties pertaining to this object

Returns

OptionsOut

properties

getRotationAngle

▸ getRotationAngle(): number

Return rotation angle

Returns

number

the angle of rotation

getTextStyle

▸ getTextStyle(): TextStyle

Return text style

Returns

TextStyle

a text style

getTickEnd

▸ getTickEnd(): number

Get tick end

Returns

number

getTickOrigin

▸ getTickOrigin(): number

Get tick origin

Returns

number

getTickPosition

▸ getTickPosition(): TickPosition

Return tick position

Returns

TickPosition

a tick position

getTickSize

▸ getTickSize(): number

Return tick size

Returns

number

a tick size

getVisibleDeviceBounds

▸ getVisibleDeviceBounds(): Rect

Get visible device bounds

Returns

Rect

getVisibleModelBounds

▸ getVisibleModelBounds(): Rect

Get visible model bounds

Returns

Rect

isCanceled

▸ isCanceled(): boolean

Is canceled

Returns

boolean

repeat

▸ repeat(): void

Repeat

Returns

void

setAnchorType

▸ setAnchorType(type): TickInfo

Set anchor type

Parameters

Name	Type	Description
`type`	`AnchorType`	anchor position of the label

Returns

TickInfo

this

setAxisDimension

▸ setAxisDimension(dimension): TickInfo

Sets axis dimension

Parameters

Name	Type	Description
`dimension`	`AxisMappingDimension`	axis dimension

Returns

TickInfo

this

setContextTransformation

▸ setContextTransformation(transformation, nonDeviated?): TickInfo

Set context transform

Parameters

Name	Type	Description
`transformation`	`Transformation`	transformation from model space to device space
`Optional` `nonDeviated`	`boolean`

Returns

TickInfo

this

setDeviceBounds

▸ setDeviceBounds(deviceBounds): TickInfo

Set device bounds

Parameters

Name	Type	Description
`deviceBounds`	`Rect`	bounds of the device

Returns

TickInfo

this

setGrade

▸ setGrade(grade): TickInfo

Sets tick grade

Parameters

Name	Type	Description
`grade`	`string`	a tick type

Returns

TickInfo

this

setLineStyle

▸ setLineStyle(lineStyle): TickInfo

Sets line style

Parameters

Name	Type	Description
`lineStyle`	`LineStyle`	line style

Returns

TickInfo

this

setModelBounds

▸ setModelBounds(modelBounds): TickInfo

Set model bounds

Parameters

Name	Type	Description
`modelBounds`	`Rect`	model bounds

Returns

TickInfo

this

setProperties

▸ setProperties(properties?): TickInfo

Sets all the properties pertaining to this object

Parameters

Name	Type	Description
`Optional` `properties`	`Options`	An object containing the properties to set

Returns

TickInfo

this

setRotationAngle

▸ setRotationAngle(rotationAngle): TickInfo

Sets rotation angle

Parameters

Name	Type	Description
`rotationAngle`	`number`	rotation angle

Returns

TickInfo

this

setTextStyle

▸ setTextStyle(textStyle): TickInfo

Sets text style

Parameters

Name	Type	Description
`textStyle`	`TextStyle`	text style

Returns

TickInfo

this

setTickEnd

▸ setTickEnd(end): TickInfo

Set tick end

Parameters

Name	Type	Description
`end`	`number`	tick end

Returns

TickInfo

this

setTickOrigin

▸ setTickOrigin(origin): TickInfo

Set tick origin

Parameters

Name	Type	Description
`origin`	`number`	tick origin

Returns

TickInfo

this

setTickPosition

▸ setTickPosition(tickPosition): TickInfo

Sets tick position

Parameters

Name	Type	Description
`tickPosition`	`TickPosition`	tick position

Returns

TickInfo

this

setTickSize

▸ setTickSize(tickSize): TickInfo

Set tick size

Parameters

Name	Type	Description
`tickSize`	`number`	a tick size

Returns

TickInfo

this

setVisibleDeviceBounds

▸ setVisibleDeviceBounds(deviceBounds): TickInfo

Set visible device bounds

Parameters

Name	Type	Description
`deviceBounds`	`Rect`	visible device bounds

Returns

TickInfo

this

setVisibleModelBounds

▸ setVisibleModelBounds(modelBounds): TickInfo

Set visible model bounds

Parameters

Name	Type	Description
`modelBounds`	`Rect`	visible model bounds

Returns

TickInfo

this

getClassName

▸ Static getClassName(): string

Returns

string