Last updated

API / geotoolkit / axis / Axis / Axis

Namespace: Axis

axis.Axis.Axis

Table of contents

Type Aliases

Contents

Type Aliases

Options

Ƭ Options: Options & OptionsBase


OptionsBase

Ƭ OptionsBase: Object

User can pass an object OR a tickGenerator (by default AdaptiveTickGenerator is used of nothing is passed)

Type declaration

NameTypeDescription
autolabelrotation?booleanautomatic label rotation
autolabelrotationangle?number-
baselinestyle?Typebase line style
bounds?Rectaxis bounds
dimension?AxisMappingDimension | OptionsAxis dimension to setup axis limits
hideoverlappedtext?booleanhide overlapped text flag
infinity?booleaninfinity mode
labelmanualsettings?booleanenable / disable manual settings for labels like anchor
labeloffset?numberoffset the label offset
labelpadding?numberlabel padding size in pixels
labelposition?LabelPositionlabel position
layoutstyle?LayoutStyle | Optionsdesired layout style
maximumlabelsize?numbermaximum label size (in device), text will be wrapped, if it is bigger than maximum label size
modellimits?Rectrectangle where to generate ticks
orientation?Orientationaxis orientation
textstyle?Typelabels textstyle
tickgenerator?TickGenerator | OptionstickGenerator to use in axis
tickposition?TickPositiontick position
title?Titleaxis title
visiblebaseline?booleanvisibility of baseline

OptionsOut

Ƭ OptionsOut: OptionsOut & { autolabelrotation?: boolean ; autolabelrotationangle?: number ; baselinestyle?: LineStyle ; bounds?: Rect ; dimension?: AxisMappingDimension ; hideoverlappedtext?: boolean ; infinity?: boolean ; labelmanualsettings?: boolean ; labeloffset?: number ; labelpadding?: number ; labelposition?: LabelPosition ; layoutstyle?: LayoutStyle ; maximumlabelsize?: number ; modellimits?: Rect ; orientation?: Orientation ; textstyle?: TextStyle ; tickgenerator?: TickGenerator ; tickposition?: TickPosition ; title?: TitleOut ; visiblebaseline?: boolean }

An object containing the properties


Title

Ƭ Title: Object

axis title text or title object

Type declaration

NameTypeDescription
alignment?AnchorTypealignment
margin?Typemargin style
offset?Point | Dimensionoffset
showellipsis?booleanenables/disables ellipsis in case if text is too long
text?stringaxis title text
textstyle?Typetext style
visible?booleanvisibility

TitleOut

Ƭ TitleOut: Object

axis title text or title object

Type declaration

NameTypeDescription
alignment?AnchorTypealignment
margin?SpaceStylemargin style
offset?Pointoffset
showellipsis?booleanenables/disables ellipsis in case if text is too long
text?stringaxis title text
textstyle?TextStyletext style
visible?booleanvisibility