@sheetxl/react 0.7.28-beta.3 → 0.7.28-beta.4

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.
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@sheetxl/react",
3
3
  "description": "React - React components needed to build advanced grid and spreadsheet UIs.",
4
- "version": "0.7.28-beta.3",
4
+ "version": "0.7.28-beta.4",
5
5
  "license": "SEE LICENSE IN <LICENSE>",
6
6
  "type": "module",
7
7
  "exports": {
@@ -48,11 +48,11 @@
48
48
  "@dnd-kit/modifiers": "^9.0.0",
49
49
  "@dnd-kit/sortable": "^10.0.0",
50
50
  "@dnd-kit/utilities": "^3.2.2",
51
- "@sheetxl/grid-react": "^0.7.28-beta.3",
52
- "@sheetxl/io": "^0.7.28-beta.3",
53
- "@sheetxl/sdk": "^0.7.28-beta.3",
54
- "@sheetxl/utils": "^0.7.28-beta.3",
55
- "@sheetxl/utils-react": "^0.7.28-beta.3",
51
+ "@sheetxl/grid-react": "^0.7.28-beta.4",
52
+ "@sheetxl/io": "^0.7.28-beta.4",
53
+ "@sheetxl/sdk": "^0.7.28-beta.4",
54
+ "@sheetxl/utils": "^0.7.28-beta.4",
55
+ "@sheetxl/utils-react": "^0.7.28-beta.4",
56
56
  "clsx": "^2.1.1",
57
57
  "react-merge-refs": "^3.0.2",
58
58
  "react-moveable": "^0.56.0",
@@ -23,6 +23,11 @@
23
23
  "chart.type.scatterLinesMarkersSmooth": "Punktdiagramm mit Datenpunkten und interpolierten Linien",
24
24
  "chart.type.scatterLinesSmooth": "Punktdiagramm mit interpolierten Linien",
25
25
  "chart.type.scatterMarkers": "Punktdiagramm mit Datenpunkten",
26
+ "circular.converged": "{count, plural, one {Konvergiert nach # Iteration} other {Konvergiert nach # Iterationen}}",
27
+ "circular.reads": "Liest einen Zirkelbezug in",
28
+ "circular.title": "Zirkelbezug",
29
+ "circular.unconverged": "{count, plural, one {Nicht konvergiert nach # Iteration} other {Nicht konvergiert nach # Iterationen}} (letzte Änderung {change})",
30
+ "circular.unconvergedNoChange": "{count, plural, one {Nicht konvergiert nach # Iteration} other {Nicht konvergiert nach # Iterationen}}",
26
31
  "clipboard.pasting": "Wird eingefügt...",
27
32
  "dialog.activate": "Aktivieren",
28
33
  "dialog.activateTask.inputLabel": "Aufgabenname",
@@ -222,6 +222,22 @@
222
222
  "icon": "Calculate",
223
223
  "shortcut": "ctrl+alt+F9"
224
224
  },
225
+ "calcModeAutomatic": {
226
+ "label": "Automatisch",
227
+ "description": "Formeln neu berechnen, sobald sich ihre Eingaben ändern."
228
+ },
229
+ "calcModeAutomaticExceptTables": {
230
+ "label": "Automatisch außer bei Datentabellen",
231
+ "description": "Formeln neu berechnen, sobald sich ihre Eingaben ändern, mit Ausnahme von Was-wäre-wenn-Datentabellen. Ohne Datentabellen entspricht dies „Automatisch“."
232
+ },
233
+ "calcModeManual": {
234
+ "label": "Manuell",
235
+ "description": "Nur auf Anforderung neu berechnen (F9). Bis dahin bleiben abhängige Formeln nach einer Änderung veraltet."
236
+ },
237
+ "calcIterativeToggle": {
238
+ "label": "Iterative Berechnung aktivieren",
239
+ "description": "Zirkelbezüge durch wiederholtes Neuberechnen auflösen, bis sie sich stabilisieren oder die maximale Iterationszahl erreicht ist. Ausgeschaltet ergibt ein Zirkelbezug 0."
240
+ },
225
241
  "selectDirectPrecedents": {
226
242
  "label": "Direkte Vorgänger auswählen",
227
243
  "description": "Die Zellen auswählen, auf die die Formeln in der Auswahl direkt verweisen.",
@@ -23,6 +23,11 @@
23
23
  "chart.type.scatterLinesMarkersSmooth": "Scatter Chart with Markers and Smooth Lines",
24
24
  "chart.type.scatterLinesSmooth": "Scatter Chart with Smooth Lines",
25
25
  "chart.type.scatterMarkers": "Scatter Chart with Markers",
26
+ "circular.converged": "{count, plural, one {Converged after # iteration} other {Converged after # iterations}}",
27
+ "circular.reads": "Reads a circular reference at",
28
+ "circular.title": "Circular reference",
29
+ "circular.unconverged": "{count, plural, one {Did not converge after # iteration} other {Did not converge after # iterations}} (last change {change})",
30
+ "circular.unconvergedNoChange": "{count, plural, one {Did not converge after # iteration} other {Did not converge after # iterations}}",
26
31
  "clipboard.pasting": "Pasting...",
27
32
  "dialog.activate": "Activate",
28
33
  "dialog.activateTask.inputLabel": "Task Name",
@@ -222,6 +222,22 @@
222
222
  "icon": "Calculate",
223
223
  "shortcut": "ctrl+alt+F9"
224
224
  },
