@sheetxl/sdk 0.8.0-beta.10 → 0.8.0-beta.12

package/types/src/print/IPrint.d.ts

@@ -1,212 +0,0 @@
-import { IRange } from '@sheetxl/primitives';
-/**
- * Namespace for print-related configurations and settings.
- */
-export declare namespace IPrint {
-    /**
-     * Interface representing multi-page print options.
-     */
-    interface MultiPage {
-        /**
-         * Whether content should be aligned with the page margins.
-         */
-        alignWithMargins?: boolean;
-        /**
-         * Specifies if the first page is different from subsequent pages.
-         */
-        differentFirst?: boolean;
-        /**
-         * Specifies if odd and even pages should have different settings.
-         */
-        differentOddEven?: boolean;
-        /**
-         * Whether the content should scale proportionally with the document.
-         */
-        scaleWithDoc?: boolean;
-    }
-    /**
-     * Interface for configuring headers and footers for print, supporting
-     * different settings for first, odd, and even pages.
-     */
-    interface HeaderFooter extends MultiPage {
-        /**
-         * Configuration for general header and footer settings.
-         */
-        headerFooter?: MultiPage;
-        /**
-         * Configuration for the footer on even pages.
-         */
-        evenFooter?: MultiPage;
-        /**
-         * Configuration for the header on even pages.
-         */
-        evenHeader?: MultiPage;
-        /**
-         * Configuration for the footer on the first page.
-         */
-        firstFooter?: MultiPage;
-        /**
-         * Configuration for the header on the first page.
-         */
-        firstHeader?: MultiPage;
-        /**
-         * Configuration for the footer on odd pages.
-         */
-        oddFooter?: MultiPage;
-        /**
-         * Configuration for the header on odd pages.
-         */
-        oddHeader?: MultiPage;
-    }
-    /**
-     * Interface representing the margins of a printed page, specified in inches.
-     */
-    interface PageMargin {
-        /**
-         * Margin from the bottom of the page.
-         */
-        bottom?: number;
-        /**
-         * Distance of the footer from the bottom of the page.
-         */
-        footer: number;
-        /**
-         * Distance of the header from the top of the page.
-         */
-        header: number;
-        /**
-         * Margin from the left side of the page.
-         */
-        left: number;
-        /**
-         * Margin from the right side of the page.
-         */
-        right: number;
-        /**
-         * Margin from the top of the page.
-         */
-        top: number;
-    }
-    /**
-     * Interface for configuring page setup options for print.
-     */
-    interface PageSetup {
-        /**
-         * Whether to print in black and white.
-         */
-        blackAndWhite?: boolean;
-        /**
-         * Specifies how cell comments are printed.
-         * @see {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_CellComments_topic_ID0EXMDFB.html#topic_ID0EXMDFB}
-         */
-        cellComments?: string;
-        /**
-         * The number of copies to print.
-         */
-        copies?: number;
-        /**
-         * Whether to print in draft mode for quicker printing.
-         */
-        draft?: boolean;
-        /**
-         * Specifies how errors should be displayed in the print.
-         * @see {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_PrintError_topic_ID0EUTTFB.html#topic_ID0EUTTFB}
-         */
-        errors?: string;
-        /**
-         * The page number to start printing from.
-         */
-        firstPageNumber?: number;
-        /**
-         * The number of pages to fit vertically.
-         */
-        fitToHeight?: number;
-        /**
-         * The number of pages to fit horizontally.
-         */
-        fitToWidth?: number;
-        /**
-         * The horizontal DPI (dots per inch) for printing.
-         */
-        horizontalDpi?: number;
-        /**
-         * The orientation of the page (portrait or landscape).
-         * @see
-         * {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_Orientation_topic_ID0E4XPFB.html#topic_ID0E4XPFB}
-         */
-        orientation?: string;
-        /**
-         * Specifies the order of pages when printed.
-         * @see
-         * {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_ST_PageOrder_topic_ID0EN5PFB.html#topic_ID0EN5PFB}
-         */
-        pageOrder?: string;
-        /**
-         * Specifies the paper size for printing (enum values 1-68).
-         * @see
-         * {@link https://c-rex.net/samples/ooxml/e1/Part4/OOXML_P4_DOCX_pageSetup_topic_ID0EHZ54.html#topic_ID0EHZ54}
-         */
-        paperSize?: number;
-        /**
-         * Specifies the scaling factor for printing (between 10 and 400).
-         */
-        scale?: number;
-        /**
-         * Whether to use the first page number specified in `firstPageNumber`.
-         */
-        useFirstPageNumber?: boolean;
-        /**
-         * Whether to use the printer's default settings for the print job.
-         */
-        usePrinterDefaults?: boolean;
-        /**
-         * The vertical DPI (dots per inch) for printing.
-         */
-        verticalDpi?: number;
-    }
-    /**
-     * Interface for additional properties of page setup,
-     * such as auto page breaks and fitting content to a page.
-     */
-    interface PageSetUpProperties {
-        /**
-         * Whether to automatically break pages when content overflows.
-         */
-        autoPageBreak?: boolean;
-        /**
-         * Whether content should fit to a single page when printed.
-         */
-        fitToPage?: boolean;
-    }
-    /**
-     * Interface for configuring print options, such as grid lines
-     * and content alignment.
-     */
-    interface PrintOptions {
-        /**
-         * Whether to print grid lines on the sheet.
-         */
-        gridLines?: boolean;
-        /**
-         * Whether grid lines are explicitly set for printing.
-         */
-        gridLinesSet?: boolean;
-        /**
-         * Whether to print row and column headings.
-         */
-        headings?: boolean;
-        /**
-         * Whether content should be horizontally centered on the page.
-         */
-        horizontalCentered?: boolean;
-        /**
-         * Whether content should be vertically centered on the page.
-         */
-        verticalCentered?: boolean;
-    }
-    type Break = IRange.JSONReference<{
-        man?: boolean;
-        pt?: boolean;
-    }>;
-}
-//# sourceMappingURL=IPrint.d.ts.map

