Last updated

API / geotoolkit / gauges / LinearGauge / LinearGauge

Namespace: LinearGauge

gauges.LinearGauge.LinearGauge

Table of contents

Type Aliases

Contents

Type Aliases

AxisOptions

Ƭ AxisOptions: Object

properties

Type declaration

NameTypeDescription
gap?number | stringGap between axis and indicator shape in CSS format
name?stringAxis name
position?AxisPositionPosition of the axis relative to indicator shape
visible?booleanVisibility of the axis
width?number | stringWidth of the axis (height if horizontal) in CSS format

AxisType

Ƭ AxisType: Axis | Options | Group | AxisOptions & { axis: Axis | Options | Group }

properties


IndicatorOptions

Ƭ IndicatorOptions: Object

properties pertaining to indicator and its fill

Type declaration

NameTypeDescription
backgroundfill?TypeFill style of the background of indicator
backgroundline?TypeLine style of the background of indicator
cornerradius?number | stringCorner radius of the indicator shape in CSS notation, relative to the width of the shape. (50% will create a circle)
fillposition?DynamicElementPosition | stringLayer position of the fill
fillwidth?number | stringfill width
height?number | stringHeight of the indicator in CSS format, relative to the gauge height
valuefillstyle?TypeFill style of the value fill in the indicator
valuelinestyle?TypeLine style of the value fill in the indicator
width?number | stringWidth of the indicator in CSS format, relative to the gauge width

IndicatorOptionsOut

Ƭ IndicatorOptionsOut: Required<IndicatorOptions>

JSON with Properties pertaining to indicator and its fill


NeedleOptions

Ƭ NeedleOptions: Object

properties

Type declaration

NameTypeDescription
geometry?GroupA group containing the geometry of the needle
height?number | string-
width?number | stringWidth of needle in CSS format (height if gauge is horizontal)

NeedleOptionsOut

Ƭ NeedleOptionsOut: Required<NeedleOptions>

properties


Options

Ƭ Options: Options & { axes?: Record<string, AxisType> ; indicator?: IndicatorOptions ; needle?: NeedleOptions ; orientation?: string | Orientation ; range?: Range ; regions?: Region[] }

properties


OptionsOut

Ƭ OptionsOut: OptionsOut & { axes: Record<string, AxisOptions> ; indicator: IndicatorOptionsOut ; needle: NeedleOptionsOut ; orientation: Orientation ; range: Range ; regions: Region[] }

properties