225
+ "calcModeAutomatic": {
226
+ "label": "Automatic",
227
+ "description": "Recalculate formulas whenever their inputs change."
228
+ },
229
+ "calcModeAutomaticExceptTables": {
230
+ "label": "Automatic Except for Data Tables",
231
+ "description": "Recalculate formulas whenever their inputs change, except what-if data tables. Without data tables this is the same as Automatic."
232
+ },
233
+ "calcModeManual": {
234
+ "label": "Manual",
235
+ "description": "Recalculate only when you ask (F9). Edits leave dependent formulas out of date until then."
236
+ },
237
+ "calcIterativeToggle": {
238
+ "label": "Enable Iterative Calculation",
239
+ "description": "Resolve circular references by recalculating them repeatedly until they settle or the maximum iterations is reached. Off, a circular reference evaluates to 0."
240
+ },
225
241
  "selectDirectPrecedents": {
226
242
  "label": "Select Direct Precedents",
227
243
  "description": "Select the cells directly referenced by the formulas in the selection.",
@@ -0,0 +1,38 @@
1
+ import { default as React } from 'react';
2
+ import { ConditionalIconSpec } from '../layer/ConditionalIcons';
3
+ export interface IconSetGlyphsProps extends React.HTMLAttributes<HTMLDivElement> {
4
+ /**
5
+ * The icons to draw, lowest band first — `resolveIconSetIcons` or `getConditionalIconSet`.
6
+ * A `null` is a band that draws nothing; it keeps its slot so the row still reads as the set.
7
+ */
8
+ icons: readonly (ConditionalIconSpec | null)[];
9
+ /**
10
+ * `'ascending'` draws the lowest band first, the way the editor's threshold rows read;
11
+ * `'descending'` draws the highest first, the way Excel's gallery shows a set (up, side, down).
12
+ *
13
+ * @defaultValue 'ascending'
14
+ */
15
+ order?: 'ascending' | 'descending';
16
+ /**
17
+ * Glyph size in px.
18
+ *
19
+ * @defaultValue 16
20
+ */
21
+ size?: number;
22
+ /**
23
+ * Gap between glyphs in px.
24
+ *
25
+ * @defaultValue 4
26
+ */
27
+ gap?: number;
28
+ }
29
+ /**
30
+ * A rule's icons in a row — the picture of an icon set wherever one is shown.
31
+ *
32
+ * @remarks
33
+ * Plain DOM: the same row serves the task pane, the menu gallery, the rule preview and any host
34
+ * without a UI kit. It draws from the table the sheet paints from, so what is shown here is what
35
+ * lands in the cells.
36
+ */
37
+ export declare const IconSetGlyphs: React.NamedExoticComponent<IconSetGlyphsProps>;
38
+ //# sourceMappingURL=IconSetGlyphs.d.ts.map
@@ -0,0 +1,2 @@
1
+ export * from './IconSetGlyphs';
2
+ //# sourceMappingURL=index.d.ts.map
@@ -15,6 +15,7 @@ export * from './editableLabel';
15
15
  export * from './tabStrip';
16
16
  export * from './icons';
17
17
  export * from './layer/ConditionalIcons';
18
+ export * from './conditionalFormat';
18
19
  export * from './clipboard';
19
20
  export * from './commands';
20
21
  export * from './undo';
@@ -1,9 +1,9 @@
1
1
  import { default as React } from 'react';
2
2
  import { RangeCoords } from '@sheetxl/utils';
3
- import { ISheet } from '@sheetxl/sdk';
3
+ import { ICalculation, IRange, ISheet } from '@sheetxl/sdk';
4
4
  import { StickyState, GridPlacement, LayerProps } from '@sheetxl/grid-react';
5
5
  /** The kind of annotation a cell carries (drives the default tip styling). */
6
- export type CellErrorKind = 'error' | 'warning';
6
+ export type CellErrorKind = 'error' | 'warning' | 'circular';
7
7
  /** The active hovered annotation passed to a custom {@link CellErrorLayerProps.renderTip}. */
8
8
  export interface CellErrorTip {
9
9
  /** The hovered cell as a range (the tip's anchor). */
@@ -14,6 +14,15 @@ export interface CellErrorTip {
14
14
  kind: CellErrorKind;
15
15
  /** The resolved sticky state (e.g. `state.scrollIntoView()` to reveal the cell). */
16
16
  state: StickyState;
17
+ /** The reference cycle the hovered cell is in, or downstream of. `kind === 'circular'` only. */
18
+ cycle?: ICalculation.ICircularReference;
19
+ /**
20
+ * The cycle as a walk of reads from the hovered cell back to itself (`[A1, B1]` for
21
+ * A1 → B1 → A1) — empty when the cell only READS the cycle. `kind === 'circular'` only.
22
+ */
23
+ path?: readonly IRange.CellCoords[];
24
+ /** The cycle's representative — where a downstream cell is pointed. `kind === 'circular'` only. */
25
+ representative?: IRange.CellCoords | null;
17
26
  }
18
27
  /**
19
28
  * Props for {@link CellErrorLayer}.
@@ -21,7 +30,7 @@ export interface CellErrorTip {
21
30
  export interface CellErrorLayerProps extends Omit<LayerProps, 'children'> {
22
31
  /** Class forwarded to the inner layer's host box (devtools identification). */
23
32
  className?: string;
24
- /** The sheet whose cells are probed for `getErrors()` / `getWarnings()`. */
33
+ /** The sheet whose cells are probed for `getErrors()` / `getCircularReference()` / `getWarnings()`. */
25
34
  sheet: ISheet;
26
35
  /** Which side of the cell the tip attaches to. @defaultValue `{ side: 'r', align: 'start' }` */
27
36
  placement?: GridPlacement;
@@ -41,9 +50,17 @@ export interface CellErrorLayerProps extends Omit<LayerProps, 'children'> {
41
50
  }
42
51
  /**
43
52
  * A grid layer that shows a **hover tooltip on cells carrying errors / warnings**. A thin
44
- * {@link HoverTipLayer} whose probe asks the sheet (`sheet.getCell(coords).getErrors()` /
45
- * `.getWarnings()`) and anchors on the cell's own range; the tip stays open while hovered. `getComments()`
46
- * is not yet wired (unimplemented in the model).
53
+ * {@link HoverTipLayer} whose probe asks the sheet — `getErrors()`, then
54
+ * `getCircularReference()`, then `getWarnings()` — and anchors on the cell's own range; the tip
55
+ * stays open while hovered. `getComments()` is not yet wired (unimplemented in the model).
56
+ *
57
+ * @remarks
58
+ * A cell in a reference cycle, or downstream of one, is a third source (`kind: 'circular'`)
59
+ * rather than a second tip layer — two layers would both open on one cell. A cycle has no
60
+ * start, so a member's tip tells it from the hovered cell (`A1 → B1 → A1`, the engine's own read
61
+ * order via `getPath`); a downstream cell's says which cycle it reads. Every OTHER cell in the
62
+ * tip is a link that selects it — the same affordance from every cell, member or reader. A
63
+ * custom `renderTip` gets the cycle object, the path and the representative.
47
64
  */
48
65
  export declare const CellErrorLayer: React.MemoExoticComponent<(props: CellErrorLayerProps) => React.JSX.Element>;
49
66
  //# sourceMappingURL=CellErrorLayer.d.ts.map
@@ -0,0 +1,34 @@
1
+ import { default as React } from 'react';
2
+ import { ISheet } from '@sheetxl/sdk';
3
+ import { LayerProps } from '@sheetxl/grid-react';
4
+ export interface CircularIndicatorLayerProps extends LayerProps {
5
+ /** Class for the layer (devtools identification). */
6
+ className?: string;
7
+ /** Style for the indicators host box. */
8
+ style?: React.CSSProperties;
9
+ /** The sheet whose circular references are marked. */
10
+ sheet: ISheet;
11
+ /** Size (px, unzoomed) of the corner glyph. @defaultValue 9 */
12
+ markSize?: number;
13
+ /** Inset (px, unzoomed) of the glyph from the cell's top-left corner. @defaultValue 1 */
14
+ inset?: number;
15
+ }
16
+ /**
17
+ * The sheet's **circular-reference marks** — a circle-arrow on every cell that is IN a reference
18
+ * cycle.
19
+ *
20
+ * @remarks
21
+ * A {@link CellTileDiv} fed the sheet's `Feature.Circular` regions (engine-merged blocks: a
22
+ * 28K-cell block downstream of one cycle is one region, not 28K nodes), so a sheet with no cycles
23
+ * costs one lookup per frame. Members only get the glyph — a downstream cell is `0` for the same
24
+ * reason (DESIGN-CIRCULAR-CALC.md §2.1) but the fix is never there, and a column of glyphs reads
25
+ * as a column of problems. The tooltip (`CellErrorLayer`) still answers for downstream cells.
26
+ *
27
+ * The glyph shows in every state; an unresolved cycle — iterative calculation off, or capped
28
+ * before converging — takes the error tone on top. Excel marks nothing on the cell and names
29
+ * one representative in its status bar; the glyph is metadata beside the value, which stays `0`.
30
+ *
31
+ * Passive paint below the selection (`pointerEvents: none`).
32
+ */
33
+ export declare const CircularIndicatorLayer: React.MemoExoticComponent<(props: CircularIndicatorLayerProps) => React.JSX.Element | null>;
34
+ //# sourceMappingURL=CircularIndicatorLayer.d.ts.map
@@ -30,7 +30,8 @@ export interface ConditionalBarLayerProps extends LayerProps {
30
30
  *
31
31
  * It mounts only when a bar is actually in view. {@link useSheetVisibleDecorations} answers that
32
32
  * from the SDK's spatial index before touching a cell, so a sheet with no conditional formatting
33
- * pays a single lookup per frame and renders nothing.
33
+ * pays a single lookup per frame and renders nothing; the same source feeds the
34
+ * {@link CellTileDiv} that snapshots the bars.
34
35
  *
35
36
  * Every number it draws with is resolved by the model
36
37
  * (`ICell.getConditionalDecorations`): the value already sits on its track and zero already
@@ -1,4 +1,4 @@
1
- import { IStyle } from '@sheetxl/sdk';
1
+ import { IStyle, IConditionalFormat } from '@sheetxl/sdk';
2
2
  /**
3
3
  * One icon of a conditional-format icon set: which shape to draw and what to tint it.
4
4
  */
@@ -16,6 +16,27 @@ export interface ConditionalIconSpec {
16
16
  */
17
17
  color: string;
18
18
  }
19
+ /**
20
+ * The tones Excel's built-in sets are drawn in.
21
+ *
22
+ * @remarks
23
+ * Values live in `ConditionalIconsLayer.module.css`, which defaults them to Excel's own colors —
24
+ * a workbook should look like itself before a host says otherwise. Override `--sxl-cf-icon-<tone>`
25
+ * to retint every set at once without touching the sets themselves.
26
+ */
27
+ declare const Tone: {
28
+ readonly bad: "var(--sxl-cf-icon-bad)";
29
+ /** The orange of every arrow between the red and the green in the four- and five-arrow sets. */
30
+ readonly lightBad: "var(--sxl-cf-icon-light-bad)";
31
+ readonly neutral: "var(--sxl-cf-icon-neutral)";
32
+ readonly good: "var(--sxl-cf-icon-good)";
33
+ readonly purple: "var(--sxl-cf-icon-purple)";
34
+ readonly gold: "var(--sxl-cf-icon-gold)";
35
+ readonly gray: "var(--sxl-cf-icon-gray)";
36
+ readonly black: "var(--sxl-cf-icon-black)";
37
+ };
38
+ /** The tone names of {@link ConditionalIconSpec.color}, for naming an icon. */
39
+ export type ConditionalIconTone = keyof typeof Tone;
19
40
  /**
20
41
  * Returns the icon a band of a built-in set draws, or `null` if the band is out of range.
21
42
  *
@@ -31,4 +52,48 @@ export declare const getConditionalIcon: (set: IStyle.IconSet, index: number) =>
31
52
  * Returns every icon of a built-in set, band 0 first — for a picker previewing the set.
32
53
  */
33
54
  export declare const getConditionalIconSet: (set: IStyle.IconSet) => readonly ConditionalIconSpec[];
55
+ /**
56
+ * The icon each band of a rule draws — the set's own, or the band's override — lowest band first.
57
+ *
58
+ * @remarks
59
+ * This is the lookup the sheet performs per cell (`ConditionalFormat._prepareIconSet`), lifted to
60
+ * the whole rule so an editor previews exactly what the grid paints: `reverse` turns the band
61
+ * before the override is read, and an override naming a set the table does not hold, or a slot
62
+ * past its end (Excel's "No Cell Icon"), is `null` — a band that draws nothing.
63
+ *
64
+ * The result is indexed by **threshold row** (`stops[i]`), so it lines up with the editor's rows
65
+ * as authored; reverse it for the way a gallery shows a set (highest first).
66
+ */
67
+ export declare const resolveIconSetIcons: (scale: IConditionalFormat.IconSet) => (ConditionalIconSpec | null)[];
68
+ /**
69
+ * The two halves of an icon's name — its shape (the glyph key without the pack prefix,
70
+ * `arrowUp`) and its tone (`good`) — for a tooltip or a reader to compose "Green Up Arrow" from.
71
+ */
72
+ export declare const describeConditionalIcon: (spec: ConditionalIconSpec) => {
73
+ shape: string;
74
+ tone: ConditionalIconTone;
75
+ };
76
+ /**
77
+ * One icon a band may draw, with the address a rule stores for it.
78
+ */
79
+ export interface ConditionalIconCatalogEntry {
80
+ /** The set the icon is borrowed from — what `IConditionalFormat.IconSet.icon` holds. */
81
+ set: IStyle.IconSet;
82
+ /** The icon's index within that set. */
83
+ id: number;
84
+ spec: ConditionalIconSpec;
85
+ }
86
+ /**
87
+ * Every distinct icon the built-in sets draw, in one list — Excel's fifty-two custom-icon choices,
88
+ * plus one: under the Excel Online palette the five-arrow set's side arrow is orange while the
89
+ * three-arrow set's is yellow.
90
+ *
91
+ * @remarks
92
+ * Derived, not authored: the sets are walked in gallery order, each highest band first (the way
93
+ * a set is pictured), and an icon is listed the first time its shape-and-tint pair appears, under
94
+ * the first set that draws it. Any set that draws the glyph is a valid address on the wire, so
95
+ * the first is as good as another. A test pins the count so a table edit is noticed.
96
+ */
97
+ export declare const ICON_CATALOG: readonly ConditionalIconCatalogEntry[];
98
+ export {};
34
99
  //# sourceMappingURL=ConditionalIcons.d.ts.map
@@ -20,7 +20,9 @@ export interface ConditionalIconsLayerProps extends LayerProps {
20
20
  * telling them to.
21
21
  *
22
22
  * It mounts only when an icon is actually in view; see {@link useSheetVisibleDecorations} for how
23
- * that is answered without touching a cell.
23
+ * that is answered without touching a cell. The same source feeds the {@link CellTileDiv} that
24
+ * snapshots the icons — a cached tile is a reused element, not a frozen picture, so the hover
25
+ * growth still runs on it.
24
26
  *
25
27
  * Which glyph a band draws is a lookup, not a sprite: the model reports the band and the set, and
26
28
  * `getConditionalIcon` maps that onto a shape from the `cf` icon pack plus a tint. The shapes are
@@ -27,15 +27,15 @@ export interface ValidationIndicatorLayerProps extends LayerProps {
27
27
  * and the dropdown on a selected list cell.
28
28
  *
29
29
  * @remarks
30
- * Both used to be drawn by the cell renderer, which meant every cached tile probed the validation
31
- * model whether or not the sheet had any validations, and neither mark could have a hover or press
32
- * state (a tile is an immutable snapshot). As a layer they are live, they cost nothing on a sheet
33
- * with no validations, and the cells layer no longer knows validation exists.
30
+ * A layer of its own rather than part of the cell renderer, so the cells layer never probes the
31
+ * validation model and a sheet with no validations costs one index lookup per frame.
34
32
  *
35
- * The two marks answer different questions and so are scoped differently. The invalid mark is a
36
- * property of a cell's VALUE, so it is drawn wherever one is in view. The dropdown is an
37
- * affordance for editing, so — as in Excel — it appears on the selected cell alone; a column of
38
- * list cells would otherwise be a column of buttons.
33
+ * The two marks answer different questions and so are drawn differently. The invalid mark is a
34
+ * property of a cell's VALUE: it is drawn wherever one is in view, as {@link CellTileDiv}
35
+ * snapshots that survive scroll. The dropdown is an affordance for editing, so — as in Excel — it
36
+ * appears on the selected cell alone (a column of list cells would otherwise be a column of
37
+ * buttons), and it follows the selection as a live {@link VirtualDiv} peer of the tiles, so an
38
+ * arrow key never invalidates a tile.
39
39
  */
40
40
  export declare const ValidationIndicatorLayer: React.MemoExoticComponent<(props: ValidationIndicatorLayerProps) => React.JSX.Element | null>;
41
41
  //# sourceMappingURL=ValidationIndicatorLayer.d.ts.map
@@ -18,6 +18,7 @@ export * from './ConditionalIcons';
18
18
  export * from './ConditionalBarLayer';
19
19
  export * from './ConditionalIconsLayer';
20
20
  export * from './ValidationIndicatorLayer';
21
+ export * from './CircularIndicatorLayer';
21
22
  export * from './HeaderSelectionLayer';
22
23
  export * from './HeaderResizerLayer';
23
24
  export * from './ResizeIndicator';
@@ -36,21 +36,58 @@ export declare const defaultDataBar: () => IConditionalFormat.DataBar;
36
36
  export declare const defaultIconStops: (count: number) => IConditionalFormat.Stop[];
37
37
  export declare const defaultIconSet: () => IConditionalFormat.IconSet;
38
38
  /**
39
- * Excel's icon-set gallery groups. UI layers key their localized group headers off `key`.
39
+ * One block of the icon-set gallery: sets two abreast under a heading. UI layers key their
40
+ * localized headings off `key`.
40
41
  */
41
- export interface IconSetGroup {
42
+ export interface IconSetGalleryBlock {
42
43
  key: 'directional' | 'shapes' | 'indicators' | 'ratings';
43
- sets: readonly IStyle.IconSet[];
44
+ /** Each row is a pair of sets; the right seat may be empty. */
45
+ rows: readonly (readonly [IStyle.IconSet, IStyle.IconSet | null])[];
44
46
  }
45
47
  /**
46
- * Every set the gallery offers, grouped and ordered the way Excel's own gallery is.
48
+ * Every set the gallery offers, laid out the way Excel Online's own gallery is — two sets to a
49
+ * row: a colored family beside its gray twin, the circled symbols beside the bare ones, the
50
+ * rating bars down the right.
47
51
  *
48
52
  * @remarks
49
53
  * Includes the three Excel 2010 sets (`3Triangles`, `3Stars`, `5Boxes`) the legacy OOXML schema has
50
54
  * no name for — a workbook that uses one is written with the rule in the x14 extension, which is
51
55
  * what Excel itself does, so offering them here costs no fidelity.
52
56
  */
53
- export declare const ICON_SET_GROUPS: readonly IconSetGroup[];
54
- /** The number of icons (and stops) in a named set — the leading digit of every OOXML set name. */
57
+ export declare const ICON_SET_GALLERY_BLOCKS: readonly IconSetGalleryBlock[];
58
+ /**
59
+ * The number of icons (and stops) in a named set — the leading digit of every OOXML set name.
60
+ *
61
+ * @remarks
62
+ * `NoIcons` is the one name with no digit that is still a known set; it holds none. Any other
63
+ * digitless name is unknown and reads as three.
64
+ */
55
65
  export declare const iconSetSize: (set: string) => number;
66
+ /** A ready-to-apply rule for a built-in set — the set at Excel's default even banding. */
67
+ export declare const iconSetPreset: (set: IStyle.IconSet) => IConditionalFormat.IconSet;
68
+ /**
69
+ * The per-band override that draws nothing — Excel's "No Cell Icon", spelled the way its x14
70
+ * writer spells it.
71
+ */
72
+ export declare const NO_CELL_ICON: Readonly<{
73
+ set: IStyle.IconSet;
74
+ id: number;
75
+ }>;
76
+ /**
77
+ * Returns the rule with one band's icon replaced.
78
+ *
79
+ * @remarks
80
+ * The override array is kept **full or absent**, never sparse. Excel writes an `x14:cfIcon` for
81
+ * every band once any is custom (`custom="1"`), so a partial array has no wire form; and a rule
82
+ * whose every band still draws its own icon carries no array at all, which keeps it a legacy
83
+ * (non-x14) rule until the user actually changes something.
84
+ *
85
+ * @param scale The rule to copy from. Not mutated.
86
+ * @param band The band to change, `0` being the lowest.
87
+ * @param icon The icon to draw there, or `null` to restore the band's own.
88
+ */
89
+ export declare const withIconOverride: (scale: IConditionalFormat.IconSet, band: number, icon: {
90
+ set: IStyle.IconSet;
91
+ id: number;
92
+ } | null) => IConditionalFormat.IconSet;
56
93
  //# sourceMappingURL=ConditionalFormatPresets.d.ts.map
@@ -93,6 +93,16 @@ export interface SheetElementProps extends React.HTMLAttributes<HTMLDivElement>,
93
93
  * @defaultValue true
94
94
  */
95
95
  showCellErrors?: boolean;
96
+ /**
97
+ * Mark the cells that are in a circular reference (a corner glyph on each cycle member).
98
+ *
99
+ * @remarks
100
+ * The value of such a cell stays `0`, as in Excel; the mark is metadata beside it. Cells that
101
+ * merely read a cycle are not marked — hover them for the tooltip.
102
+ *
103
+ * @defaultValue true
104
+ */
105
+ showCircularReferences?: boolean;
96
106
  /**
97
107
  * Properties for the column headers
98
108
  */
@@ -0,0 +1,26 @@
1
+ import { IRange, ISheet } from '@sheetxl/sdk';
2
+ /**
3
+ * The cell a sheet's status bar names for its circular references — Excel's
4
+ * `Worksheet.CircularReference`, one cell — or `null` when the sheet has none.
5
+ *
6
+ * @remarks
7
+ * The first cycle MEMBER on the sheet in row-major order, read off the `Feature.Circular`
8
+ * regions (engine-merged blocks, so a 1000-row downstream block costs one region). A sheet that
9
+ * only READS a cycle (every member is on another sheet) answers that cycle's representative,
10
+ * scoped to its own sheet, so the status bar can still point at the fix.
11
+ */
12
+ export declare const findSheetCircularReference: (sheet: ISheet) => IRange.CellCoords | null;
13
+ /**
14
+ * A cell address the way a formula on `sheetName` would write it: bare on its own sheet
15
+ * (`A1`), sheet-qualified elsewhere (`'Other Sheet'!A1`).
16
+ */
17
+ export declare const formatCellAddress: (coords: IRange.CellCoords, sheetName: string) => string;
18
+ /**
19
+ * Select `target` and scroll it into view, switching sheets when its `scope` names another one.
20
+ *
21
+ * @remarks
22
+ * The "go to" behind a circular tooltip's link and the status bar's readout. A `scope` this
23
+ * workbook does not know (a cycle member in a named formula's body) selects nothing.
24
+ */
25
+ export declare const selectCell: (sheet: ISheet, target: IRange.CellCoords) => Promise<unknown> | null;
26
+ //# sourceMappingURL=circularReferences.d.ts.map
@@ -4,4 +4,5 @@ export * from './SheetScrollbar';
4
4
  export * from './SheetCommands';
5
5
  export * from './ConditionalFormatPresets';
6
6
  export * from './SheetCommandProvider';
7
+ export * from './circularReferences';
7
8
  //# sourceMappingURL=index.d.ts.map