package/types/src/sheet/SheetCollection.d.ts

@@ -1,29 +0,0 @@
-import { ICollection, AbstractCollection } from '../type';
-import { IListener } from '../listener';
-import { ISheetCollection } from './ISheetCollection';
-import { ISheet } from './ISheet';
-/**
- * Implementation for {@link ISheetCollection}.
- *
- * @remarks
- * A front over the workbook's own sheet state — the workbook keeps the store and the events,
- * this class keeps the API. `onCollectionChange` is the workbook's `onSheetsChange`, forwarded
- * with this collection as the source.
- */
-export declare class SheetCollection extends AbstractCollection<ISheet, ISheetCollection.GetItemsOptions> implements ISheetCollection {
-    private _add;
-    private _get;
-    private _addListeners;
-    constructor(add: (options: ISheetCollection.AddOptions | string | number) => ISheet, get: (name?: string, visibility?: ISheet.Visibility) => ISheet[], addListeners: (listeners: ICollection.IListeners, options?: IListener.Options) => IListener.Remove);
-    /** {@inheritDoc ISheetCollection.add} */
-    add(options?: ISheetCollection.AddOptions | string | number): ISheet;
-    /** {@inheritDoc AbstractCollection._getItems} */
-    protected _getItems(options?: ISheetCollection.GetItemsOptions): ISheet[];
-    /** {@inheritDoc ISheetCollection.getByName} */
-    getByName(name: string): ISheet;
-    /** {@inheritDoc ICollection.addListeners} */
-    addListeners(listeners: ICollection.IListeners, options?: IListener.Options): IListener.Remove;
-    /** {@inheritDoc ISheetCollection.isISheetCollection} */
-    get isISheetCollection(): true;
-}
-//# sourceMappingURL=SheetCollection.d.ts.map

package/types/src/sheetProtection/SheetProtection.d.ts

