@oicl/openbridge-webcomponents-svelte 2.0.0-next.159 → 2.0.0-next.160

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (170) hide show
  1. package/README.md +1 -1
  2. package/dist/automation/analog-valve/ObcAnalogValve.svelte +4 -4
  3. package/dist/automation/automation-button/ObcAbstractAutomationButton.svelte +4 -4
  4. package/dist/automation/automation-button/ObcAbstractAutomationButtonMotorized.svelte +4 -4
  5. package/dist/automation/automation-button/ObcAbstractAutomationButtonSquared.svelte +4 -4
  6. package/dist/automation/automation-tank/ObcAutomationTank.svelte +10 -65
  7. package/dist/automation/automation-tank/ObcAutomationTank.svelte.d.ts +5 -60
  8. package/dist/automation/bipolar-transistor/ObcBipolarTransistor.svelte +4 -4
  9. package/dist/automation/capacitor/ObcCapacitor.svelte +4 -4
  10. package/dist/automation/converter/ObcConverter.svelte +4 -4
  11. package/dist/automation/damper/ObcDamper.svelte +4 -4
  12. package/dist/automation/digital-valve/ObcDigitalValve.svelte +4 -4
  13. package/dist/automation/diodes/ObcDiodes.svelte +4 -4
  14. package/dist/automation/fan/ObcFan.svelte +4 -4
  15. package/dist/automation/filter/ObcFilter.svelte +4 -4
  16. package/dist/automation/ground/ObcGround.svelte +4 -4
  17. package/dist/automation/logic/ObcLogic.svelte +4 -4
  18. package/dist/automation/mosfet/ObcMosfet.svelte +4 -4
  19. package/dist/automation/motor/ObcMotor.svelte +4 -4
  20. package/dist/automation/pump/ObcPump.svelte +4 -4
  21. package/dist/automation/resistor/ObcResistor.svelte +4 -4
  22. package/dist/automation/router/ObcRouter.svelte +4 -4
  23. package/dist/automation/source/ObcSource.svelte +4 -4
  24. package/dist/automation/switch/ObcSwitch.svelte +4 -4
  25. package/dist/automation/transformer/ObcTransformer.svelte +4 -4
  26. package/dist/bars-graphs/area-graph/ObcAreaGraph.svelte +4 -21
  27. package/dist/bars-graphs/area-graph/ObcAreaGraph.svelte.d.ts +2 -19
  28. package/dist/bars-graphs/line-graph/ObcLineGraph.svelte +2 -16
  29. package/dist/bars-graphs/line-graph/ObcLineGraph.svelte.d.ts +1 -15
  30. package/dist/building-blocks/chart-line/ObcChartLineBase.svelte +2 -16
  31. package/dist/building-blocks/chart-line/ObcChartLineBase.svelte.d.ts +1 -15
  32. package/dist/building-blocks/circular-progress/ObcCircularProgress.svelte +9 -0
  33. package/dist/building-blocks/circular-progress/ObcCircularProgress.svelte.d.ts +9 -0
  34. package/dist/building-blocks/single-axis-inclinometer/SingleAxisInclinometer.svelte +1 -10
  35. package/dist/building-blocks/single-axis-inclinometer/SingleAxisInclinometer.svelte.d.ts +0 -9
  36. package/dist/components/accordion-card/ObcAccordionCard.svelte +4 -10
  37. package/dist/components/accordion-card/ObcAccordionCard.svelte.d.ts +2 -8
  38. package/dist/components/advice-button/ObcAdviceButton.svelte +6 -6
  39. package/dist/components/advice-button/ObcAdviceButton.svelte.d.ts +5 -5
  40. package/dist/components/advice-floating-item/ObcAdviceFloatingItem.svelte +6 -15
  41. package/dist/components/advice-floating-item/ObcAdviceFloatingItem.svelte.d.ts +3 -12
  42. package/dist/components/advice-message-item/ObcAdviceMessageItem.svelte +4 -14
  43. package/dist/components/advice-message-item/ObcAdviceMessageItem.svelte.d.ts +2 -12
  44. package/dist/components/alert-frame/ObcAlertFrame.svelte +8 -23
  45. package/dist/components/alert-frame/ObcAlertFrame.svelte.d.ts +4 -19
  46. package/dist/components/alert-menu/ObcAlertMenu.svelte +8 -20
  47. package/dist/components/alert-menu/ObcAlertMenu.svelte.d.ts +4 -16
  48. package/dist/components/alert-menu-item/ObcAlertMenuItem.svelte +4 -4
  49. package/dist/components/alert-menu-item/ObcAlertMenuItem.svelte.d.ts +2 -2
  50. package/dist/components/app-button/ObcAppButton.svelte +6 -2
  51. package/dist/components/app-button/ObcAppButton.svelte.d.ts +5 -1
  52. package/dist/components/badge/ObcBadge.svelte +16 -28
  53. package/dist/components/badge/ObcBadge.svelte.d.ts +10 -22
  54. package/dist/components/breadcrumb/ObcBreadcrumb.svelte +2 -6
  55. package/dist/components/breadcrumb/ObcBreadcrumb.svelte.d.ts +1 -5
  56. package/dist/components/button/ObcButton.svelte +4 -11
  57. package/dist/components/button/ObcButton.svelte.d.ts +2 -9
  58. package/dist/components/card/ObcCard.svelte +14 -12
  59. package/dist/components/card/ObcCard.svelte.d.ts +11 -9
  60. package/dist/components/check-button/ObcCheckButton.svelte +4 -8
  61. package/dist/components/check-button/ObcCheckButton.svelte.d.ts +2 -6
  62. package/dist/components/checkbox/ObcCheckbox.svelte +6 -13
  63. package/dist/components/checkbox/ObcCheckbox.svelte.d.ts +3 -10
  64. package/dist/components/command-button/ObcCommandButton.svelte +2 -7
  65. package/dist/components/command-button/ObcCommandButton.svelte.d.ts +1 -6
  66. package/dist/components/context-menu-input/ObcContextMenuInput.svelte +24 -42
  67. package/dist/components/context-menu-input/ObcContextMenuInput.svelte.d.ts +16 -34
  68. package/dist/components/date-item/ObcDateItem.svelte +2 -4
  69. package/dist/components/date-item/ObcDateItem.svelte.d.ts +1 -3
  70. package/dist/components/dropdown-button/ObcDropdownButton.svelte +4 -13
  71. package/dist/components/dropdown-button/ObcDropdownButton.svelte.d.ts +2 -11
  72. package/dist/components/elevated-card/ObcElevatedCard.svelte +6 -19
  73. package/dist/components/elevated-card/ObcElevatedCard.svelte.d.ts +3 -16
  74. package/dist/components/elevated-card-radio-group/ObcElevatedCardRadioGroup.svelte +4 -8
  75. package/dist/components/elevated-card-radio-group/ObcElevatedCardRadioGroup.svelte.d.ts +2 -6
  76. package/dist/components/event-list/ObcEventList.svelte +2 -2
  77. package/dist/components/event-list/ObcEventList.svelte.d.ts +1 -1
  78. package/dist/components/floating-item/ObcFloatingItem.svelte +6 -18
  79. package/dist/components/floating-item/ObcFloatingItem.svelte.d.ts +3 -15
  80. package/dist/components/icon-button/ObcIconButton.svelte +2 -5
  81. package/dist/components/icon-button/ObcIconButton.svelte.d.ts +1 -4
  82. package/dist/components/icon-check-button/ObcIconCheckButton.svelte +16 -24
  83. package/dist/components/icon-check-button/ObcIconCheckButton.svelte.d.ts +10 -18
  84. package/dist/components/menu-button/ObcMenuButton.svelte +4 -17
  85. package/dist/components/menu-button/ObcMenuButton.svelte.d.ts +2 -15
  86. package/dist/components/navigation-item/ObcNavigationItem.svelte +2 -2
  87. package/dist/components/navigation-item/ObcNavigationItem.svelte.d.ts +1 -1
  88. package/dist/components/navigation-item-group/ObcNavigationItemGroup.svelte +2 -2
  89. package/dist/components/navigation-item-group/ObcNavigationItemGroup.svelte.d.ts +1 -1
  90. package/dist/components/navigation-menu/ObcNavigationMenu.svelte +2 -8
  91. package/dist/components/navigation-menu/ObcNavigationMenu.svelte.d.ts +1 -7
  92. package/dist/components/notification-badge-button/ObcNotificationBadgeButton.svelte +2 -2
  93. package/dist/components/notification-badge-button/ObcNotificationBadgeButton.svelte.d.ts +2 -2
  94. package/dist/components/notification-button/ObcNotificationButton.svelte +22 -35
  95. package/dist/components/notification-button/ObcNotificationButton.svelte.d.ts +17 -30
  96. package/dist/components/notification-floating-item/ObcNotificationFloatingItem.svelte +6 -15
  97. package/dist/components/notification-floating-item/ObcNotificationFloatingItem.svelte.d.ts +3 -12
  98. package/dist/components/notification-message-item/ObcNotificationMessageItem.svelte +4 -10
  99. package/dist/components/notification-message-item/ObcNotificationMessageItem.svelte.d.ts +2 -8
  100. package/dist/components/pagination/ObcPagination.svelte +8 -26
  101. package/dist/components/pagination/ObcPagination.svelte.d.ts +4 -22
  102. package/dist/components/pivot-item/ObcPivotItem.svelte +14 -29
  103. package/dist/components/pivot-item/ObcPivotItem.svelte.d.ts +7 -22
  104. package/dist/components/progress-bar/ObcProgressBar.svelte +6 -5
  105. package/dist/components/progress-bar/ObcProgressBar.svelte.d.ts +5 -4
  106. package/dist/components/rich-button/ObcRichButton.svelte +2 -4
  107. package/dist/components/rich-button/ObcRichButton.svelte.d.ts +1 -3
  108. package/dist/components/slider/ObcSlider.svelte +32 -46
  109. package/dist/components/slider/ObcSlider.svelte.d.ts +22 -36
  110. package/dist/components/slider-double/ObcSliderDouble.svelte +7 -21
  111. package/dist/components/slider-double/ObcSliderDouble.svelte.d.ts +4 -18
  112. package/dist/components/start-stop-switch/ObcStartStopSwitch.svelte +18 -48
  113. package/dist/components/start-stop-switch/ObcStartStopSwitch.svelte.d.ts +11 -41
  114. package/dist/components/stepper-box/ObcStepperBox.svelte +2 -7
  115. package/dist/components/stepper-box/ObcStepperBox.svelte.d.ts +1 -6
  116. package/dist/components/system-button/ObcSystemButton.svelte +4 -14
  117. package/dist/components/system-button/ObcSystemButton.svelte.d.ts +2 -12
  118. package/dist/components/tab-item/ObcTabItem.svelte +30 -66
  119. package/dist/components/tab-item/ObcTabItem.svelte.d.ts +17 -53
  120. package/dist/components/tab-row/ObcTabRow.svelte +12 -36
  121. package/dist/components/tab-row/ObcTabRow.svelte.d.ts +6 -30
  122. package/dist/components/toggle-button-group/ObcToggleButtonGroup.svelte +18 -54
  123. package/dist/components/toggle-button-group/ObcToggleButtonGroup.svelte.d.ts +9 -45
  124. package/dist/components/toggle-button-vertical-group/ObcToggleButtonVerticalGroup.svelte +10 -26
  125. package/dist/components/toggle-button-vertical-group/ObcToggleButtonVerticalGroup.svelte.d.ts +5 -21
  126. package/dist/components/toggle-button-vertical-option/ObcToggleButtonVerticalOption.svelte +2 -4
  127. package/dist/components/toggle-button-vertical-option/ObcToggleButtonVerticalOption.svelte.d.ts +1 -3
  128. package/dist/components/toggletip/ObcToggletip.svelte +2 -10
  129. package/dist/components/toggletip/ObcToggletip.svelte.d.ts +1 -9
  130. package/dist/components/tooltip/ObcTooltip.svelte +16 -28
  131. package/dist/components/tooltip/ObcTooltip.svelte.d.ts +12 -24
  132. package/dist/components/top-bar/ObcTopBar.svelte +84 -48
  133. package/dist/components/top-bar/ObcTopBar.svelte.d.ts +45 -9
  134. package/dist/components/topbar-message-item/ObcTopbarMessageItem.svelte +4 -16
  135. package/dist/components/topbar-message-item/ObcTopbarMessageItem.svelte.d.ts +2 -14
  136. package/dist/components/tree-navigation-group/ObcTreeNavigationGroup.svelte +2 -2
  137. package/dist/components/tree-navigation-group/ObcTreeNavigationGroup.svelte.d.ts +1 -1
  138. package/dist/components/tree-navigation-item/ObcTreeNavigationItem.svelte +2 -2
  139. package/dist/components/tree-navigation-item/ObcTreeNavigationItem.svelte.d.ts +1 -1
  140. package/dist/components/user-button/ObcUserButton.svelte +6 -13
  141. package/dist/components/user-button/ObcUserButton.svelte.d.ts +3 -10
  142. package/dist/components/vendor-button/ObcVendorButton.svelte +4 -8
  143. package/dist/components/vendor-button/ObcVendorButton.svelte.d.ts +2 -6
  144. package/dist/integration-systems/integration-dropdown-button/ObcIntegrationDropdownButton.svelte +2 -8
  145. package/dist/integration-systems/integration-dropdown-button/ObcIntegrationDropdownButton.svelte.d.ts +1 -7
  146. package/dist/navigation-instruments/compass/ObcCompass.svelte +6 -8
  147. package/dist/navigation-instruments/compass/ObcCompass.svelte.d.ts +5 -7
  148. package/dist/navigation-instruments/compass-indicator/ObcCompassIndicator.svelte +2 -7
  149. package/dist/navigation-instruments/compass-indicator/ObcCompassIndicator.svelte.d.ts +1 -6
  150. package/dist/navigation-instruments/compass-sector/ObcCompassSector.svelte +6 -7
  151. package/dist/navigation-instruments/compass-sector/ObcCompassSector.svelte.d.ts +5 -6
  152. package/dist/navigation-instruments/gauge-radial/ObcGaugeRadial.svelte +12 -23
  153. package/dist/navigation-instruments/gauge-radial/ObcGaugeRadial.svelte.d.ts +5 -16
  154. package/dist/navigation-instruments/gauge-trend/ObcGaugeTrend.svelte +28 -51
  155. package/dist/navigation-instruments/gauge-trend/ObcGaugeTrend.svelte.d.ts +22 -45
  156. package/dist/navigation-instruments/pitch/ObcPitch.svelte +2 -10
  157. package/dist/navigation-instruments/pitch/ObcPitch.svelte.d.ts +1 -9
  158. package/dist/navigation-instruments/pitch-roll/ObcPitchRoll.svelte +4 -4
  159. package/dist/navigation-instruments/pitch-roll/ObcPitchRoll.svelte.d.ts +2 -2
  160. package/dist/navigation-instruments/roll/ObcRoll.svelte +2 -10
  161. package/dist/navigation-instruments/roll/ObcRoll.svelte.d.ts +1 -9
  162. package/dist/navigation-instruments/rot-indicator/ObcRotIndicator.svelte +2 -6
  163. package/dist/navigation-instruments/rot-indicator/ObcRotIndicator.svelte.d.ts +1 -5
  164. package/dist/navigation-instruments/rot-sector/ObcRotSector.svelte +16 -20
  165. package/dist/navigation-instruments/rot-sector/ObcRotSector.svelte.d.ts +4 -8
  166. package/dist/navigation-instruments/speed-gauge/ObcSpeedGauge.svelte +14 -20
  167. package/dist/navigation-instruments/speed-gauge/ObcSpeedGauge.svelte.d.ts +3 -9
  168. package/dist/navigation-instruments/wind-indicator/ObcWindIndicator.svelte +6 -22
  169. package/dist/navigation-instruments/wind-indicator/ObcWindIndicator.svelte.d.ts +3 -19
  170. package/package.json +2 -2
