@oicl/openbridge-webcomponents-svelte 2.0.0-next.100 → 2.0.0-next.102

package/dist/bars-graphs/donut-chart/ObcDonutChart.svelte

@@ -11,22 +11,37 @@ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-inst
       export interface Props {
      class?: string;
      style?: string;
-     data?: DonutChartDataItem[];
-     colors?: string[];
+      /** Chart data segments (set via JavaScript) */
+data?: DonutChartDataItem[];
+      /** Custom segment colors (set via JavaScript) with fallback to theme palette */
+colors?: string[];
      priority?: Priority;
-     half?: boolean;
-     showOuterLabels?: boolean;
-     showUnit?: boolean;
-     outerLabelUnit?: string;
-     outerLabelMaxLength?: number;
-     outerLabelDecimalPlaces?: number;
-     centerReadoutLabel?: string;
-     centerReadoutUnit?: string;
-     max?: number;
-     thickness?: number;
-     legend?: boolean;
-     showDebugOverlay?: boolean;
-     fixedHeight?: number
+      /** Whether to display as half-circle (180°) or full circle (360°), default: false */
+half?: boolean;
+      /** Show outer labels, default: false */
+showOuterLabels?: boolean;
+      /** Whether to show unit in labels, default: false */
+showUnit?: boolean;
+      /** Unit string to append to outer labels, default: "%" */
+outerLabelUnit?: string;
+      /** Maximum character length for labels before trim (0 = no limit), default: 0 */
+outerLabelMaxLength?: number;
+      /** Number of decimal places in labels, default: 0 */
+outerLabelDecimalPlaces?: number;
+      /** Text label shown below the center total value, default: "Total" */
+centerReadoutLabel?: string;
+      /** Unit string shown inline after the label in the center readout, default: "%" */
+centerReadoutUnit?: string;
+      /** Maximum value for calculating remaining empty sector, default: 100 */
+max?: number;
+      /** Donut ring thickness in pixels, default: 24 */
+thickness?: number;
+      /** Whether to display the legend below the chart, default: false */
+legend?: boolean;
+      /** Show debug overlay for development, default: false */
+showDebugOverlay?: boolean;
+      /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
+fixedHeight?: number
    }
       export interface Events {
     

package/dist/bars-graphs/donut-chart/ObcDonutChart.svelte.d.ts

@@ -5,21 +5,36 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Chart data segments (set via JavaScript) */
     data?: DonutChartDataItem[];
+    /** Custom segment colors (set via JavaScript) with fallback to theme palette */
     colors?: string[];
     priority?: Priority;
+    /** Whether to display as half-circle (180°) or full circle (360°), default: false */
     half?: boolean;
+    /** Show outer labels, default: false */
     showOuterLabels?: boolean;
+    /** Whether to show unit in labels, default: false */
     showUnit?: boolean;
+    /** Unit string to append to outer labels, default: "%" */
     outerLabelUnit?: string;
+    /** Maximum character length for labels before trim (0 = no limit), default: 0 */
     outerLabelMaxLength?: number;
+    /** Number of decimal places in labels, default: 0 */
     outerLabelDecimalPlaces?: number;
+    /** Text label shown below the center total value, default: "Total" */
     centerReadoutLabel?: string;
+    /** Unit string shown inline after the label in the center readout, default: "%" */
     centerReadoutUnit?: string;
+    /** Maximum value for calculating remaining empty sector, default: 100 */
     max?: number;
+    /** Donut ring thickness in pixels, default: 24 */
     thickness?: number;
+    /** Whether to display the legend below the chart, default: false */
     legend?: boolean;
+    /** Show debug overlay for development, default: false */
     showDebugOverlay?: boolean;
+    /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
     fixedHeight?: number;
 }
 export interface Events {

package/dist/bars-graphs/pie-chart/ObcPieChart.svelte

@@ -11,18 +11,29 @@ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-inst
       export interface Props {
      class?: string;
      style?: string;
-     data?: PieChartDataItem[];
-     colors?: string[];
+      /** Chart data segments with optional children subsegments for sunburst mode (set via JavaScript). */
+data?: PieChartDataItem[];
+      /** Custom segment colors (set via JavaScript) with fallback to theme palette */
+colors?: string[];
      priority?: Priority;
-     showOuterLabels?: boolean;
-     showUnit?: boolean;
-     sunburst?: boolean;
-     outerLabelUnit?: string;
-     outerLabelMaxLength?: number;
-     outerLabelDecimalPlaces?: number;
-     legend?: boolean;
-     showDebugOverlay?: boolean;
-     fixedHeight?: number
+      /** Show outer labels, default: false */
+showOuterLabels?: boolean;
+      /** Whether to show unit in labels, default: false */
+showUnit?: boolean;
+      /** Enable sunburst mode with interactive children subsegments, default: false */
+sunburst?: boolean;
+      /** Unit string to append to outer labels, default: "%" */
+outerLabelUnit?: string;
+      /** Maximum character length for labels before trim (0 = no limit), default: 0 */
+outerLabelMaxLength?: number;
+      /** Number of decimal places in labels, default: 0 */
+outerLabelDecimalPlaces?: number;
+      /** Whether to display the legend below the chart, default: false */
+legend?: boolean;
+      /** Show debug overlay for development, default: false */
+showDebugOverlay?: boolean;
+      /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
+fixedHeight?: number
    }
       export interface Events {
     

package/dist/bars-graphs/pie-chart/ObcPieChart.svelte.d.ts

@@ -5,17 +5,28 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Chart data segments with optional children subsegments for sunburst mode (set via JavaScript). */
     data?: PieChartDataItem[];
+    /** Custom segment colors (set via JavaScript) with fallback to theme palette */
     colors?: string[];
     priority?: Priority;
+    /** Show outer labels, default: false */
     showOuterLabels?: boolean;
+    /** Whether to show unit in labels, default: false */
     showUnit?: boolean;
+    /** Enable sunburst mode with interactive children subsegments, default: false */
     sunburst?: boolean;
+    /** Unit string to append to outer labels, default: "%" */
     outerLabelUnit?: string;
+    /** Maximum character length for labels before trim (0 = no limit), default: 0 */
     outerLabelMaxLength?: number;
+    /** Number of decimal places in labels, default: 0 */
     outerLabelDecimalPlaces?: number;
+    /** Whether to display the legend below the chart, default: false */
     legend?: boolean;
+    /** Show debug overlay for development, default: false */
     showDebugOverlay?: boolean;
+    /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
     fixedHeight?: number;
 }
 export interface Events {

package/dist/bars-graphs/polar-chart/ObcPolarChart.svelte

@@ -11,20 +11,33 @@ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-inst
       export interface Props {
      class?: string;
      style?: string;
-     data?: PolarChartDataItem[];
-     colors?: string[];
+      /** Chart data segments (set via JavaScript) */
+data?: PolarChartDataItem[];
+      /** Custom segment colors (set via JavaScript) with fallback to theme palette */
+colors?: string[];
      priority?: Priority;
-     monochrome?: boolean;
-     discreteColorStops?: boolean;
-     showSectorLabels?: boolean;
-     showUnit?: boolean;
-     showOuterLabels?: boolean;
-     outerLabelUnit?: string;
-     outerLabelMaxLength?: number;
-     outerLabelDecimalPlaces?: number;
-     fixedHeight?: number;
-     legend?: boolean;
-     showDebugOverlay?: boolean
+      /** Use single color for all sectors (uses first color from array, default: false) */
+monochrome?: boolean;
+      /** Draw sectors as radial color bands from center outward using the colors array as threshold steps (default: false) */
+discreteColorStops?: boolean;
+      /** When true, display sector labels from data (e.g. "Sector A"). When false, display angle values (0°, 30°, etc.). Default: false */
+showSectorLabels?: boolean;
+      /** Whether to show unit in angle or outer labels, default: false */
+showUnit?: boolean;
+      /** Show outer labels, default: false */
+showOuterLabels?: boolean;
+      /** Unit string to append to outer labels, default: "°" */
+outerLabelUnit?: string;
+      /** Maximum character length for labels before trim (0 = no limit), default: 0 */
+outerLabelMaxLength?: number;
+      /** Number of decimal places in labels, default: 0 */
+outerLabelDecimalPlaces?: number;
+      /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
+fixedHeight?: number;
+      /** Whether to display the legend below the chart, default: false */
+legend?: boolean;
+      /** Show debug overlay for development, default: false */
+showDebugOverlay?: boolean
    }
       export interface Events {
     

package/dist/bars-graphs/polar-chart/ObcPolarChart.svelte.d.ts

@@ -5,19 +5,32 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Chart data segments (set via JavaScript) */
     data?: PolarChartDataItem[];
+    /** Custom segment colors (set via JavaScript) with fallback to theme palette */
     colors?: string[];
     priority?: Priority;
+    /** Use single color for all sectors (uses first color from array, default: false) */
     monochrome?: boolean;
+    /** Draw sectors as radial color bands from center outward using the colors array as threshold steps (default: false) */
     discreteColorStops?: boolean;
+    /** When true, display sector labels from data (e.g. "Sector A"). When false, display angle values (0°, 30°, etc.). Default: false */
     showSectorLabels?: boolean;
+    /** Whether to show unit in angle or outer labels, default: false */
     showUnit?: boolean;
+    /** Show outer labels, default: false */
     showOuterLabels?: boolean;
+    /** Unit string to append to outer labels, default: "°" */
     outerLabelUnit?: string;
+    /** Maximum character length for labels before trim (0 = no limit), default: 0 */
     outerLabelMaxLength?: number;
+    /** Number of decimal places in labels, default: 0 */
     outerLabelDecimalPlaces?: number;
+    /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
     fixedHeight?: number;
+    /** Whether to display the legend below the chart, default: false */
     legend?: boolean;
+    /** Show debug overlay for development, default: false */
     showDebugOverlay?: boolean;
 }
 export interface Events {

package/dist/bars-graphs/radial-bar-chart/ObcRadialBarChart.svelte

@@ -9,15 +9,23 @@
       export interface Props {
      class?: string;
      style?: string;
-     data?: number[];
-     colors?: string[];
+      /** Array of values for each ring (set via JavaScript) */
+data?: number[];
+      /** Custom ring colors (set via JavaScript) with fallback to theme palette */
+colors?: string[];
      priority?: Priority;
-     max?: number;
-     circumference?: number;
-     legend?: boolean;
-     showDebugOverlay?: boolean;
-     fixedHeight?: number;
-     minRingThickness?: number
+      /** Maximum value for calculating remaining empty area, default: 100 */
+max?: number;
+      /** Arc span in degrees: 360 for full circle, 270 for 3/4 circle, default: 270 */
+circumference?: number;
+      /** Whether to display the legend below the chart, default: false */
+legend?: boolean;
+      /** Show debug overlay for development, default: false */
+showDebugOverlay?: boolean;
+      /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
+fixedHeight?: number;
+      /** Minimum thickness of each ring in pixels, excluding borders, default: 16 */
+minRingThickness?: number
    }
       export interface Events {
     

package/dist/bars-graphs/radial-bar-chart/ObcRadialBarChart.svelte.d.ts

@@ -4,14 +4,22 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Array of values for each ring (set via JavaScript) */
     data?: number[];
+    /** Custom ring colors (set via JavaScript) with fallback to theme palette */
     colors?: string[];
     priority?: Priority;
+    /** Maximum value for calculating remaining empty area, default: 100 */
     max?: number;
+    /** Arc span in degrees: 360 for full circle, 270 for 3/4 circle, default: 270 */
     circumference?: number;
+    /** Whether to display the legend below the chart, default: false */
     legend?: boolean;
+    /** Show debug overlay for development, default: false */
     showDebugOverlay?: boolean;
+    /** Fixed height of the chart in pixels (determines chart circumference), default: 320. The chart's circumference is always based on this fixed height to match other radial instruments. */
     fixedHeight?: number;
+    /** Minimum thickness of each ring in pixels, excluding borders, default: 16 */
     minRingThickness?: number;
 }
 export interface Events {

package/dist/integration-systems/integration-bar/ObcIntegrationBar.svelte

@@ -9,26 +9,46 @@
       export interface Props {
      class?: string;
      style?: string;
-     hideHomeButton?: boolean;
-     showClock?: boolean;
-     showLinkButton?: boolean;
-     linkButtonActivated?: boolean;
-     showUserButton?: boolean;
-     userButtonActivated?: boolean;
-     showDimmingButton?: boolean;
-     dimmingButtonActivated?: boolean;
-     showSystemButton?: boolean;
-     systemButtonActivated?: boolean;
-     showScreenButton?: boolean;
-     screenButtonActivated?: boolean;
-     showNotificationButton?: boolean;
-     notificationButtonActivated?: boolean;
-     showAlertButton?: boolean;
-     alertButtonActivated?: boolean;
-     showFleetButton?: boolean;
-     fleetButtonSelected?: boolean;
-     fleetButtonActivated?: boolean;
-     fleetButtonLabel?: string
+      /** Hides the home button when true */
+hideHomeButton?: boolean;
+      /** Toggles rendering of the clock slot */
+showClock?: boolean;
+      /** Toggles visibility of link button */
+showLinkButton?: boolean;
+      /** Activated state of link button */
+linkButtonActivated?: boolean;
+      /** Toggles visibility of user button */
+showUserButton?: boolean;
+      /** Activated state of user button */
+userButtonActivated?: boolean;
+      /** Toggles visibility of dimming button */
+showDimmingButton?: boolean;
+      /** Activated state of dimming button */
+dimmingButtonActivated?: boolean;
+      /** Toggles visibility of system button */
+showSystemButton?: boolean;
+      /** Activated state of system button */
+systemButtonActivated?: boolean;
+      /** Toggles visibility of screen button */
+showScreenButton?: boolean;
+      /** Activated state of screen button */
+screenButtonActivated?: boolean;
+      /** Toggles visibility of notification button */
+showNotificationButton?: boolean;
+      /** Activated state of notification button */
+notificationButtonActivated?: boolean;
+      /** Toggles visibility of alert button */
+showAlertButton?: boolean;
+      /** Activated state of alert button */
+alertButtonActivated?: boolean;
+      /** Toggles visibility of fleet button */
+showFleetButton?: boolean;
+      /** Selected state of fleet button */
+fleetButtonSelected?: boolean;
+      /** Active state of fleet button while selection is pending */
+fleetButtonActivated?: boolean;
+      /** Label for the fleet button */
+fleetButtonLabel?: string
    }
       export interface Events {
     onFleetButtonClick?: (event: CustomEvent<unknown>) => void;

package/dist/integration-systems/integration-bar/ObcIntegrationBar.svelte.d.ts

@@ -3,25 +3,45 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Hides the home button when true */
     hideHomeButton?: boolean;
+    /** Toggles rendering of the clock slot */
     showClock?: boolean;
+    /** Toggles visibility of link button */
     showLinkButton?: boolean;
+    /** Activated state of link button */
     linkButtonActivated?: boolean;
+    /** Toggles visibility of user button */
     showUserButton?: boolean;
+    /** Activated state of user button */
     userButtonActivated?: boolean;
+    /** Toggles visibility of dimming button */
     showDimmingButton?: boolean;
+    /** Activated state of dimming button */
     dimmingButtonActivated?: boolean;
+    /** Toggles visibility of system button */
     showSystemButton?: boolean;
+    /** Activated state of system button */
     systemButtonActivated?: boolean;
+    /** Toggles visibility of screen button */
     showScreenButton?: boolean;
+    /** Activated state of screen button */
     screenButtonActivated?: boolean;
+    /** Toggles visibility of notification button */
     showNotificationButton?: boolean;
+    /** Activated state of notification button */
     notificationButtonActivated?: boolean;
+    /** Toggles visibility of alert button */
     showAlertButton?: boolean;
+    /** Activated state of alert button */
     alertButtonActivated?: boolean;
+    /** Toggles visibility of fleet button */
     showFleetButton?: boolean;
+    /** Selected state of fleet button */
     fleetButtonSelected?: boolean;
+    /** Active state of fleet button while selection is pending */
     fleetButtonActivated?: boolean;
+    /** Label for the fleet button */
     fleetButtonLabel?: string;
 }
 export interface Events {

package/dist/integration-systems/integration-button/ObcIntegrationButton.svelte

@@ -9,18 +9,30 @@
       export interface Props {
      class?: string;
      style?: string;
-     hasTrailingIcon?: boolean;
-     hasTrailingIcon2?: boolean;
-     hasLeadingIcon?: boolean;
-     hasStatus?: boolean;
-     readouts?: IntegrationButtonReadout[];
-     disabled?: boolean;
-     activated?: boolean;
-     selected?: boolean;
-     dividerBottom?: boolean;
-     dividerRight?: boolean;
-     variant?: IntegrationButtonVariant;
-     type?: IntegrationButtonType
+      /** Shows the `trailing-icon` slot. */
+hasTrailingIcon?: boolean;
+      /** Shows the `trailing-icon2` slot. */
+hasTrailingIcon2?: boolean;
+      /** Shows the `leading-icon` slot. */
+hasLeadingIcon?: boolean;
+      /** Shows the `status` slot. */
+hasStatus?: boolean;
+      /** List of readout items shown in the rich type. */
+readouts?: IntegrationButtonReadout[];
+      /** Disables the internal button. */
+disabled?: boolean;
+      /** Applies active state styling while a selection is pending. */
+activated?: boolean;
+      /** Applies selected state styling. */
+selected?: boolean;
+      /** Shows a bottom divider under the button. */
+dividerBottom?: boolean;
+      /** Shows a right divider to separate from adjacent buttons. */
+dividerRight?: boolean;
+      /** Visual variant (`normal` or `flat`). */
+variant?: IntegrationButtonVariant;
+      /** Layout type (`hug`, `regular`, or `rich`). */
+type?: IntegrationButtonType
    }
       export interface Events {
     onClick?: (event: CustomEvent<unknown>) => void

package/dist/integration-systems/integration-button/ObcIntegrationButton.svelte.d.ts

@@ -4,17 +4,29 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Shows the `trailing-icon` slot. */
     hasTrailingIcon?: boolean;
+    /** Shows the `trailing-icon2` slot. */
     hasTrailingIcon2?: boolean;
+    /** Shows the `leading-icon` slot. */
     hasLeadingIcon?: boolean;
+    /** Shows the `status` slot. */
     hasStatus?: boolean;
+    /** List of readout items shown in the rich type. */
     readouts?: IntegrationButtonReadout[];
+    /** Disables the internal button. */
     disabled?: boolean;
+    /** Applies active state styling while a selection is pending. */
     activated?: boolean;
+    /** Applies selected state styling. */
     selected?: boolean;
+    /** Shows a bottom divider under the button. */
     dividerBottom?: boolean;
+    /** Shows a right divider to separate from adjacent buttons. */
     dividerRight?: boolean;
+    /** Visual variant (`normal` or `flat`). */
     variant?: IntegrationButtonVariant;
+    /** Layout type (`hug`, `regular`, or `rich`). */
     type?: IntegrationButtonType;
 }
 export interface Events {

package/dist/navigation-instruments/compass/ObcCompass.svelte

@@ -15,23 +15,36 @@ import type {InstrumentState, Priority} from '@oicl/openbridge-webcomponents/dis
       export interface Props {
      class?: string;
      style?: string;
-     heading?: number;
-     courseOverGround?: number;
-     headingSetpoint?: number | null;
+      /** The current heading of the vessel in degrees. */
+heading?: number;
+      /** The current course over ground in degrees. */
+courseOverGround?: number;
+      /** The set point for the heading in degrees. */
+headingSetpoint?: number | null;
      newHeadingSetpoint?: number | undefined;
-     atHeadingSetpoint?: boolean;
+      /** Indicates if the vessel is at the heading set point. */
+atHeadingSetpoint?: boolean;
      headingSetpointAtZeroDeadband?: number;
      headingSetpointOverride?: boolean;
-     autoAtHeadingSetpoint?: boolean;
-     autoAtHeadingSetpointDeadband?: number;
+      /** Enables automatic at heading set point calculation. */
+autoAtHeadingSetpoint?: boolean;
+      /** The deadband for the heading set point in degrees. */
+autoAtHeadingSetpointDeadband?: number;
      animateSetpoint?: boolean;
-     touching?: boolean;
-     headingAdvices?: AngleAdvice[];
-     currentWindSpeedKnots?: number | null;
-     windFromDirection?: number | null;
-     currentSpeed?: number | null;
-     currentFromDirection?: number | null;
-     vesselImage?: VesselImage;
+      /** Indicates if the compass is being touched. */
+touching?: boolean;
+      /** An array of angle advices for the compass. */
+headingAdvices?: AngleAdvice[];
+      /** The wind speed in knots. */
+currentWindSpeedKnots?: number | null;
+      /** The direction the wind is coming from in degrees. */
+windFromDirection?: number | null;
+      /** The current speed, number of arrows. */
+currentSpeed?: number | null;
+      /** The direction the current is coming from in degrees. */
+currentFromDirection?: number | null;
+      /** The image of the vessel. */
+vesselImage?: VesselImage;
       /** Measured rate of turn in degrees per minute (positive = starboard).
 Drives both the bar extent and (after multiplication by
 `rotDotAnimationFactor`) the spinning dot animation.
@@ -41,9 +54,15 @@ rateOfTurnDegreesPerMinute?: number | undefined;
 (not to the bar extent). Default `18` keeps the legacy visual feel
 (≈1 rpm at 20°/min). */
 rotDotAnimationFactor?: number;
-     rotationsPerMinute?: number;
-     rotType?: RotType;
-     rotPosition?: RotPosition;
+      /** Legacy rate-of-turn input, in rotations per minute. When
+`rateOfTurnDegreesPerMinute` is `undefined`, this value is used
+(unconverted) as the fallback ROT, driving both the spinning dot ring
+and the bar extent. */
+rotationsPerMinute?: number;
+      /** ROT display mode: `'dots'` (spinning dots, default) or `'bar'` (a rate-of-turn arc anchored at the current heading, its length proportional to the rate of turn). */
+rotType?: RotType;
+      /** ROT track position: `'innerCircle'` (default) or `'scale'` (on the outer ring). */
+rotPosition?: RotPosition;
       /** Bar-extent reference value in **degrees per minute**. The bar fills the
 full ±`rotArcExtent` arc when the measured ROT equals ±`rotMaxValue`.
 Default `60` aligns with ES-TRIN 2025/1 Art. 3.02.
@@ -57,7 +76,8 @@ rotMaxValue?: number;
      rotAtZeroDeadband?: number;
      direction?: CompassDirection;
      state?: InstrumentState;
-     priority?: Priority;
+      /** Color priority: `Priority.enhanced` uses the blue/enhanced color palette, `Priority.regular` (default) uses the standard palette. */
+priority?: Priority;
      priorityElements?: CompassPriorityElement[];
       /** Show compass NSEW labels and north arrow. */
 showLabels?: boolean;

package/dist/navigation-instruments/compass/ObcCompass.svelte.d.ts

@@ -7,22 +7,35 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** The current heading of the vessel in degrees. */
     heading?: number;
+    /** The current course over ground in degrees. */
     courseOverGround?: number;
+    /** The set point for the heading in degrees. */
     headingSetpoint?: number | null;
     newHeadingSetpoint?: number | undefined;
+    /** Indicates if the vessel is at the heading set point. */
     atHeadingSetpoint?: boolean;
     headingSetpointAtZeroDeadband?: number;
     headingSetpointOverride?: boolean;
+    /** Enables automatic at heading set point calculation. */
     autoAtHeadingSetpoint?: boolean;
+    /** The deadband for the heading set point in degrees. */
     autoAtHeadingSetpointDeadband?: number;
     animateSetpoint?: boolean;
+    /** Indicates if the compass is being touched. */
     touching?: boolean;
+    /** An array of angle advices for the compass. */
     headingAdvices?: AngleAdvice[];
+    /** The wind speed in knots. */
     currentWindSpeedKnots?: number | null;
+    /** The direction the wind is coming from in degrees. */
     windFromDirection?: number | null;
+    /** The current speed, number of arrows. */
     currentSpeed?: number | null;
+    /** The direction the current is coming from in degrees. */
     currentFromDirection?: number | null;
+    /** The image of the vessel. */
     vesselImage?: VesselImage;
     /** Measured rate of turn in degrees per minute (positive = starboard).
 Drives both the bar extent and (after multiplication by
@@ -33,8 +46,14 @@ When `undefined`, falls back to the deprecated `rotationsPerMinute`. */
 (not to the bar extent). Default `18` keeps the legacy visual feel
 (≈1 rpm at 20°/min). */
     rotDotAnimationFactor?: number;
+    /** Legacy rate-of-turn input, in rotations per minute. When
+`rateOfTurnDegreesPerMinute` is `undefined`, this value is used
+(unconverted) as the fallback ROT, driving both the spinning dot ring
+and the bar extent. */
     rotationsPerMinute?: number;
+    /** ROT display mode: `'dots'` (spinning dots, default) or `'bar'` (a rate-of-turn arc anchored at the current heading, its length proportional to the rate of turn). */
     rotType?: RotType;
+    /** ROT track position: `'innerCircle'` (default) or `'scale'` (on the outer ring). */
     rotPosition?: RotPosition;
     /** Bar-extent reference value in **degrees per minute**. The bar fills the
 full ±`rotArcExtent` arc when the measured ROT equals ±`rotMaxValue`.
@@ -49,6 +68,7 @@ the physical ROT API was introduced. */
     rotAtZeroDeadband?: number;
     direction?: CompassDirection;
     state?: InstrumentState;
+    /** Color priority: `Priority.enhanced` uses the blue/enhanced color palette, `Priority.regular` (default) uses the standard palette. */
     priority?: Priority;
     priorityElements?: CompassPriorityElement[];
     /** Show compass NSEW labels and north arrow. */

package/dist/navigation-instruments/compass-flat/ObcCompassFlat.svelte

@@ -14,25 +14,30 @@ import type {RotType} from '@oicl/openbridge-webcomponents/dist/navigation-instr
      class?: string;
      style?: string;
      FOVIndicator?: boolean;
-     heading?: number;
-     courseOverGround?: number;
+      /** Current heading in degrees. */
+heading?: number;
+      /** Current COG in degrees. */
+courseOverGround?: number;
      tickInterval?: number;
      FOV?: number;
      minFOV?: number;
      maxFOV?: number;
      priority?: Priority;
      priorityElements?: CompassFlatPriorityElement[];
-     rotType?: RotType | undefined;
+      /** ROT display mode: `'dots'`, `'bar'`, or `undefined` (hidden). */
+rotType?: RotType | undefined;
       /** Measured rate of turn in degrees per minute (positive = starboard).
 When `undefined`, falls back to the deprecated `rotationsPerMinute`. */
 rateOfTurnDegreesPerMinute?: number | undefined;
       /** Visual amplification applied only to the spinning dot animation. */
 rotDotAnimationFactor?: number;
-     rotationsPerMinute?: number;
+      /** **Deprecated.** Use `rateOfTurnDegreesPerMinute` instead. */
+rotationsPerMinute?: number;
       /** Bar-extent reference value in **degrees per minute**. Default `60`
 per ES-TRIN 2025/1 Art. 3.02. */
 rotMaxValue?: number;
-     rotArcExtent?: number;
+      /** Degrees of bar arc per max-value ROT (default 60). */
+rotArcExtent?: number;
      rotPortStarboard?: boolean;
      rotAtZeroDeadband?: number
    }

package/dist/navigation-instruments/compass-flat/ObcCompassFlat.svelte.d.ts

@@ -7,7 +7,9 @@ export interface Props {
     class?: string;
     style?: string;
     FOVIndicator?: boolean;
+    /** Current heading in degrees. */
     heading?: number;
+    /** Current COG in degrees. */
     courseOverGround?: number;
     tickInterval?: number;
     FOV?: number;
@@ -15,16 +17,19 @@ export interface Props {
     maxFOV?: number;
     priority?: Priority;
     priorityElements?: CompassFlatPriorityElement[];
+    /** ROT display mode: `'dots'`, `'bar'`, or `undefined` (hidden). */
     rotType?: RotType | undefined;
     /** Measured rate of turn in degrees per minute (positive = starboard).
 When `undefined`, falls back to the deprecated `rotationsPerMinute`. */
     rateOfTurnDegreesPerMinute?: number | undefined;
     /** Visual amplification applied only to the spinning dot animation. */
     rotDotAnimationFactor?: number;
+    /** **Deprecated.** Use `rateOfTurnDegreesPerMinute` instead. */
     rotationsPerMinute?: number;
     /** Bar-extent reference value in **degrees per minute**. Default `60`
 per ES-TRIN 2025/1 Art. 3.02. */
     rotMaxValue?: number;
+    /** Degrees of bar arc per max-value ROT (default 60). */
     rotArcExtent?: number;
     rotPortStarboard?: boolean;
     rotAtZeroDeadband?: number;

package/dist/navigation-instruments/graph-mini/ObcGraphMini.svelte

@@ -9,7 +9,8 @@
       export interface Props {
      class?: string;
      style?: string;
-     data?: [number[], number[]];
+      /** The data to display in the graph, first array is the x values, second array is the y values */
+data?: [number[], number[]];
      minY?: number | undefined;
      maxY?: number | undefined
    }

package/dist/navigation-instruments/graph-mini/ObcGraphMini.svelte.d.ts

@@ -3,6 +3,7 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** The data to display in the graph, first array is the x values, second array is the y values */
     data?: [number[], number[]];
     minY?: number | undefined;
     maxY?: number | undefined;

package/dist/navigation-instruments/indicator-graph/ObcIndicatorGraph.svelte

@@ -9,7 +9,8 @@
       export interface Props {
      class?: string;
      style?: string;
-     data?: [number[], number[]];
+      /** The data to display in the graph, first array is the x values, second array is the y values */
+data?: [number[], number[]];
      layout?: ObcIndicatorGraphLayout
    }
       export interface Events {

package/dist/navigation-instruments/indicator-graph/ObcIndicatorGraph.svelte.d.ts

@@ -4,6 +4,7 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** The data to display in the graph, first array is the x values, second array is the y values */
     data?: [number[], number[]];
     layout?: ObcIndicatorGraphLayout;
 }

package/dist/navigation-instruments/watch/ObcWatch.svelte

@@ -19,16 +19,23 @@ import type {RotType, RotPosition} from '@oicl/openbridge-webcomponents/dist/nav
       export interface Props {
      class?: string;
      style?: string;
-     state?: InstrumentState;
-     priority?: Priority;
+      /** Instrument state (active, loading, off) */
+state?: InstrumentState;
+      /** Color priority (enhanced = blue palette, regular = gray palette) */
+priority?: Priority;
      watchCircleType?: WatchCircleType;
      northArrow?: boolean;
      northArrowInside?: boolean | undefined;
-     angleSetpoint?: number | undefined;
-     newAngleSetpoint?: number | undefined;
-     atAngleSetpoint?: boolean;
-     angleSetpointAtZeroDeadband?: number;
-     setpointOverride?: boolean;
+      /** Setpoint angle in degrees (0° = 12 o'clock) */
+angleSetpoint?: number | undefined;
+      /** New setpoint being adjusted (focus mode) */
+newAngleSetpoint?: number | undefined;
+      /** Whether value matches setpoint (within deadband) */
+atAngleSetpoint?: boolean;
+      /** Deadband for zero detection (default 0.5°) */
+angleSetpointAtZeroDeadband?: number;
+      /** Override to derive setpoint color from priority regardless of state */
+setpointOverride?: boolean;
      touching?: boolean;
      animateSetpoint?: boolean;
      padding?: number | undefined;
@@ -67,17 +74,25 @@ endLabelsMaxMin?: boolean;
      scaleWindIcon?: number;
      rotation?: number | undefined;
      zoomToFitArc?: boolean;
-     arcFrame?: ZoomToFitArcFrame | undefined;
+      /** Pre-computed zoom-to-fit arc frame. When set, the watch skips its own `computeZoomToFitArcFrame()` call and uses these values directly. Consumer instruments (e.g. rudder, instrument-radial) should compute the frame once and pass it here to avoid redundant computation. If you pass `arcFrame`, you own keeping it in sync with `areas` / `watchCircleType` — obc-watch will NOT recompute it, so a stale frame renders stale geometry. */
+arcFrame?: ZoomToFitArcFrame | undefined;
      tickFadeAngle?: number;
-     rotType?: RotType | undefined;
-     rotPosition?: RotPosition;
-     rotStartAngle?: number;
-     rotEndAngle?: number;
-     rotPriority?: Priority | undefined;
+      /** ROT visualization type: `'dots'` (spinning dots) or `'bar'` (arc bar with clipped dots). Undefined hides the ROT layer. */
+rotType?: RotType | undefined;
+      /** Track on which ROT elements are placed: `'scale'` (on the outer ring) or `'innerCircle'` (default, inside the inner ring) */
+rotPosition?: RotPosition;
+      /** Start angle of the ROT bar arc in degrees (0° = 12 o'clock, clockwise). Only used when `rotType` is `'bar'`. */
+rotStartAngle?: number;
+      /** End angle of the ROT bar arc in degrees. The bar is hidden when the difference from `rotStartAngle` is less than 0.1°. */
+rotEndAngle?: number;
+      /** Override priority for ROT color derivation. When set, ROT colors use this instead of the main `priority`. Useful when the ROT element has independent priority (e.g. compass per-element priority). */
+rotPriority?: Priority | undefined;
      rotPortStarboard?: boolean;
      rotAtZeroDeadband?: number;
-     rateOfTurnDegreesPerMinute?: number | undefined;
-     rotDotAnimationFactor?: number
+      /** Measured rate of turn in degrees per minute (the maritime/AIS convention, see ES-TRIN 2025/1 Art. 3.02 and ITU-R M.1371). Sign controls direction (positive = starboard/clockwise). When defined, this drives both the dot animation (multiplied by `rotDotAnimationFactor`) and the port/starboard direction sign. */
+rateOfTurnDegreesPerMinute?: number | undefined;
+      /** Visual amplification factor applied only to the spinning-dot animation (not to bar extent). Default `18` keeps the legacy visual feel (≈1 rpm at 20°/min). */
+rotDotAnimationFactor?: number
    }
       export interface Events {
     

package/dist/navigation-instruments/watch/ObcWatch.svelte.d.ts

@@ -9,15 +9,22 @@ import type { Snippet } from 'svelte';
 export interface Props {
     class?: string;
     style?: string;
+    /** Instrument state (active, loading, off) */
     state?: InstrumentState;
+    /** Color priority (enhanced = blue palette, regular = gray palette) */
     priority?: Priority;
     watchCircleType?: WatchCircleType;
     northArrow?: boolean;
     northArrowInside?: boolean | undefined;
+    /** Setpoint angle in degrees (0° = 12 o'clock) */
     angleSetpoint?: number | undefined;
+    /** New setpoint being adjusted (focus mode) */
     newAngleSetpoint?: number | undefined;
+    /** Whether value matches setpoint (within deadband) */
     atAngleSetpoint?: boolean;
+    /** Deadband for zero detection (default 0.5°) */
     angleSetpointAtZeroDeadband?: number;
+    /** Override to derive setpoint color from priority regardless of state */
     setpointOverride?: boolean;
     touching?: boolean;
     animateSetpoint?: boolean;
@@ -57,16 +64,24 @@ Currently only used by the 180° sector of `obc-gauge-radial`. */
     scaleWindIcon?: number;
     rotation?: number | undefined;
     zoomToFitArc?: boolean;
+    /** Pre-computed zoom-to-fit arc frame. When set, the watch skips its own `computeZoomToFitArcFrame()` call and uses these values directly. Consumer instruments (e.g. rudder, instrument-radial) should compute the frame once and pass it here to avoid redundant computation. If you pass `arcFrame`, you own keeping it in sync with `areas` / `watchCircleType` — obc-watch will NOT recompute it, so a stale frame renders stale geometry. */
     arcFrame?: ZoomToFitArcFrame | undefined;
     tickFadeAngle?: number;
+    /** ROT visualization type: `'dots'` (spinning dots) or `'bar'` (arc bar with clipped dots). Undefined hides the ROT layer. */
     rotType?: RotType | undefined;
+    /** Track on which ROT elements are placed: `'scale'` (on the outer ring) or `'innerCircle'` (default, inside the inner ring) */
     rotPosition?: RotPosition;
+    /** Start angle of the ROT bar arc in degrees (0° = 12 o'clock, clockwise). Only used when `rotType` is `'bar'`. */
     rotStartAngle?: number;
+    /** End angle of the ROT bar arc in degrees. The bar is hidden when the difference from `rotStartAngle` is less than 0.1°. */
     rotEndAngle?: number;
+    /** Override priority for ROT color derivation. When set, ROT colors use this instead of the main `priority`. Useful when the ROT element has independent priority (e.g. compass per-element priority). */
     rotPriority?: Priority | undefined;
     rotPortStarboard?: boolean;
     rotAtZeroDeadband?: number;
+    /** Measured rate of turn in degrees per minute (the maritime/AIS convention, see ES-TRIN 2025/1 Art. 3.02 and ITU-R M.1371). Sign controls direction (positive = starboard/clockwise). When defined, this drives both the dot animation (multiplied by `rotDotAnimationFactor`) and the port/starboard direction sign. */
     rateOfTurnDegreesPerMinute?: number | undefined;
+    /** Visual amplification factor applied only to the spinning-dot animation (not to bar extent). Default `18` keeps the legacy visual feel (≈1 rpm at 20°/min). */
     rotDotAnimationFactor?: number;
 }
 export interface Events {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@oicl/openbridge-webcomponents-svelte",
-  "version": "2.0.0-next.100",
+  "version": "2.0.0-next.102",
   "scripts": {
     "dev": "vite dev",
     "build": "vite build && npm run prepack",
@@ -31,7 +31,7 @@
     }
   },
   "dependencies": {
-    "@oicl/openbridge-webcomponents": "^2.0.0-next.99"
+    "@oicl/openbridge-webcomponents": "^2.0.0-next.101"
   },
   "peerDependencies": {
     "svelte": "^5.0.0"