Home > steelseries-rose-gauge > RoseParams
RoseParams interface
Rose gauge construction parameters
Signature:
export interface RoseParams
Properties
| Property | Type | Description |
|---|---|---|
| backgroundColor? | ss.BackgroundColor | (Optional) Gauge background color - default: steelseries.BackgroundColor.DARK_GRAY |
| backgroundVisible? | boolean | (Optional) Draw gauge background? - default: true |
| foregroundType? | ss.ForegroundType | (Optional) Gauge foreground type - default: steelseries.ForegroundType.TYPE1 |
| foregroundVisible? | boolean | (Optional) Draw gauge foreground? - default: true |
| frameDesign? | ss.FrameDesign | (Optional) Gauge frame design - default: steelseries.FrameDesign.METAL |
| frameVisible? | boolean | (Optional) Draw gauge frame? - default: true |
| odometerParams? | ss.OdometerParams | (Optional) Odometer construction params |
| pointSymbols? | string[] | (Optional) Cardinal points labels - default: ["N", "E", "S", "W"] |
| size? | number | (Optional) Gauge size (px) - default: smaller dimension between canvas.width and canvas.height |
| titleString? | string | (Optional) * Gauge upper title string - default: "" |
| unitString? | string | (Optional) Gauge lower string title - default: "" |
| useOdometer? | boolean | (Optional) Draw odometer? - default: false |