@@ -88,22 +88,8 @@ animateSetpoint?: boolean;
88
88
  showGridY?: boolean;
89
89
  /** Show axis tick marks and labels. */
90
90
  showTickMarks?: boolean;
91
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
92
-
93
- When `true` (default), the chart leaves room for tick labels and renders them
94
- (subject to `showTickMarks` and the 192px auto-compact threshold).
95
-
96
- When `false`, the chart renders edge-to-edge on sides without a slotted external
97
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
98
- suppresses the automatic edge-to-edge switch that normally happens below the
99
- 192px threshold, eliminating the visible padding "jump" when crossing it.
100
-
101
- Useful when embedding the chart inside another component that owns framing
102
- and never wants to show axis labels (e.g. `obc-automation-tank`).
103
-
104
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
105
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
106
- hasLabelPadding?: boolean;
91
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
92
+ hasLabelPadding?: boolean;
107
93
  /**
108
94
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
109
95
  *
@@ -148,12 +134,12 @@ hasLabelPadding?: boolean;
148
134
  * Available when `instrumentMode==true`.
149
135
  */
150
136
  borderRadius?: number | undefined;
151
- /** Scale type for the vertical scale.
152
- - `'regular'`: Standard tick lengths (default)
153
- - `'condensed'`: Shorter tick lengths for compact display
154
-
155
- Hidden from Storybook controls via argTypes configuration. */
156
- scaleType?: ScaleType;
137
+ /**
138
+ * Vertical scale type: `regular` (default) uses the standard tick lengths, `condensed` the shorter ones for a compact display.
139
+ *
140
+ * Available when `hasScale==true`.
141
+ */
142
+ scaleType?: ScaleType;
157
143
  /** Minimum value for the scale range. Also used as chart y-axis minimum when `chartMinValue` is undefined. */