@@ -1,51 +0,0 @@
-import { DefaultProtection } from '../protection/DefaultProtection';
-import { ISheetProtection } from './ISheetProtection';
-export declare class SheetProtection extends DefaultProtection<ISheetProtection, ISheetProtection.Properties, ISheetProtection.JSON> implements ISheetProtection {
-    /** {@inheritDoc ISheetProtection.isAutoTableAllowed} */
-    isAutoTableAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isDeleteColumnsAllowed} */
-    isDeleteColumnsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isDeleteRowsAllowed} */
-    isDeleteRowsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isFormatCellsAllowed} */
-    isFormatCellsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isFormatColumnsAllowed} */
-    isFormatColumnsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isFormatRowsAllowed} */
-    isFormatRowsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isInsertColumnsAllowed} */
-    isInsertColumnsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isInsertHyperlinksAllowed} */
-    isInsertHyperlinksAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isInsertRowsAllowed} */
-    isInsertRowsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isObjectsAllowed} */
-    isObjectsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isPivotTablesAllowed} */
-    isPivotTablesAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isScenariosAllowed} */
-    isScenariosAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isSortAllowed} */
-    isSortAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isShowFormulasAllowed} */
-    isShowFormulasAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isSelectLockedCellsAllowed} */
-    isSelectLockedCellsAllowed(): boolean;
-    /** {@inheritDoc ISheetProtection.isSelectUnlockedCellsAllowed} */
-    isSelectUnlockedCellsAllowed(): boolean;
-    /**
-     * A property that a locked sheet must deny explicitly: unset is allowed, and read-only does not
-     * deny it. The opposite of {@link _isPropertyAllowed}, which a locked sheet must grant explicitly.
-     */
-    protected _isPropertyAllowedByDefault(property: ISheetProtection.PropertyKeys): boolean;
-    protected _getAllowedKey(): string;
-    protected _updateProperties(properties: ISheetProtection.Properties | null): void;
-    protected _clearProperties(): void;
-    protected _fromJSON(json: ISheetProtection.JSON | null): void;
-    protected _toJSON(json: ISheetProtection.JSON): ISheetProtection.JSON;
-    get [Symbol.toStringTag](): string;
-    toString(): string;
-    /** {@inheritDoc ISheetProtection.isISheetProtection} */
-    get isISheetProtection(): true;
-}
-//# sourceMappingURL=SheetProtection.d.ts.map

package/types/src/sheetView/SheetView.d.ts

