@oicl/openbridge-webcomponents-svelte 2.0.0-next.56 → 2.0.0-next.58

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.
@@ -38,6 +38,12 @@ tertiaryTickmarkInterval?: number | undefined;
38
38
  advices?: GaugeRadialAdvice[];
39
39
  clipTop?: number;
40
40
  clipBottom?: number;
41
+ clipLeft?: number;
42
+ clipRight?: number;
43
+ /** Place the horizontal end labels (±90°, e.g. min/max) below the tick instead
44
+ of beside it — the "Max-min" placement from the radial label model
45
+ (External / Internal / Max-min). See PR #903 / design discussion. */
46
+ endLabelsMaxMin?: boolean;
41
47
  zoomToFitArc?: boolean
42
48
  }
43
49
  export interface Events {
@@ -31,6 +31,12 @@ When undefined or <= 0, no tertiary tickmarks are shown. */
31
31
  advices?: GaugeRadialAdvice[];
32
32
  clipTop?: number;
33
33
  clipBottom?: number;
34
+ clipLeft?: number;
35
+ clipRight?: number;
36
+ /** Place the horizontal end labels (±90°, e.g. min/max) below the tick instead
37
+ of beside it — the "Max-min" placement from the radial label model
38
+ (External / Internal / Max-min). See PR #903 / design discussion. */
39
+ endLabelsMaxMin?: boolean;
34
40
  zoomToFitArc?: boolean;
35
41
  }
36
42
  export interface Events {
@@ -53,7 +53,11 @@ rotMaxValue?: number;
53
53
  priority?: Priority;
54
54
  priorityElements?: CompassSectorPriorityElement[];
55
55
  tickmarksInside?: boolean;
56
- zoomToFitArc?: boolean
56
+ zoomToFitArc?: boolean;
57
+ /** When `true`, shows a centered `<obc-readout>` under the arc displaying the
58
+ heading (label `HDG`, unit `DEG`). The value color follows the HDG entry in
59
+ `priorityElements`, matching the HDG arrow. */
60
+ hasReadout?: boolean
57
61
  }
58
62
  export interface Events {
59
63
  onNone?: (event: CustomEvent<unknown>) => void
@@ -46,6 +46,10 @@ with the introduction of `rateOfTurnDegreesPerMinute`. */
46
46
  priorityElements?: CompassSectorPriorityElement[];
47
47
  tickmarksInside?: boolean;
48
48
  zoomToFitArc?: boolean;
49
+ /** When `true`, shows a centered `<obc-readout>` under the arc displaying the
50
+ heading (label `HDG`, unit `DEG`). The value color follows the HDG entry in
51
+ `priorityElements`, matching the HDG arrow. */
52
+ hasReadout?: boolean;
49
53
  }
50
54
  export interface Events {
51
55
  onNone?: (event: CustomEvent<unknown>) => void;
@@ -1,12 +1,12 @@
1
1
 
2
2
  <script lang="ts">
3
3
  export type {InstrumentState, Priority} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
4
- export type {ObcGaugeRadialType, GaugeRadialAdvice} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
4
+ export type {ObcGaugeRadialType, GaugeRadialAdvice, GaugeRadialSector} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
5
5
  export type {TickmarkStyle} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/tickmark.js';
6
6
  import '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
7
7
  import { setProperties } from "../../util.js";
8
8
  import type {InstrumentState, Priority} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
9
- import type {ObcGaugeRadialType, GaugeRadialAdvice} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
9
+ import type {ObcGaugeRadialType, GaugeRadialAdvice, GaugeRadialSector} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
10
10
  import type {TickmarkStyle} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/tickmark.js';
11
11
  import type { Snippet } from 'svelte';
12
12
 
@@ -27,7 +27,13 @@ tertiaryTickmarkInterval?: number | undefined;
27
27
  type?: ObcGaugeRadialType;
28
28
  tickmarksInside?: boolean;
29
29
  tickmarkStyle?: TickmarkStyle;
30
- advices?: GaugeRadialAdvice[]
30
+ /** Caution/alert arcs. Ignored on `sector: 90-left` / `90-right`. */
31
+ advices?: GaugeRadialAdvice[];
32
+ sector?: GaugeRadialSector;
33
+ showReadout?: boolean;
34
+ label?: string;
35
+ unit?: string;
36
+ fractionDigits?: number
31
37
  }
