API / geotoolkit / gauges / NumericGauge / NumericGauge
gauges.NumericGauge.NumericGauge
Type Aliases
Type Aliases
Ƭ BackgroundStyleOptions: Object
object containing background styles
| Name | Type | Description |
|---|---|---|
fillstyle? | Type | background fillstyle |
linestyle? | Type | background linestyle |
visible? | boolean | background visibility |
Ƭ BackgroundStyleOptionsOut: Object
object containing background styles
| Name | Type | Description |
|---|---|---|
fillstyle | FillStyle | null | background fillstyle |
linestyle | LineStyle | null | background linestyle |
visible | boolean | background visibility |
Ƭ EventMap: EventMap & { gaugeValueUpdated: { new: number ; old: number } }
Ƭ NameOptions: Object
Object with properties
| Name | Type | Description |
|---|---|---|
alignment? | AnchorType | Defines where in the region the name text will be positioned |
color? | string | RgbaColor | Color of name text |
displaystrategy? | ValueDisplayStrategies | A display strategy to define how the name text fits the region it is rendered in |
font? | string | Font of name text |
position? | Regions | string | Region in which to render the name text |
properties? | Options | see Text.setProperties |
textstyle? | Type | Text style of the name text. If provided, overrides font and color |
visible? | boolean | Visibility of the name text |
Ƭ NameOptionsOut: Object
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | Defines where in the region the value text will be positioned |
displaystrategy | ValueDisplayStrategies | A display strategy which defines how the value text fits the region it is rendered in |
position | Regions | Region in which to render the name text |
properties? | OptionsOut | see Text.getProperties |
textstyle | TextStyle | null | Text style of the value text |
visible | boolean | Visibility of the value text |
Ƭ Options: Options & { alarms?: Alarm[] ; animationfunction?: Functions | string ; animationtime?: number ; background?: BackgroundStyleOptions ; namestyle?: NameOptions ; units?: string ; value?: number ; valuestyle?: ValueOptions }
properties
Ƭ OptionsOut: OptionsOut & { alarms?: Alarm[] ; animationfunction?: Functions | string ; animationtime?: number ; background?: { fillstyle?: FillStyle ; linestyle?: LineStyle ; visible?: boolean } ; namestyle?: { alignment?: AnchorType ; color?: string | RgbaColor ; displaystrategy?: ValueDisplayStrategies ; font?: string ; position?: Regions ; textstyle?: TextStyle ; visible?: boolean } ; units?: string ; value?: number ; valuestyle?: { alignment?: AnchorType ; color?: string | RgbaColor ; displaystrategy?: ValueDisplayStrategies ; font?: string ; format?: string ; formatter?: Format ; position?: Regions ; textstyle?: TextStyle ; visible?: boolean } }
properties
Ƭ ValueOptions: Object
Object with properties
| Name | Type | Description |
|---|---|---|
alignment? | AnchorType | Defines where in the region the value text will be positioned |
color? | string | RgbaColor | Color of name text |
displaystrategy? | ValueDisplayStrategies | A display strategy to define how the value text fits the region it is rendered in |
font? | string | Font of value text |
format? | string | Format of value to set on number formatter |
formatter? | Format | Formatter which will be used to format the value before displaying it. |
position? | Regions | string | Region in which to render the name text |
properties? | Options | see Text.setProperties |
textstyle? | Type | Text style of the value text. If provided, overrides font and color |
visible? | boolean | Visibility of the value text |
Ƭ ValueOptionsOut: Object
Format of value to set on number formatter
| Name | Type | Description |
|---|---|---|
alignment | AnchorType | Defines where in the region the value text will be positioned |
displaystrategy | ValueDisplayStrategies | A display strategy which defines how the value text fits the region it is rendered in |
format | string | Format of value to set on number formatter |
formatter | Format | Formatter which will be used to format the value before displaying it. |
position | Regions | Region in which to render the name text |
properties? | OptionsOut | see Text.getProperties |
textstyle | TextStyle | null | Text style of the value text |
visible | boolean | Visibility of the value text |