@@ -1,122 +0,0 @@
-import { IRange } from '@sheetxl/primitives';
-import { TopLeft } from '@sheetxl/utils';
-import { IListener } from '../listener';
-import { IColor } from '../color';
-import { IMovableSelection, IRangeSelection } from '../selection';
-import { ISheet } from '../sheet';
-import { ListenerEmitter } from '../listener/ListenerEmitter';
-import { ISheetView } from './ISheetView';
-/**
- * Default Sheet View
- */
-export declare class SheetView implements ISheetView {
-    protected _state: ISheetView.Properties;
-    protected _sheet: ISheet;
-    protected _rangeSelection: IRangeSelection;
-    protected _rangeSelectionRemoveListener: IListener.Remove;
-    protected _emitter: ListenerEmitter<ISheetView, ISheetView.IListeners>;
-    protected _movableSelection: IMovableSelection;
-    protected _movableSelectionRemoveListener: IListener.Remove;
-    protected _id: string;
-    constructor(options: ISheetView.ConstructorOptions);
-    /** {@inheritDoc ISheetView.getId} */
-    getId(): string;
-    /** {@inheritDoc ISheetView.addListeners} */
-    addListeners(listeners: ISheetView.IListeners, options?: IListener.Options): IListener.Remove;
-    /** {@inheritDoc ISheetView.setTopLeft} */
-    setTopLeft(topLeft: Partial<TopLeft>): this;
-    /** {@inheritDoc ISheetView.getTopLeft} */
-    getTopLeft(): TopLeft;
-    /** {@inheritDoc ISheetView.getTopLeftCell} */
-    getTopLeftCell(): IRange.CellCoords;
-    /** {@inheritDoc ISheetView.getFreezePanes} */
-    getFreezePanes(): ISheetView.FreezePanes;
-    /** {@inheritDoc ISheetView.setFreezePanes} */
-    setFreezePanes(freezePanes: Partial<ISheetView.FreezePanes> | null): this;
-    protected _mergeFreezePanes(freezePanes: Partial<ISheetView.FreezePanes> | null): Partial<ISheetView.FreezePanes>;
-    /** {@inheritDoc ISheetView.isShowRowHeaders} */
-    isShowRowHeaders(): boolean;
-    /** {@inheritDoc ISheetView.setShowRowHeaders} */
-    setShowRowHeaders(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowColumnHeaders} */
-    isShowColumnHeaders(): boolean;
-    /** {@inheritDoc ISheetView.setShowColumnHeaders} */
-    setShowColumnHeaders(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowRowGridlines} */
-    isShowRowGridlines(): boolean;
-    /** {@inheritDoc ISheetView.setShowRowGridlines} */
-    setShowRowGridlines(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowColumnGridlines} */
-    isShowColumnGridlines(): boolean;
-    /** {@inheritDoc ISheetView.setShowColumnGridlines} */
-    setShowColumnGridlines(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.getRowHeaderStyle} */
-    getRowHeaderStyle(): ISheetView.HeaderTextStyle;
-    /** {@inheritDoc ISheetView.setRowHeaderStyle} */
-    setRowHeaderStyle(newValue: ISheetView.HeaderTextStyle): this;
-    /** {@inheritDoc ISheetView.setColumnHeaderStyle} */
-    setColumnHeaderStyle(newValue: ISheetView.HeaderTextStyle): this;
-    /** {@inheritDoc ISheetView.getColumnHeaderStyle} */
-    getColumnHeaderStyle(): ISheetView.HeaderTextStyle;
-    /** {@inheritDoc ISheetView.setColumnHeaderTableNames} */
-    setColumnHeaderTableNames(tableNames: ISheetView.ColumnHeaderTableNames): this;
-    /** {@inheritDoc ISheetView.getColumnHeaderTableNames} */
-    getColumnHeaderTableNames(): ISheetView.ColumnHeaderTableNames;
-    /** {@inheritDoc ISheetView.getZoomScale} */
-    getZoomScale(): number;
-    /** {@inheritDoc ISheetView.setZoomScale} */
-    setZoomScale(zoomScale: number): this;
-    /** {@inheritDoc ISheetView.zoomIn} */
-    zoomIn(): this;
-    /** {@inheritDoc ISheetView.zoomOut} */
-    zoomOut(): this;
-    protected _updateZoom(nextZoom: number): this;
-    /** {@inheritDoc ISheetView.getNextZoomScale} */
-    getNextZoomScale(zoomIn: boolean, amount?: number): number;
-    /** {@inheritDoc ISheetView.isShowFormulas} */
-    isShowFormulas(): boolean;
-    /** {@inheritDoc ISheetView.setShowFormulas} */
-    setShowFormulas(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowLockedShading} */
-    isShowLockedShading(): boolean;
-    /** {@inheritDoc ISheetView.setShowLockedShading} */
-    setShowLockedShading(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowInvalid} */
-    isShowInvalid(): boolean;
-    /** {@inheritDoc ISheetView.setShowInvalid} */
-    setShowInvalid(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isRightToLeft} */
-    isRightToLeft(): boolean;
-    /** {@inheritDoc ISheetView.setRightToLeft} */
-    setRightToLeft(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowZeros} */
-    isShowZeros(): boolean;
-    /** {@inheritDoc ISheetView.setShowZeros} */
-    setShowZeros(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.isShowOutlineSymbols} */
-    isShowOutlineSymbols(): boolean;
-    /** {@inheritDoc ISheetView.setShowOutlineSymbols} */
-    setShowOutlineSymbols(newValue: boolean): this;
-    /** {@inheritDoc ISheetView.getGridLineColor} */
-    getGridLineColor(): any;
-    /** {@inheritDoc ISheetView.setGridLineColor} */
-    setGridLineColor(newValue: IColor | null): this;
-    /** {@inheritDoc ISheetView.getRangeSelection} */
-    getRangeSelection(): IRangeSelection;
-    /** {@inheritDoc ISheetView.getMovableSelection} */
-    getMovableSelection(): IMovableSelection;
-    protected _update<T extends ISheetView.Properties[K], K extends keyof ISheetView.Properties>(newValue: T, property: K, event: keyof ISheetView.IListeners): T;
-    protected _notifyAll(): void;
-    /** {@inheritDoc ISheetView.toJSON} */
-    toJSON(): ISheetView.JSON | null;
-    protected _fromJSON(json: ISheetView.JSON): void;
-    /** {@inheritDoc ISheetView.clear} */
-    clear(notify?: boolean): this;
-    /** {@inheritDoc ISheetView.update} */
-    update(properties: Partial<ISheetView.Properties>): this;
-    get [Symbol.toStringTag](): string;
-    toString(): string;
-    /** {@inheritDoc ISheetView.isISheetView} */
-    get isISheetView(): true;
-}
-//# sourceMappingURL=SheetView.d.ts.map