API / geotoolkit / gauges / axis / Axis / Axis
Type Aliases
Type Aliases
Ƭ EventMap: EventMap & { StateUpdated: void ; nameChanged: { new: string ; old: string } }
Ƭ LabelOptions: Merge<Partial<LabelOptionsOut>, { color?: string | RgbaColor ; font?: string }>
properties
Ƭ LabelOptionsOut: Object
properties
| Name | Type | Description |
|---|---|---|
format | string | Format of label value |
formatter | Format | Formatter which will be applied to the value before rendering |
gap | number | string | Gap between the label and the tick or axis |
position | TickPositions | Position of the labels relative to the axis |
textstyle? | TextStyle | Text style for the labels |
visible | boolean | Visibility flag of the labels |
Ƭ NameOptions: Merge<Partial<NameOptionsOut>, { color?: string | RgbaColor ; font?: string ; properties?: Options ; textstyle?: Type }>
properties
Ƭ NameOptionsOut: Object
properties
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | Position of the name in the region |
displaystrategy | ValueDisplayStrategies | Strategy by which the name will fit the region |
formatter | Format | Formatter which will be applied to the name before rendering |
position | Regions | string | Region where the name will be rendered |
properties | OptionsOut | see Text.getProperties |
textstyle? | TextStyle | Style of the text showing axis name, overrides font and color |
visible | boolean | Visibility of the name |
Ƭ Options: Options & { alarms?: Options | Alarm | Options[] | Alarm[] ; animationfunction?: Functions | string ; animationtime?: number ; functionregistry?: FunctionRegistry ; linestyle?: Type ; namestyle?: NameOptions ; range?: RangeIn ; regions?: Region[] ; tickgenerator?: TickGenerator ; ticks?: { edge?: TickOptions ; major?: TickOptions ; minor?: TickOptions } ; units?: string ; value?: number ; valuestyle?: ValueOptions }
properties
Ƭ OptionsOut: OptionsOut & { alarms: Alarm[] ; animationfunction: Functions | string ; namestyle: NameOptionsOut ; range: Range ; regions: Region[] ; tickgenerator: TickGenerator ; ticks: { edge?: TickOptionsOut ; major: TickOptionsOut ; minor?: TickOptionsOut } ; units: string ; value: number ; valuestyle: ValueOptionsOut }
properties
Ƭ RangeIn: Range | { max?: number ; min?: number }
New range to set
Ƭ TickOptions: Merge<Partial<TickOptionsOut>, { fillstyle?: Type ; labels?: LabelOptions ; linestyle?: Type ; painter?: Painter }>
properties
Ƭ TickOptionsOut: Object
| Name | Type | Description |
|---|---|---|
fillstyle | FillStyle | null | Fill style for the tick symbol |
height | number | string | Height of individual tick symbol |
labels | LabelOptionsOut | JSON with label properties |
linestyle | LineStyle | null | Line style for the tick symbol |
painter | PainterFunction | Painter which will be used to render the tick |
tickposition | TickPositions | Position of ticks relative to the axis |
visible | boolean | Visibility flag for the ticks |
width | number | string | Width of individual tick symbol |
Ƭ ValueOptions: Merge<Partial<ValueOptionsOut>, { color?: string | RgbaColor ; font?: string ; format?: string ; properties?: Options ; textstyle?: Type ; trim?: boolean }>
properties
Ƭ ValueOptionsOut: Object
properties
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | Position of the value in the region |
displaystrategy | ValueDisplayStrategies | Strategy by which the value will fit the region |
formatter | Format | Formatter which will be applied to the value before rendering |
position | Regions | string | Region where the value will be rendered |
properties | OptionsOut | see Text.getProperties |
textstyle | TextStyle | null | Style of the text showing axis value |
visible | boolean | Visibility of the value |