158
144
  minValue?: number;
159
145
  /** Maximum value for the scale range. Also used as chart y-axis maximum when `chartMaxValue` is undefined. */
@@ -164,20 +150,14 @@ scaleType?: ScaleType;
164
150
  chartMaxValue?: number | undefined;
165
151
  /** Plot `minValue` at the top and grow downward, on both the chart y axis and the vertical scale. The chart fill still reaches the visual bottom. */
166
152
  reverse?: boolean;
167
- /** Current value displayed on the vertical scale.
168
-
169
- This is the primary value property that drives:
170
- - The bar fill level (when `hasBar=true`)
171
- - The dot indicator position (when `hasBar=false`)
172
- - The `fillMax` value (when `fillMax` is not explicitly set)
173
-
174
- In typical usage, you only need to set this property to update the gauge. */
175
- value?: number | undefined;
176
- /** Show bar on the vertical scale.
177
-
178
- When `true`, displays a filled bar indicating the current value.
179
- When `false`, a dot indicator is automatically shown at the value position instead. */
180
- hasBar?: boolean;
153
+ /**
154
+ * Current value on the vertical scale, and the only property most callers set: it drives the bar fill level when `hasBar` is true, the dot indicator position when it is false, and `fillMax` when that is left unset.
155
+ *
156
+ * Available when `hasBar==true || hasScale==true`.
157
+ */
158
+ value?: number | undefined;
159
+ /** Show bar on the vertical scale. When `true`, displays a filled bar indicating the current value. When `false`, a dot indicator is automatically shown at the value position instead. */
160
+ hasBar?: boolean;
181
161
  /** Show scale tick marks and labels. */
