@office-kit/xlsx 0.8.0

package/dist/workbook/views.d.ts

@@ -0,0 +1,89 @@
+export type WorkbookViewVisibility = 'visible' | 'hidden' | 'veryHidden';
+export interface WorkbookView {
+    visibility?: WorkbookViewVisibility;
+    minimized?: boolean;
+    showHorizontalScroll?: boolean;
+    showVerticalScroll?: boolean;
+    showSheetTabs?: boolean;
+    /** Window x position in screen pixels — Excel restores it when re-opening. */
+    xWindow?: number;
+    /** Window y position. */
+    yWindow?: number;
+    windowWidth?: number;
+    windowHeight?: number;
+    /** Width of the sheet tab strip relative to the horizontal scroll bar (0..1000, default 600). */
+    tabRatio?: number;
+    /** Index of the leftmost visible sheet tab (0-based). */
+    firstSheet?: number;
+    /** Index of the currently active sheet tab (0-based). */
+    activeTab?: number;
+    autoFilterDateGrouping?: boolean;
+}
+export declare const makeWorkbookView: (opts?: WorkbookView) => WorkbookView;
+export type CustomViewShowComments = 'commNone' | 'commIndicator' | 'commIndAndComment';
+export type CustomViewShowObjects = 'all' | 'placeholders' | 'none';
+export interface CustomWorkbookView {
+    name: string;
+    guid: string;
+    /** Window width in screen pixels — required when the element is present. */
+    windowWidth: number;
+    windowHeight: number;
+    /** Index (0-based) of the sheet active in this saved view. */
+    activeSheetId: number;
+    autoUpdate?: boolean;
+    /** Auto-merge interval in minutes (for shared workbooks). */
+    mergeInterval?: number;
+    changesSavedWin?: boolean;
+    onlySync?: boolean;
+    personalView?: boolean;
+    includePrintSettings?: boolean;
+    includeHiddenRowCol?: boolean;
+    maximized?: boolean;
+    minimized?: boolean;
+    showHorizontalScroll?: boolean;
+    showVerticalScroll?: boolean;
+    showSheetTabs?: boolean;
+    xWindow?: number;
+    yWindow?: number;
+    tabRatio?: number;
+    showFormulaBar?: boolean;
+    showStatusbar?: boolean;
+    showComments?: CustomViewShowComments;
+    showObjects?: CustomViewShowObjects;
+}
+export declare const makeCustomWorkbookView: (opts: Pick<CustomWorkbookView, "name" | "guid" | "windowWidth" | "windowHeight" | "activeSheetId"> & Partial<CustomWorkbookView>) => CustomWorkbookView;
+import type { Workbook } from './workbook';
+/** Get the index of the active sheet tab (0-based) from the primary workbookView, or 0 if unset. */
+export declare const getActiveTab: (wb: Workbook) => number;
+/** Set the active sheet tab (0-based) on the primary workbookView. */
+export declare const setActiveTab: (wb: Workbook, index: number) => void;
+/** Get the index of the leftmost visible sheet tab from the primary workbookView, or 0 if unset. */
+export declare const getFirstSheet: (wb: Workbook) => number;
+/** Set the leftmost visible sheet tab on the primary workbookView. */
+export declare const setFirstSheet: (wb: Workbook, index: number) => void;
+/** Set the tab strip width ratio (0..1000, Excel default 600). */
+export declare const setTabRatio: (wb: Workbook, ratio: number) => void;
+/** Toggle the sheet tab strip visibility. */
+export declare const setShowSheetTabs: (wb: Workbook, show: boolean) => void;
+/** Toggle the horizontal scroll bar in Excel's window chrome. */
+export declare const setShowHorizontalScroll: (wb: Workbook, show: boolean) => void;
+/** Toggle the vertical scroll bar in Excel's window chrome. */
+export declare const setShowVerticalScroll: (wb: Workbook, show: boolean) => void;
+/**
+ * Toggle the workbook window minimised state. Excel honours this on
+ * reopen so the file restores into the minimised state it was saved
+ * with.
+ */
+export declare const setWorkbookMinimized: (wb: Workbook, minimized: boolean) => void;
+/** Set the visibility of the workbook window itself ('visible' / 'hidden' / 'veryHidden'). */
+export declare const setWorkbookVisibility: (wb: Workbook, visibility: WorkbookViewVisibility) => void;
+/**
+ * Set window position + size on the primary workbookView in one call.
+ * Pass `undefined` for any axis to leave it untouched.
+ */
+export declare const setWorkbookWindow: (wb: Workbook, opts: {
+    xWindow?: number;
+    yWindow?: number;
+    windowWidth?: number;
+    windowHeight?: number;
+}) => void;