32
38
  export interface Events {
33
39
 
@@ -1,6 +1,6 @@
1
1
  import '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
2
2
  import type { InstrumentState, Priority } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
3
- import type { ObcGaugeRadialType, GaugeRadialAdvice } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
3
+ import type { ObcGaugeRadialType, GaugeRadialAdvice, GaugeRadialSector } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/gauge-radial/gauge-radial.js';
4
4
  import type { TickmarkStyle } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/tickmark.js';
5
5
  import type { Snippet } from 'svelte';
6
6
  export interface Props {
@@ -20,7 +20,13 @@ When undefined or <= 0, no tertiary tickmarks are shown. */
20
20
  type?: ObcGaugeRadialType;
21
21
  tickmarksInside?: boolean;
22
22
  tickmarkStyle?: TickmarkStyle;
23
+ /** Caution/alert arcs. Ignored on `sector: 90-left` / `90-right`. */
23
24
  advices?: GaugeRadialAdvice[];
25
+ sector?: GaugeRadialSector;
26
+ showReadout?: boolean;
27
+ label?: string;
28
+ unit?: string;
29
+ fractionDigits?: number;
24
30
  }
25
31
  export interface Events {
26
32
  }
@@ -33,6 +39,7 @@ declare const ObcGaugeRadial: import("svelte").Component<$$ComponentProps, {
33
39
  Priority: typeof Priority;
34
40
  ObcGaugeRadialType: typeof ObcGaugeRadialType;
35
41
  GaugeRadialAdvice: typeof GaugeRadialAdvice;
42
+ GaugeRadialSector: typeof GaugeRadialSector;
36
43
  TickmarkStyle: typeof TickmarkStyle;
37
44
  }, "">;
38
45
  type ObcGaugeRadial = ReturnType<typeof ObcGaugeRadial>;
@@ -1,9 +1,13 @@
1
1
 
2
2
  <script lang="ts">
3
3
  export type {VesselImage} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/watch.js';
4
+ export type {ObcPitchType} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/pitch/pitch.js';
5
+ export type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
4
6
  import '@oicl/openbridge-webcomponents/dist/navigation-instruments/pitch/pitch.js';
5
7
  import { setProperties } from "../../util.js";
6
8
  import type {VesselImage} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/watch.js';
9
+ import type {ObcPitchType} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/pitch/pitch.js';
10
+ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
7
11
  import type { Snippet } from 'svelte';
8
12
 
9
13
  export interface Props {
@@ -16,6 +20,16 @@
16
20
  maxPitchAdvice?: number | undefined;
17
21
  triggerPitchAdvice?: boolean;
18
22
  zoomToFitArc?: boolean;
23
+ /** When `true`, the centre shows an `<obc-readout>` with the pitch value
24
+ (label `Pitch`, unit `DEG`) instead of the horizon line, rotating indicator
25
+ and vessel. Default `false`. */
26
+ hasReadout?: boolean;
27
+ /** `single-scale` shows one arc on the right (default); `dual-scale` also
28
+ shows the scale on the opposite (left) arc (the indicator's opposite end). */
29
+ type?: ObcPitchType;
30
+ /** Colour palette for the scale fill / indicator and the readout value:
31
+ `regular` (default) or `enhanced`. */
32
+ priority?: Priority;
19
33
  /** Half-extent of the watch arc in degrees. The arc spans `90° ± arcAngle`
20
34
  and pitch values are placed at their true position within it. Default
21
35
  `45` reproduces the historical 90°-wide arc.
@@ -1,5 +1,7 @@
1
1
  import '@oicl/openbridge-webcomponents/dist/navigation-instruments/pitch/pitch.js';
2
2
  import type { VesselImage } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/watch.js';
3
+ import type { ObcPitchType } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/pitch/pitch.js';
4
+ import type { Priority } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
3
5
  import type { Snippet } from 'svelte';
4
6
  export interface Props {
5
7
  class?: string;
@@ -11,6 +13,16 @@ export interface Props {
11
13
  maxPitchAdvice?: number | undefined;
12
14
  triggerPitchAdvice?: boolean;
13
15
  zoomToFitArc?: boolean;
16
+ /** When `true`, the centre shows an `<obc-readout>` with the pitch value
17
+ (label `Pitch`, unit `DEG`) instead of the horizon line, rotating indicator
18
+ and vessel. Default `false`. */
19
+ hasReadout?: boolean;
20
+ /** `single-scale` shows one arc on the right (default); `dual-scale` also
21
+ shows the scale on the opposite (left) arc (the indicator's opposite end). */
22
+ type?: ObcPitchType;
23
+ /** Colour palette for the scale fill / indicator and the readout value:
24
+ `regular` (default) or `enhanced`. */
25
+ priority?: Priority;
14
26
  /** Half-extent of the watch arc in degrees. The arc spans `90° ± arcAngle`
15
27
  and pitch values are placed at their true position within it. Default
16
28
  `45` reproduces the historical 90°-wide arc.
@@ -30,6 +42,8 @@ export interface Slots {
30
42
  type $$ComponentProps = Props & Events & Slots;
31
43
  declare const ObcPitch: import("svelte").Component<$$ComponentProps, {
32
44
  VesselImage: typeof VesselImage;
45
+ ObcPitchType: typeof ObcPitchType;
46
+ Priority: typeof Priority;
33
47
  }, "">;
34
48
  type ObcPitch = ReturnType<typeof ObcPitch>;
35
49
  export default ObcPitch;
@@ -28,6 +28,9 @@ import type {PitchRollPriorityElement} from '@oicl/openbridge-webcomponents/dist
28
28
  triggerRollAdvice?: boolean;
29
29
  priority?: Priority;
30
30
  priorityElements?: PitchRollPriorityElement[];
31
+ /** When `true`, the centre shows two stacked `<obc-readout>`s (pitch above
32
+ roll) instead of the vessel images. Default `false`. */
33
+ hasReadout?: boolean;
31
34
  zoomToFitArc?: boolean;
32
35
  /** Half-extent of each of the four watch arcs in degrees, measured from the
33
36
  arc's natural center (0°/90°/180°/270°). Each arc spans
@@ -21,6 +21,9 @@ export interface Props {
21
21
  triggerRollAdvice?: boolean;
22
22
  priority?: Priority;
23
23
  priorityElements?: PitchRollPriorityElement[];
24
+ /** When `true`, the centre shows two stacked `<obc-readout>`s (pitch above
25
+ roll) instead of the vessel images. Default `false`. */
26
+ hasReadout?: boolean;
24
27
  zoomToFitArc?: boolean;
25
28
  /** Half-extent of each of the four watch arcs in degrees, measured from the
26
29
  arc's natural center (0°/90°/180°/270°). Each arc spans
@@ -1,9 +1,13 @@
1
1
 
2
2
  <script lang="ts">
3
3
  export type {VesselImage} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/watch.js';
4
+ export type {ObcRollType} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/roll/roll.js';
5
+ export type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
4
6
  import '@oicl/openbridge-webcomponents/dist/navigation-instruments/roll/roll.js';
5
7
  import { setProperties } from "../../util.js";
6
8
  import type {VesselImage} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/watch.js';
9
+ import type {ObcRollType} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/roll/roll.js';
10
+ import type {Priority} from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
7
11
  import type { Snippet } from 'svelte';
8
12
 
9
13
  export interface Props {
@@ -17,6 +21,16 @@
17
21
  maxRollAdvice?: number | undefined;
18
22
  triggerRollAdvice?: boolean;
19
23
  zoomToFitArc?: boolean;
24
+ /** When `true`, the centre shows an `<obc-readout>` with the roll value
25
+ (label `Roll`, unit `DEG`) instead of the horizon line, rotating indicator
26
+ and vessel. Default `false`. */
27
+ hasReadout?: boolean;
28
+ /** `single-scale` shows one arc at the bottom (default); `dual-scale` also
29
+ shows the scale on the top arc (the indicator's opposite end). */
30
+ type?: ObcRollType;
31
+ /** Colour palette for the scale fill / indicator and the readout value:
32
+ `regular` (default) or `enhanced`. */
33
+ priority?: Priority;
20
34
  /** Half-extent of the watch arc in degrees. The arc spans `180° ± arcAngle`
21
35
  and roll values are placed at their true position within it. Default
22
36
  `45` reproduces the historical 90°-wide arc.
@@ -1,5 +1,7 @@
1
1
  import '@oicl/openbridge-webcomponents/dist/navigation-instruments/roll/roll.js';
2
2
  import type { VesselImage } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/watch/watch.js';
3
+ import type { ObcRollType } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/roll/roll.js';
4
+ import type { Priority } from '@oicl/openbridge-webcomponents/dist/navigation-instruments/types.js';
3
5
  import type { Snippet } from 'svelte';
4
6
  export interface Props {
5
7
  class?: string;
@@ -12,6 +14,16 @@ export interface Props {
12
14
  maxRollAdvice?: number | undefined;
13
15
  triggerRollAdvice?: boolean;
14
16
  zoomToFitArc?: boolean;
17
+ /** When `true`, the centre shows an `<obc-readout>` with the roll value
18
+ (label `Roll`, unit `DEG`) instead of the horizon line, rotating indicator
19
+ and vessel. Default `false`. */
20
+ hasReadout?: boolean;
21
+ /** `single-scale` shows one arc at the bottom (default); `dual-scale` also
22
+ shows the scale on the top arc (the indicator's opposite end). */
23
+ type?: ObcRollType;
24
+ /** Colour palette for the scale fill / indicator and the readout value:
25
+ `regular` (default) or `enhanced`. */
26
+ priority?: Priority;
15
27
  /** Half-extent of the watch arc in degrees. The arc spans `180° ± arcAngle`
16
28
  and roll values are placed at their true position within it. Default
17
29
  `45` reproduces the historical 90°-wide arc.
@@ -31,6 +43,8 @@ export interface Slots {
31
43
  type $$ComponentProps = Props & Events & Slots;
32
44
  declare const ObcRoll: import("svelte").Component<$$ComponentProps, {
33
45
  VesselImage: typeof VesselImage;
46
+ ObcRollType: typeof ObcRollType;
47
+ Priority: typeof Priority;
34
48
  }, "">;
35
49
  type ObcRoll = ReturnType<typeof ObcRoll>;
36
50
  export default ObcRoll;
@@ -32,7 +32,10 @@ tertiaryTickmarkInterval?: number | undefined;
32
32
  tickmarkStyle?: TickmarkStyle;
33
33
  advices?: GaugeRadialAdvice[];
34
34
  zoomToFitArc?: boolean;
35
- rotArcExtent?: number
35
+ rotArcExtent?: number;
36
+ /** When `true`, shows a centered `<obc-readout>` (label `ROT`, unit `DEG/min`)
37
+ under the arc with the current rate-of-turn value. Default `false`. */
38
+ hasReadout?: boolean
36
39
  }
37
40
  export interface Events {
38
41
 
@@ -26,6 +26,9 @@ When undefined or <= 0, no tertiary tickmarks are shown. */
26
26
  advices?: GaugeRadialAdvice[];
27
27
  zoomToFitArc?: boolean;
28
28
  rotArcExtent?: number;
29
+ /** When `true`, shows a centered `<obc-readout>` (label `ROT`, unit `DEG/min`)
30
+ under the arc with the current rate-of-turn value. Default `false`. */
31
+ hasReadout?: boolean;
29
32
  }
30
33
  export interface Events {
31
34
  }
@@ -51,8 +51,19 @@ import type {RotType, RotPosition} from '@oicl/openbridge-webcomponents/dist/nav
51
51
  currentSymbolRadius?: number | null;
52
52
  currentColor?: string | undefined;
53
53
  starboardPortIndicator?: boolean;
54
- clipTop?: number;
55
- clipBottom?: number;
54
+ /** Top clip, % of height. Ignored when `zoomToFitArc` is true. */
55
+ clipTop?: number;
56
+ /** Bottom clip, % of height. Ignored when `zoomToFitArc` is true. */
57
+ clipBottom?: number;
58
+ /** Left clip, % of width — horizontal counterpart of clipTop/bottom (90° sectors). Ignored when `zoomToFitArc`. */
59
+ clipLeft?: number;
60
+ /** Right clip, % of width — horizontal counterpart of clipTop/bottom (90° sectors). Ignored when `zoomToFitArc`. */
61
+ clipRight?: number;
62
+ /** Place the horizontal end labels (±90°, e.g. min/max) below the tick instead
63
+ of beside it. This is the "Max-min" label placement from the radial label
64
+ model (External / Internal / Max-min) — see PR #903 / design discussion.
65
+ Currently only used by the 180° sector of `obc-gauge-radial`. */
66
+ endLabelsMaxMin?: boolean;
56
67
  scaleWindIcon?: number;
57
68
  rotation?: number | undefined;
58
69
  zoomToFitArc?: boolean;
@@ -41,8 +41,19 @@ export interface Props {
41
41
  currentSymbolRadius?: number | null;
42
42
  currentColor?: string | undefined;
43
43
  starboardPortIndicator?: boolean;
44
+ /** Top clip, % of height. Ignored when `zoomToFitArc` is true. */
44
45
  clipTop?: number;
46
+ /** Bottom clip, % of height. Ignored when `zoomToFitArc` is true. */
45
47
  clipBottom?: number;
48
+ /** Left clip, % of width — horizontal counterpart of clipTop/bottom (90° sectors). Ignored when `zoomToFitArc`. */
49
+ clipLeft?: number;
50
+ /** Right clip, % of width — horizontal counterpart of clipTop/bottom (90° sectors). Ignored when `zoomToFitArc`. */
51
+ clipRight?: number;
52
+ /** Place the horizontal end labels (±90°, e.g. min/max) below the tick instead
53
+ of beside it. This is the "Max-min" label placement from the radial label
54
+ model (External / Internal / Max-min) — see PR #903 / design discussion.
55
+ Currently only used by the 180° sector of `obc-gauge-radial`. */
56
+ endLabelsMaxMin?: boolean;
46
57
  scaleWindIcon?: number;
47
58
  rotation?: number | undefined;
48
59
  zoomToFitArc?: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@oicl/openbridge-webcomponents-svelte",
3
- "version": "2.0.0-next.56",
3
+ "version": "2.0.0-next.58",
4
4
  "scripts": {
5
5
  "dev": "vite dev",
6
6
  "build": "vite build && npm run prepack",
@@ -31,7 +31,7 @@
31
31
  }
32
32
  },
33
33
  "dependencies": {
34
- "@oicl/openbridge-webcomponents": "^2.0.0-next.55"
34
+ "@oicl/openbridge-webcomponents": "^2.0.0-next.57"
35
35
  },
36
36
  "peerDependencies": {
37
37
  "svelte": "^5.0.0"