182
162
  hasScale?: boolean;
183
163
  /**
@@ -188,27 +168,24 @@ hasBar?: boolean;
188
168
  showMainTickmarkLabels?: boolean;
189
169
  /** Show advice overlays on the vertical scale. */
190
170
  hasAdvice?: boolean;
191
- /** Fill mode for the bar.
192
- - `'fill'`: Bar fills from `fillMin` to `value` — the bar visually tracks the current value.
193
- The `fillMax` property is **ignored** in this mode.
194
- - `'tint'`: Bar fills from `fillMin` to `fillMax` — an explicit highlighted range.
195
- Use this when you want to show a fixed range independent of the current value.
196
-
197
- In both modes, `fillMin` is the origin point (e.g., 0 in a -100..100 scale). */
198
- fillMode?: FillMode;
171
+ /**
172
+ * Bar fill mode, both measured from `fillMin` as the origin: `fill` runs to `value` so the bar tracks the reading and `fillMax` is ignored, while `tint` runs to `fillMax` for a fixed highlighted range independent of the reading.
173
+ *
174
+ * Available when `hasBar==true && value!=undefined`.
175
+ */
176
+ fillMode?: FillMode;
199
177
  /**
200
178
  * Fill origin value - the starting point for the bar fill. In both fill modes, the bar fills from this value toward the current value. For scales like -100..100, set this to 0 to have the bar fill up or down from zero.
201
179
  *
202
180
  * Available when `hasBar==true && value!=undefined`.
203
181
  */
204
182
  fillMin?: number;
205
- /** Maximum fill value for the bar (only used in `'tint'` mode).
206
-
207
- In `'fill'` mode, this property is **ignored** — the bar always fills to `value`.
208
-
209
- In `'tint'` mode, this defines the upper bound of the highlighted range.
210
- When `undefined`, defaults to `value`. */
211
- fillMax?: number | undefined;
183
+ /**
184
+ * Maximum fill value for the bar (only used in `'tint'` mode). In `'fill'` mode, this property is **ignored** — the bar always fills to `value`. In `'tint'` mode, this defines the upper bound of the highlighted range. When `undefined`, defaults to `value`.
185
+ *
186
+ * Available when `hasBar==true && value!=undefined && fillMode==tint`.
187
+ */
188
+ fillMax?: number | undefined;
212
189
  /**
213
190
  * Advice/alert overlays for the vertical scale.
214
191
  *
@@ -80,21 +80,7 @@ regardless of instrument state. */
80
80
  showGridY?: boolean;
81
81
  /** Show axis tick marks and labels. */
82
82
  showTickMarks?: boolean;
83
- /** Reserve canvas padding for axis tick labels on sides without an external scale.
84
-
85
- When `true` (default), the chart leaves room for tick labels and renders them
86
- (subject to `showTickMarks` and the 192px auto-compact threshold).
87
-
88
- When `false`, the chart renders edge-to-edge on sides without a slotted external
89
- scale AND axis tick labels are force-hidden so they cannot be clipped. This also
90
- suppresses the automatic edge-to-edge switch that normally happens below the
91
- 192px threshold, eliminating the visible padding "jump" when crossing it.
92
-
93
- Useful when embedding the chart inside another component that owns framing
94
- and never wants to show axis labels (e.g. `obc-automation-tank`).
95
-
96
- Defaults to `true` to preserve existing behavior. Declared with `attribute: false`
97
- because a `true`-default boolean cannot work as an HTML boolean attribute. */
83
+ /** Reserves canvas padding for axis tick labels on the sides that have no slotted external scale. `false` renders those sides edge-to-edge and hides the tick labels so they cannot be clipped, and it also suppresses the automatic edge-to-edge switch below the 192px threshold, removing the padding jump at that crossing. Set it when a host owns the framing and never wants axis labels, as `obc-automation-tank` does. */
98
84
  hasLabelPadding?: boolean;
99
85
  /**
100
86
  * Labels kept below the 192px threshold, where the axis labels are otherwise hidden: 'y' draws min, max and (inside the range) 0 in a gutter on the y-axis side; 'x' draws the first and last x value in a bottom gutter; 'xy' both. Ignored when `hasLabelPadding` is false.
@@ -140,11 +126,11 @@ because a `true`-default boolean cannot work as an HTML boolean attribute. */
140
126
  * Available when `instrumentMode==true`.
141
127
  */
142
128
  borderRadius?: number | undefined;
143
- /** Scale type for the vertical scale.
144
- - `'regular'`: Standard tick lengths (default)
145
- - `'condensed'`: Shorter tick lengths for compact display
146
-
147
- Hidden from Storybook controls via argTypes configuration. */
129
+ /**
130
+ * Vertical scale type: `regular` (default) uses the standard tick lengths, `condensed` the shorter ones for a compact display.
131
+ *
132
+ * Available when `hasScale==true`.
133
+ */
148
134
  scaleType?: ScaleType;
149
135
  /** Minimum value for the scale range. Also used as chart y-axis minimum when `chartMinValue` is undefined. */
150
136
  minValue?: number;
@@ -156,19 +142,13 @@ Hidden from Storybook controls via argTypes configuration. */
156
142
  chartMaxValue?: number | undefined;
157
143
  /** Plot `minValue` at the top and grow downward, on both the chart y axis and the vertical scale. The chart fill still reaches the visual bottom. */
158
144
  reverse?: boolean;
159
- /** Current value displayed on the vertical scale.
160
-
161
- This is the primary value property that drives:
162
- - The bar fill level (when `hasBar=true`)
163
- - The dot indicator position (when `hasBar=false`)
164
- - The `fillMax` value (when `fillMax` is not explicitly set)
165
-
166
- In typical usage, you only need to set this property to update the gauge. */
145
+ /**
146
+ * Current value on the vertical scale, and the only property most callers set: it drives the bar fill level when `hasBar` is true, the dot indicator position when it is false, and `fillMax` when that is left unset.
147
+ *
148
+ * Available when `hasBar==true || hasScale==true`.
149
+ */
167
150
  value?: number | undefined;
168
- /** Show bar on the vertical scale.
169
-
170
- When `true`, displays a filled bar indicating the current value.
171
- When `false`, a dot indicator is automatically shown at the value position instead. */
151
+ /** Show bar on the vertical scale. When `true`, displays a filled bar indicating the current value. When `false`, a dot indicator is automatically shown at the value position instead. */
172
152
  hasBar?: boolean;
173
153
  /** Show scale tick marks and labels. */
174
154
  hasScale?: boolean;