package/dist/workbook/workbook-properties.d.ts

@@ -0,0 +1,57 @@
+export type ShowObjectsMode = 'all' | 'placeholders' | 'none';
+export type UpdateLinksMode = 'userSet' | 'never' | 'always';
+export interface WorkbookProperties {
+    /**
+     * Mac 1904 epoch flag. Mirrored from `Workbook.date1904` — the
+     * canonical source. Setting it here has no effect on the cell-serial
+     * conversion path, which keys off the top-level field.
+     */
+    date1904?: boolean;
+    /** Excel 5/95 ↔ 2007 compatibility hint. */
+    dateCompatibility?: boolean;
+    showObjects?: ShowObjectsMode;
+    showBorderUnselectedTables?: boolean;
+    filterPrivacy?: boolean;
+    promptedSolutions?: boolean;
+    showInkAnnotation?: boolean;
+    backupFile?: boolean;
+    /** Cache external-link values when saving. */
+    saveExternalLinkValues?: boolean;
+    /** "Update remote links" prompt mode. */
+    updateLinks?: UpdateLinksMode;
+    /** VBA codeName for the workbook (e.g. "ThisWorkbook" / "ЭтаКнига"). */
+    codeName?: string;
+    hidePivotFieldList?: boolean;
+    showPivotChartFilter?: boolean;
+    allowRefreshQuery?: boolean;
+    publishItems?: boolean;
+    checkCompatibility?: boolean;
+    autoCompressPictures?: boolean;
+    refreshAllConnections?: boolean;
+    /** Theme schema version (Excel 2007 = 124226, 2013+ = 153222). */
+    defaultThemeVersion?: number;
+}
+export declare const makeWorkbookProperties: (opts?: WorkbookProperties) => WorkbookProperties;
+import type { Workbook } from './workbook';
+/**
+ * Set the workbook-level VBA codeName ("ThisWorkbook" by default in
+ * Excel; localised forms like "ЭтаКнига" round-trip too). Empty string
+ * is allowed — Excel writes it that way for codename-stripped files.
+ */
+export declare const setWorkbookCodeName: (wb: Workbook, codeName: string) => void;
+/**
+ * Toggle the Mac 1904 epoch. The canonical flag is `wb.date1904`
+ * (drives cell-serial conversion); this helper writes both the
+ * canonical field and the mirror on `workbookProperties` so a save
+ * emits a consistent `<workbookPr date1904="…">` attribute.
+ */
+export declare const setDate1904: (wb: Workbook, on: boolean) => void;
+/**
+ * Set the "Update remote links" prompt mode. `'userSet'` keeps
+ * Excel's per-user preference; `'never'` disables the prompt;
+ * `'always'` forces it. Mirrors the Trust Center "External Content"
+ * dropdown.
+ */
+export declare const setUpdateLinksMode: (wb: Workbook, mode: UpdateLinksMode) => void;
+/** Toggle the "filterPrivacy" hint Excel writes to indicate filter contents may be sensitive. */
+export declare const setFilterPrivacy: (wb: Workbook, on: boolean) => void;