@@ -180,13 +160,11 @@ When `false`, a dot indicator is automatically shown at the value position inste
180
160
  showMainTickmarkLabels?: boolean;
181
161
  /** Show advice overlays on the vertical scale. */
182
162
  hasAdvice?: boolean;
183
- /** Fill mode for the bar.
184
- - `'fill'`: Bar fills from `fillMin` to `value` — the bar visually tracks the current value.
185
- The `fillMax` property is **ignored** in this mode.
186
- - `'tint'`: Bar fills from `fillMin` to `fillMax` — an explicit highlighted range.
187
- Use this when you want to show a fixed range independent of the current value.
188
-
189
- In both modes, `fillMin` is the origin point (e.g., 0 in a -100..100 scale). */
163
+ /**
164
+ * Bar fill mode, both measured from `fillMin` as the origin: `fill` runs to `value` so the bar tracks the reading and `fillMax` is ignored, while `tint` runs to `fillMax` for a fixed highlighted range independent of the reading.
165
+ *
166
+ * Available when `hasBar==true && value!=undefined`.
167
+ */
190
168
  fillMode?: FillMode;
191
169
  /**
192
170
  * Fill origin value - the starting point for the bar fill. In both fill modes, the bar fills from this value toward the current value. For scales like -100..100, set this to 0 to have the bar fill up or down from zero.
@@ -194,12 +172,11 @@ In both modes, `fillMin` is the origin point (e.g., 0 in a -100..100 scale). */
194
172
  * Available when `hasBar==true && value!=undefined`.
195
173
  */
196
174
  fillMin?: number;
197
- /** Maximum fill value for the bar (only used in `'tint'` mode).
198
-
199
- In `'fill'` mode, this property is **ignored** — the bar always fills to `value`.
200
-
201
- In `'tint'` mode, this defines the upper bound of the highlighted range.
202
- When `undefined`, defaults to `value`. */
175
+ /**
176
+ * Maximum fill value for the bar (only used in `'tint'` mode). In `'fill'` mode, this property is **ignored** — the bar always fills to `value`. In `'tint'` mode, this defines the upper bound of the highlighted range. When `undefined`, defaults to `value`.
177
+ *
178
+ * Available when `hasBar==true && value!=undefined && fillMode==tint`.
179
+ */
203
180
  fillMax?: number | undefined;
204
181
  /**
205
182
  * Advice/alert overlays for the vertical scale.
@@ -18,16 +18,8 @@ import type {ObcPitchType} from '@oicl/openbridge-webcomponents/dist/navigation-
18
18
  hasReadout?: boolean;
19
19
  /** Colour palette for the scale fill / indicator and the readout value: `regular` (default) or `enhanced`. */
20
20
  priority?: Priority;
21
- /** Half-extent of the watch arc in degrees. The arc spans `centre ± arcAngle`
22
- and values are placed at their true position within it. Default `45`
23
- reproduces the historical 90°-wide arc.
24
-
25
- Smaller values render a narrower arc. Combined with `zoomToFitArc`, the
26
- narrower arc is enlarged (its radius grows) on its own layer, while the
27
- vessel image and the rotating indicator line stay at their natural size and
28
- position on a separate central layer. The two layers are intentionally
29
- visually disconnected. */
30
- arcAngle?: number;
21
+ /** Half-extent of the watch arc in degrees: the arc spans `centre ± arcAngle` and values sit at their true position within it, so `45` gives the historical 90°-wide arc. With `zoomToFitArc`, a narrower arc is enlarged on its own layer while the vessel image and the indicator line keep their natural size on a separate central layer — the two layers are deliberately disconnected. */
22
+ arcAngle?: number;
31
23
  pitch?: number;
32
24
  minAvgPitch?: number;
33
25
  maxAvgPitch?: number;
@@ -11,15 +11,7 @@ export interface Props {
11
11
  hasReadout?: boolean;
12
12
  /** Colour palette for the scale fill / indicator and the readout value: `regular` (default) or `enhanced`. */
13
13
  priority?: Priority;
14
- /** Half-extent of the watch arc in degrees. The arc spans `centre ± arcAngle`
15
- and values are placed at their true position within it. Default `45`
16
- reproduces the historical 90°-wide arc.
17
-
18
- Smaller values render a narrower arc. Combined with `zoomToFitArc`, the
19
- narrower arc is enlarged (its radius grows) on its own layer, while the
20
- vessel image and the rotating indicator line stay at their natural size and
21
- position on a separate central layer. The two layers are intentionally
22
- visually disconnected. */
14
+ /** Half-extent of the watch arc in degrees: the arc spans `centre ± arcAngle` and values sit at their true position within it, so `45` gives the historical 90°-wide arc. With `zoomToFitArc`, a narrower arc is enlarged on its own layer while the vessel image and the indicator line keep their natural size on a separate central layer — the two layers are deliberately disconnected. */
23
15
  arcAngle?: number;
24
16
  pitch?: number;
25
17
  minAvgPitch?: number;
@@ -61,10 +61,10 @@ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-inst
61
61
  zoomToFitArc?: boolean;
62
62
  /** Half-extent of each of the four watch arcs in degrees, measured from the arc's natural center (0°/90°/180°/270°). Each arc spans `center ± arcAngle`. Default `30` reproduces the historical 60°-wide arcs; smaller values produce narrower arcs that, combined with `zoomToFitArc`, reveal more detail in the relevant motion range. */
63
63
  arcAngle?: number;
64
- /** [object Object],[object Object],[object Object] */
65
- pitchArcAngle?: number | undefined;
66
- /** [object Object],[object Object],[object Object] */
67
- rollArcAngle?: number | undefined
64
+ /** Per-axis override for the pitch arcs, top and bottom, falling back to `arcAngle` when undefined — for rectangular layouts where pitch and roll need different angular extents. */
65
+ pitchArcAngle?: number | undefined;
66
+ /** Per-axis override for the roll arcs, left and right, falling back to `arcAngle` when undefined. */
67
+ rollArcAngle?: number | undefined
68
68
  }
69
69
  export interface Events {
70
70
 
@@ -54,9 +54,9 @@ export interface Props {
54
54
  zoomToFitArc?: boolean;
55
55
  /** Half-extent of each of the four watch arcs in degrees, measured from the arc's natural center (0°/90°/180°/270°). Each arc spans `center ± arcAngle`. Default `30` reproduces the historical 60°-wide arcs; smaller values produce narrower arcs that, combined with `zoomToFitArc`, reveal more detail in the relevant motion range. */
56
56
  arcAngle?: number;
57
- /** [object Object],[object Object],[object Object] */
57
+ /** Per-axis override for the pitch arcs, top and bottom, falling back to `arcAngle` when undefined — for rectangular layouts where pitch and roll need different angular extents. */
58
58
  pitchArcAngle?: number | undefined;
59
- /** [object Object],[object Object],[object Object] */
59
+ /** Per-axis override for the roll arcs, left and right, falling back to `arcAngle` when undefined. */
60
60
  rollArcAngle?: number | undefined;
61
61
  }
62
62
  export interface Events {
@@ -18,16 +18,8 @@ import type {ObcRollType} from '@oicl/openbridge-webcomponents/dist/navigation-i
18
18
  hasReadout?: boolean;
19
19
  /** Colour palette for the scale fill / indicator and the readout value: `regular` (default) or `enhanced`. */
20
20
  priority?: Priority;
21
- /** Half-extent of the watch arc in degrees. The arc spans `centre ± arcAngle`
22
- and values are placed at their true position within it. Default `45`
23
- reproduces the historical 90°-wide arc.
24
-
25
- Smaller values render a narrower arc. Combined with `zoomToFitArc`, the
26
- narrower arc is enlarged (its radius grows) on its own layer, while the
27
- vessel image and the rotating indicator line stay at their natural size and
28
- position on a separate central layer. The two layers are intentionally
29
- visually disconnected. */
30
- arcAngle?: number;
21
+ /** Half-extent of the watch arc in degrees: the arc spans `centre ± arcAngle` and values sit at their true position within it, so `45` gives the historical 90°-wide arc. With `zoomToFitArc`, a narrower arc is enlarged on its own layer while the vessel image and the indicator line keep their natural size on a separate central layer — the two layers are deliberately disconnected. */
22
+ arcAngle?: number;
31
23
  roll?: number;
32
24
  minAvgRoll?: number;
33
25
  maxAvgRoll?: number;
@@ -11,15 +11,7 @@ export interface Props {
11
11
  hasReadout?: boolean;
12
12
  /** Colour palette for the scale fill / indicator and the readout value: `regular` (default) or `enhanced`. */
13
13
  priority?: Priority;
14
- /** Half-extent of the watch arc in degrees. The arc spans `centre ± arcAngle`
15
- and values are placed at their true position within it. Default `45`
16
- reproduces the historical 90°-wide arc.
17
-
18
- Smaller values render a narrower arc. Combined with `zoomToFitArc`, the
19
- narrower arc is enlarged (its radius grows) on its own layer, while the
20
- vessel image and the rotating indicator line stay at their natural size and
21
- position on a separate central layer. The two layers are intentionally
22
- visually disconnected. */
14
+ /** Half-extent of the watch arc in degrees: the arc spans `centre ± arcAngle` and values sit at their true position within it, so `45` gives the historical 90°-wide arc. With `zoomToFitArc`, a narrower arc is enlarged on its own layer while the vessel image and the indicator line keep their natural size on a separate central layer — the two layers are deliberately disconnected. */
23
15
  arcAngle?: number;
24
16
  roll?: number;
25
17
  minAvgRoll?: number;
@@ -10,12 +10,8 @@
10
10
  class?: string;
11
11
  style?: string;
12
12
  type?: RotIndicatorType;
13
- /** Measured rate of turn in degrees per minute (positive = starboard).
14
-
15
- Drives the spinner animation via `(rateOfTurnDegreesPerMinute / 360) *
16
- rotDotAnimationFactor` rotations per minute. When `undefined` the legacy
17
- `rotationsPerMinute` value is used instead. */
18
- rateOfTurnDegreesPerMinute?: number | undefined;
13
+ /** Measured rate of turn in degrees per minute (positive = clockwise). Drives the spinner animation via `(rateOfTurnDegreesPerMinute / 360) * rotDotAnimationFactor` rotations per minute. When `undefined` the legacy `rotationsPerMinute` value is used instead. */
14
+ rateOfTurnDegreesPerMinute?: number | undefined;
19
15
  /** Visual amplification applied to the spinning dot animation. Default `18` keeps the legacy visual feel (≈1 rpm at 20°/min). Has no effect when the legacy `rotationsPerMinute` API is used. */
20
16
  rotDotAnimationFactor?: number;
21
17
  rotationsPerMinute?: number
@@ -5,11 +5,7 @@ export interface Props {
5
5
  class?: string;
6
6
  style?: string;
7
7
  type?: RotIndicatorType;
8
- /** Measured rate of turn in degrees per minute (positive = starboard).
9
-
10
- Drives the spinner animation via `(rateOfTurnDegreesPerMinute / 360) *
11
- rotDotAnimationFactor` rotations per minute. When `undefined` the legacy
12
- `rotationsPerMinute` value is used instead. */
8
+ /** Measured rate of turn in degrees per minute (positive = clockwise). Drives the spinner animation via `(rateOfTurnDegreesPerMinute / 360) * rotDotAnimationFactor` rotations per minute. When `undefined` the legacy `rotationsPerMinute` value is used instead. */
13
9
  rateOfTurnDegreesPerMinute?: number | undefined;
14
10
  /** Visual amplification applied to the spinning dot animation. Default `18` keeps the legacy visual feel (≈1 rpm at 20°/min). Has no effect when the legacy `rotationsPerMinute` API is used. */
15
11
  rotDotAnimationFactor?: number;
@@ -37,32 +37,28 @@ animateSetpoint?: boolean;
37
37
  value?: number;
38
38
  maxValue?: number;
39
39
  showLabels?: boolean;
40
- /** Whether to render tickmarks inside the ring. */
41
- tickmarksInside?: boolean;
42
- /** Interval for primary tickmarks in value units.
43
- When undefined or <= 0, no primary tickmarks are shown. */
44
- primaryTickmarkInterval?: number | undefined;
45
- /** Interval for secondary tickmarks in value units.
46
- When undefined or <= 0, no secondary tickmarks are shown. */
47
- secondaryTickmarkInterval?: number | undefined;
48
- /** Interval for tertiary tickmarks in value units.
49
- When undefined or <= 0, no tertiary tickmarks are shown. */
50
- tertiaryTickmarkInterval?: number | undefined;
40
+ /** Whether to render tickmarks inside the ring. */
41
+ tickmarksInside?: boolean;
42
+ /** Interval for primary tickmarks in value units. When undefined or <= 0, no primary tickmarks are shown. */
43
+ primaryTickmarkInterval?: number | undefined;
44
+ /** Interval for secondary tickmarks in value units. When undefined or <= 0, no secondary tickmarks are shown. */
45
+ secondaryTickmarkInterval?: number | undefined;
46
+ /** Interval for tertiary tickmarks in value units. When undefined or <= 0, no tertiary tickmarks are shown. */
47
+ tertiaryTickmarkInterval?: number | undefined;
51
48
  priority?: Priority;
52
49
  portStarboard?: boolean;
53
50
  tickmarkStyle?: TickmarkStyle;
54
51
  advices?: GaugeRadialAdvice[];
55
52
  zoomToFitArc?: boolean;
56
53
  rotArcExtent?: number;
57
- /** When `true`, shows a centered `<obc-readout>` (label `ROT`, unit `DEG/min`)
58
- under the arc with the current rate-of-turn value. Default `false`. */
59
- hasReadout?: boolean;
60
- /** Readout label. Default `ROT`. */
61
- label?: string;
62
- /** Readout unit. Default `DEG/min`. */
63
- unit?: string;
64
- /** Number of fraction digits shown in the readout. Default `0`. */
65
- fractionDigits?: number
54
+ /** When `true`, shows a centered `<obc-readout>` (label `ROT`, unit `DEG/min`) under the arc with the current rate-of-turn value. Default `false`. */
55
+ hasReadout?: boolean;
56
+ /** Readout label. Default `ROT`. */
57
+ label?: string;
58
+ /** Readout unit. Default `DEG/min`. */
59
+ unit?: string;
60
+ /** Number of fraction digits shown in the readout. Default `0`. */
61
+ fractionDigits?: number
66
62
  }
67
63
  export interface Events {
68
64
 
@@ -32,14 +32,11 @@ regardless of instrument state. */
32
32
  showLabels?: boolean;
33
33
  /** Whether to render tickmarks inside the ring. */
34
34
  tickmarksInside?: boolean;
35
- /** Interval for primary tickmarks in value units.
36
- When undefined or <= 0, no primary tickmarks are shown. */
35
+ /** Interval for primary tickmarks in value units. When undefined or <= 0, no primary tickmarks are shown. */
37
36
  primaryTickmarkInterval?: number | undefined;
38
- /** Interval for secondary tickmarks in value units.
39
- When undefined or <= 0, no secondary tickmarks are shown. */
37
+ /** Interval for secondary tickmarks in value units. When undefined or <= 0, no secondary tickmarks are shown. */
40
38
  secondaryTickmarkInterval?: number | undefined;
41
- /** Interval for tertiary tickmarks in value units.
42
- When undefined or <= 0, no tertiary tickmarks are shown. */
39
+ /** Interval for tertiary tickmarks in value units. When undefined or <= 0, no tertiary tickmarks are shown. */
43
40
  tertiaryTickmarkInterval?: number | undefined;
44
41
  priority?: Priority;
45
42
  portStarboard?: boolean;
@@ -47,8 +44,7 @@ When undefined or <= 0, no tertiary tickmarks are shown. */
47
44
  advices?: GaugeRadialAdvice[];
48
45
  zoomToFitArc?: boolean;
49
46
  rotArcExtent?: number;
50
- /** When `true`, shows a centered `<obc-readout>` (label `ROT`, unit `DEG/min`)
51
- under the arc with the current rate-of-turn value. Default `false`. */
47
+ /** When `true`, shows a centered `<obc-readout>` (label `ROT`, unit `DEG/min`) under the arc with the current rate-of-turn value. Default `false`. */
52
48
  hasReadout?: boolean;
53
49
  /** Readout label. Default `ROT`. */
54
50
  label?: string;
@@ -38,30 +38,24 @@ animateSetpoint?: boolean;
38
38
  maxSpeed?: number;
39
39
  minSpeed?: number;
40
40
  showLabels?: boolean;
41
- /** Whether to render tickmarks inside the ring. */
42
- tickmarksInside?: boolean;
43
- /** Interval for tickmarks in speed units.
44
- When undefined or <= 0, no tickmarks are shown (only the zero mark). */
45
- tickmarkInterval?: number | undefined;
41
+ /** Whether to render tickmarks inside the ring. */
42
+ tickmarksInside?: boolean;
43
+ /** Interval for tickmarks in speed units. When undefined or <= 0, no tickmarks are shown (only the zero mark). */
44
+ tickmarkInterval?: number | undefined;
46
45
  priority?: Priority;
47
46
  needleType?: ObcSpeedGaugeNeedleType;
48
47
  speedAdvices?: SpeedAdvice[];
49
48
  tickmarkStyle?: TickmarkStyle;
50
- /** When `true`, shows a centered `<obc-readout>` (label `STW`, unit `KN`)
51
- below the gauge with the current speed. Default `false`. */
52
- hasReadout?: boolean;
53
- /** Readout label. Default `STW`. */
54
- label?: string;
55
- /** Readout unit. Default `KN`. */
56
- unit?: string;
57
- /** Number of fraction digits shown in the readout. Default `1`. */
58
- fractionDigits?: number;
59
- /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a
60
- fixed intrinsic size derived from the ring, arc shape and label reserve —
61
- so instruments sharing the same value have identical ring circumference
62
- regardless of label width or arc extent (like obc-donut-chart's
63
- fixedHeight). When unset (default), the instrument fills its container. */
64
- faceDiameter?: number | undefined
49
+ /** When `true`, shows a centered `<obc-readout>` (label `STW`, unit `KN`) below the gauge with the current speed. Default `false`. */
50
+ hasReadout?: boolean;
51
+ /** Readout label. Default `STW`. */
52
+ label?: string;
53
+ /** Readout unit. Default `KN`. */
54
+ unit?: string;
55
+ /** Number of fraction digits shown in the readout. Default `1`. */
56
+ fractionDigits?: number;
57
+ /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a fixed intrinsic size derived from the ring, arc shape and label reserve — so instruments sharing the same value have identical ring circumference regardless of label width or arc extent (like obc-donut-chart's fixedHeight). When unset (default), the instrument fills its container. */
58
+ faceDiameter?: number | undefined
65
59
  }
66
60
  export interface Events {
67
61
 
@@ -33,15 +33,13 @@ regardless of instrument state. */
33
33
  showLabels?: boolean;
34
34
  /** Whether to render tickmarks inside the ring. */
35
35
  tickmarksInside?: boolean;
36
- /** Interval for tickmarks in speed units.
37
- When undefined or <= 0, no tickmarks are shown (only the zero mark). */
36
+ /** Interval for tickmarks in speed units. When undefined or <= 0, no tickmarks are shown (only the zero mark). */
38
37
  tickmarkInterval?: number | undefined;
39
38
  priority?: Priority;
40
39
  needleType?: ObcSpeedGaugeNeedleType;
41
40
  speedAdvices?: SpeedAdvice[];
42
41
  tickmarkStyle?: TickmarkStyle;
43
- /** When `true`, shows a centered `<obc-readout>` (label `STW`, unit `KN`)
44
- below the gauge with the current speed. Default `false`. */
42
+ /** When `true`, shows a centered `<obc-readout>` (label `STW`, unit `KN`) below the gauge with the current speed. Default `false`. */
45
43
  hasReadout?: boolean;
46
44
  /** Readout label. Default `STW`. */
47
45
  label?: string;
@@ -49,11 +47,7 @@ below the gauge with the current speed. Default `false`. */
49
47
  unit?: string;
50
48
  /** Number of fraction digits shown in the readout. Default `1`. */
51
49
  fractionDigits?: number;
52
- /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a
53
- fixed intrinsic size derived from the ring, arc shape and label reserve —
54
- so instruments sharing the same value have identical ring circumference
55
- regardless of label width or arc extent (like obc-donut-chart's
56
- fixedHeight). When unset (default), the instrument fills its container. */
50
+ /** Outer-ring diameter in CSS pixels. When set, the instrument renders at a fixed intrinsic size derived from the ring, arc shape and label reserve — so instruments sharing the same value have identical ring circumference regardless of label width or arc extent (like obc-donut-chart's fixedHeight). When unset (default), the instrument fills its container. */
57
51
  faceDiameter?: number | undefined;
58
52
  }
59
53
  export interface Events {
@@ -12,28 +12,12 @@
12
12
  type?: WindIndicatorType;
13
13
  direction?: WindIndicatorDirection;
14
14
  priority?: WindIndicatorPriority;
15
- /** Wind speed in **knots**, used to pick the wind-barb icon.
16
-
17
- The value is snapped to the nearest authored knots bucket in the
18
- Figma icon set: `<obi-wind-true-N>` for the arrow / labeled
19
- variants and the higher-granularity `<obi-wind-shaft-N>` family
20
- for the shaft variant. Sub-pennant calm (`0`) and shaft-only (`1`)
21
- buckets cover the lowest two ranges; thereafter the buckets follow
22
- 5-knot steps up to the heaviest authored icon, with values beyond
23
- that snapping to it. Non-finite or negative values fall back to
24
- calm. */
25
- currentWindSpeedKnots?: number;
26
- /** Rotation of the reference frame (course/heading) in degrees.
27
-
28
- This could be the heading or the course of the vessel.
29
- `0` means north-up. */
30
- rotationAngle?: number;
31
- /** Primary wind direction input (wind-from).
32
-
33
- Represents the direction the wind comes **from** in degrees.
34
- - `0` / `360`: wind from north → marker points south (down)
35
- - `180`: wind from south → marker points north (up) */
36
- currentWindFromDirection?: number;
15
+ /** Wind speed in knots, snapped to the nearest authored bucket of the wind-barb icon set — `<obi-wind-true-N>` for the arrow and labeled variants, the finer `<obi-wind-shaft-N>` family for the shaft variant. Calm (`0`) and shaft-only (`1`) cover the lowest two ranges and 5-knot steps follow up to the heaviest icon; anything beyond it snaps to that icon, and a non-finite or negative value falls back to calm. */
16
+ currentWindSpeedKnots?: number;
17
+ /** Rotation of the reference frame (course/heading) in degrees. This could be the heading or the course of the vessel. `0` means north-up. */
18
+ rotationAngle?: number;
19
+ /** Direction the wind comes from, in degrees: `0` or `360` is wind from the north, so the marker points down, and `180` is wind from the south, so it points up. */
20
+ currentWindFromDirection?: number;
37
21
  windFromAngle?: number;
38
22
  angle?: number
39
23
  }
@@ -7,27 +7,11 @@ export interface Props {
7
7
  type?: WindIndicatorType;
8
8
  direction?: WindIndicatorDirection;
9
9
  priority?: WindIndicatorPriority;
10
- /** Wind speed in **knots**, used to pick the wind-barb icon.
11
-
12
- The value is snapped to the nearest authored knots bucket in the
13
- Figma icon set: `<obi-wind-true-N>` for the arrow / labeled
14
- variants and the higher-granularity `<obi-wind-shaft-N>` family
15
- for the shaft variant. Sub-pennant calm (`0`) and shaft-only (`1`)
16
- buckets cover the lowest two ranges; thereafter the buckets follow
17
- 5-knot steps up to the heaviest authored icon, with values beyond
18
- that snapping to it. Non-finite or negative values fall back to
19
- calm. */
10
+ /** Wind speed in knots, snapped to the nearest authored bucket of the wind-barb icon set — `<obi-wind-true-N>` for the arrow and labeled variants, the finer `<obi-wind-shaft-N>` family for the shaft variant. Calm (`0`) and shaft-only (`1`) cover the lowest two ranges and 5-knot steps follow up to the heaviest icon; anything beyond it snaps to that icon, and a non-finite or negative value falls back to calm. */
20
11
  currentWindSpeedKnots?: number;
21
- /** Rotation of the reference frame (course/heading) in degrees.
22
-
23
- This could be the heading or the course of the vessel.
24
- `0` means north-up. */
12
+ /** Rotation of the reference frame (course/heading) in degrees. This could be the heading or the course of the vessel. `0` means north-up. */
25
13
  rotationAngle?: number;
26
- /** Primary wind direction input (wind-from).
27
-
28
- Represents the direction the wind comes **from** in degrees.
29
- - `0` / `360`: wind from north → marker points south (down)
30
- - `180`: wind from south → marker points north (up) */
14
+ /** Direction the wind comes from, in degrees: `0` or `360` is wind from the north, so the marker points down, and `180` is wind from the south, so it points up. */
31
15
  currentWindFromDirection?: number;
32
16
  windFromAngle?: number;
33
17
  angle?: number;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@oicl/openbridge-webcomponents-svelte",
3
- "version": "2.0.0-next.159",
3
+ "version": "2.0.0-next.160",
4
4
  "scripts": {
5
5
  "dev": "vite dev",
6
6
  "build": "vite build && npm run prepack",
@@ -34,7 +34,7 @@
34
34
  }
35
35
  },
36
36
  "dependencies": {
37
- "@oicl/openbridge-webcomponents": "^2.0.0-next.159"
37
+ "@oicl/openbridge-webcomponents": "^2.0.0-next.160"
38
38
  },
39
39
  "peerDependencies": {
40
40
  "svelte": "^5.0.0"