@dou-ui/sheet 0.0.0-stage → 0.1.0-alpha.0

package/dist/types/index.d.ts

@@ -0,0 +1,225 @@
+export declare const DouSheet: import("dou-ui").WithInstall<{
+    new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("./types").SheetProps> & Readonly<{
+        onPaste?: ((event: import("./types").SheetPasteEvent) => any) | undefined;
+        onImport?: ((event: import("./types").SheetImportEvent) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: import("./index.js").SheetWorkbook) => any) | undefined;
+        onTransaction?: ((tr: import("./index.js").SheetTransaction) => any) | undefined;
+        "onUpdate:selection"?: ((value: import("./index.js").SheetSelection) => any) | undefined;
+        "onUpdate:activeSheet"?: ((value: number) => any) | undefined;
+        onTransactionCancel?: ((tr: import("./index.js").SheetTransaction) => any) | undefined;
+        onLinkOpen?: ((event: import("./types").SheetLinkOpenEvent) => any) | undefined;
+        onFileError?: ((event: import("./types").SheetFileErrorEvent) => any) | undefined;
+        "onUpdate:comments"?: ((threads: import("dou-ui").CommentThread[]) => any) | undefined;
+        "onUpdate:activeComment"?: ((id: string | null) => any) | undefined;
+        onCommentAction?: ((action: import("dou-ui").CommentAction) => any) | undefined;
+    }>, import("./types").SheetExpose, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+        paste: (event: import("./types").SheetPasteEvent) => any;
+        import: (event: import("./types").SheetImportEvent) => any;
+        "update:modelValue": (value: import("./index.js").SheetWorkbook) => any;
+        transaction: (tr: import("./index.js").SheetTransaction) => any;
+        "update:selection": (value: import("./index.js").SheetSelection) => any;
+        "update:activeSheet": (value: number) => any;
+        transactionCancel: (tr: import("./index.js").SheetTransaction) => any;
+        linkOpen: (event: import("./types").SheetLinkOpenEvent) => any;
+        fileError: (event: import("./types").SheetFileErrorEvent) => any;
+        "update:comments": (threads: import("dou-ui").CommentThread[]) => any;
+        "update:activeComment": (id: string | null) => any;
+        commentAction: (action: import("dou-ui").CommentAction) => any;
+    }, import("vue").PublicProps, {
+        readonly: boolean;
+        compare: import("./index.js").SheetWorkbook | null;
+        menu: (items: import("./types").SheetMenuItem[], context: import("./types").SheetMenuContext) => import("./types").SheetMenuItem[];
+        selection: import("./index.js").SheetSelection;
+        comments: import("dou-ui").CommentThread[];
+        messages: import("./locale").SheetMessagesOverride;
+        colWidth: number;
+        rowHeight: number;
+        author: import("dou-ui").CommentAuthor;
+        outline: boolean;
+        ariaLabel: string;
+        activeSheet: number;
+        headers: boolean;
+        gridlines: boolean;
+        historyDepth: number;
+        extensions: (import("./index.js").SheetExtension | import("./index.js").SheetExtension[])[];
+        fileDrop: boolean;
+        activeComment: string | null;
+        commentable: boolean;
+    }, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import("./types").SheetProps> & Readonly<{
+        onPaste?: ((event: import("./types").SheetPasteEvent) => any) | undefined;
+        onImport?: ((event: import("./types").SheetImportEvent) => any) | undefined;
+        "onUpdate:modelValue"?: ((value: import("./index.js").SheetWorkbook) => any) | undefined;
+        onTransaction?: ((tr: import("./index.js").SheetTransaction) => any) | undefined;
+        "onUpdate:selection"?: ((value: import("./index.js").SheetSelection) => any) | undefined;
+        "onUpdate:activeSheet"?: ((value: number) => any) | undefined;
+        onTransactionCancel?: ((tr: import("./index.js").SheetTransaction) => any) | undefined;
+        onLinkOpen?: ((event: import("./types").SheetLinkOpenEvent) => any) | undefined;
+        onFileError?: ((event: import("./types").SheetFileErrorEvent) => any) | undefined;
+        "onUpdate:comments"?: ((threads: import("dou-ui").CommentThread[]) => any) | undefined;
+        "onUpdate:activeComment"?: ((id: string | null) => any) | undefined;
+        onCommentAction?: ((action: import("dou-ui").CommentAction) => any) | undefined;
+    }>, import("./types").SheetExpose, {}, {}, {}, {
+        readonly: boolean;
+        compare: import("./index.js").SheetWorkbook | null;
+        menu: (items: import("./types").SheetMenuItem[], context: import("./types").SheetMenuContext) => import("./types").SheetMenuItem[];
+        selection: import("./index.js").SheetSelection;
+        comments: import("dou-ui").CommentThread[];
+        messages: import("./locale").SheetMessagesOverride;
+        colWidth: number;
+        rowHeight: number;
+        author: import("dou-ui").CommentAuthor;
+        outline: boolean;
+        ariaLabel: string;
+        activeSheet: number;
+        headers: boolean;
+        gridlines: boolean;
+        historyDepth: number;
+        extensions: (import("./index.js").SheetExtension | import("./index.js").SheetExtension[])[];
+        fileDrop: boolean;
+        activeComment: string | null;
+        commentable: boolean;
+    }>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import("vue").ComponentOptionsBase<Readonly<import("./types").SheetProps> & Readonly<{
+    onPaste?: ((event: import("./types").SheetPasteEvent) => any) | undefined;
+    onImport?: ((event: import("./types").SheetImportEvent) => any) | undefined;
+    "onUpdate:modelValue"?: ((value: import("./index.js").SheetWorkbook) => any) | undefined;
+    onTransaction?: ((tr: import("./index.js").SheetTransaction) => any) | undefined;
+    "onUpdate:selection"?: ((value: import("./index.js").SheetSelection) => any) | undefined;
+    "onUpdate:activeSheet"?: ((value: number) => any) | undefined;
+    onTransactionCancel?: ((tr: import("./index.js").SheetTransaction) => any) | undefined;
+    onLinkOpen?: ((event: import("./types").SheetLinkOpenEvent) => any) | undefined;
+    onFileError?: ((event: import("./types").SheetFileErrorEvent) => any) | undefined;
+    "onUpdate:comments"?: ((threads: import("dou-ui").CommentThread[]) => any) | undefined;
+    "onUpdate:activeComment"?: ((id: string | null) => any) | undefined;
+    onCommentAction?: ((action: import("dou-ui").CommentAction) => any) | undefined;
+}>, import("./types").SheetExpose, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {
+    paste: (event: import("./types").SheetPasteEvent) => any;
+    import: (event: import("./types").SheetImportEvent) => any;
+    "update:modelValue": (value: import("./index.js").SheetWorkbook) => any;
+    transaction: (tr: import("./index.js").SheetTransaction) => any;
+    "update:selection": (value: import("./index.js").SheetSelection) => any;
+    "update:activeSheet": (value: number) => any;
+    transactionCancel: (tr: import("./index.js").SheetTransaction) => any;
+    linkOpen: (event: import("./types").SheetLinkOpenEvent) => any;
+    fileError: (event: import("./types").SheetFileErrorEvent) => any;
+    "update:comments": (threads: import("dou-ui").CommentThread[]) => any;
+    "update:activeComment": (id: string | null) => any;
+    commentAction: (action: import("dou-ui").CommentAction) => any;
+}, string, {
+    readonly: boolean;
+    compare: import("./index.js").SheetWorkbook | null;
+    menu: (items: import("./types").SheetMenuItem[], context: import("./types").SheetMenuContext) => import("./types").SheetMenuItem[];
+    selection: import("./index.js").SheetSelection;
+    comments: import("dou-ui").CommentThread[];
+    messages: import("./locale").SheetMessagesOverride;
+    colWidth: number;
+    rowHeight: number;
+    author: import("dou-ui").CommentAuthor;
+    outline: boolean;
+    ariaLabel: string;
+    activeSheet: number;
+    headers: boolean;
+    gridlines: boolean;
+    historyDepth: number;
+    extensions: (import("./index.js").SheetExtension | import("./index.js").SheetExtension[])[];
+    fileDrop: boolean;
+    activeComment: string | null;
+    commentable: boolean;
+}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: import("./types").SheetSlots;
+}), import("vue").HTMLAttributes>;
+export declare const DouSheetTabs: import("dou-ui").WithInstall<import("vue").DefineComponent<{
+    addable?: boolean;
+}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{
+    addable?: boolean;
+}> & Readonly<{}>, {
+    addable: boolean;
+}, {}, {}, {}, string, import("vue").ComponentProvideOptions, false, {}, any>, import("vue").HTMLAttributes>;
+export declare const DouSheetToolbar: import("dou-ui").WithInstall<{
+    new (...args: any[]): import("vue").CreateComponentPublicInstanceWithMixins<Readonly<import("./types").SheetToolbarProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, import("vue").PublicProps, {}, false, {}, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, {}, any, import("vue").ComponentProvideOptions, {
+        P: {};
+        B: {};
+        D: {};
+        C: {};
+        M: {};
+        Defaults: {};
+    }, Readonly<import("./types").SheetToolbarProps> & Readonly<{}>, {}, {}, {}, {}, {}>;
+    __isFragment?: never;
+    __isTeleport?: never;
+    __isSuspense?: never;
+} & import("vue").ComponentOptionsBase<Readonly<import("./types").SheetToolbarProps> & Readonly<{}>, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, {}, {}, string, {}, import("vue").GlobalComponents, import("vue").GlobalDirectives, string, import("vue").ComponentProvideOptions> & import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps & (new () => {
+    $slots: import("./types").SheetToolbarSlots;
+}), import("vue").HTMLAttributes>;
+export declare const DouSheetFormulaBar: import("dou-ui").WithInstall<import("vue").DefineComponent<{}, {}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, {}, string, import("vue").PublicProps, Readonly<{}> & Readonly<{}>, {}, {}, {}, {}, string, import("vue").ComponentProvideOptions, true, {}, any>, import("vue").HTMLAttributes>;
+export default DouSheet;
+export { useSheet, sheetContextKey } from './context';
+export { useSheetFormulas } from './formulas';
+export type { SheetFormulas } from './formulas';
+export type { SheetContext, SheetEditInputOptions, SheetEditorContext, SheetRangeRect, SheetRect, } from './context';
+export { defineSheetExtension, resolveSheetExtensions } from './core/extension';
+export type { ResolvedSheetExtensions, SheetExtension, SheetExtensionContext, SheetCommentsProvider, SheetHistoryHandler, SheetKeyHandler, SheetUpdate, } from './core/extension';
+export { keepCommentAnchors, sheetCommentAnchors } from './core/comments';
+export { diffWorkbooks, restoreWorkbook } from './core/versions';
+export type { SheetCellChange, WorkbookDiff } from './core/versions';
+export type { SheetCommentAnchor } from './core/comments';
+export { defineSheetCommand } from './core/commands';
+export { createFileSource, csvExporter, csvImporter, defineSheetExporter, defineSheetImporter, SheetFileError, exportWorkbook, readWorkbook, } from './core/file';
+export type { SheetCSVExportOptions, SheetExporter, SheetExporterInfo, SheetExportScope, SheetExportWorkbookOptions, SheetFileSheet, SheetFileSource, SheetFileSourceOptions, SheetFileView, SheetImportContext, SheetImporter, SheetImporterInfo, SheetImportResult, SheetImportWarning, SheetReadWorkbookOptions, } from './core/file';
+export type { SheetCommand, SheetCommandInfo, SheetCommands, SheetLabel } from './core/commands';
+export { defineSheetCellType, optionOf, resolveCellType } from './core/cell-type';
+export type { SheetCellPanelExpose, SheetCellPanelProps, SheetCellRenderProps, SheetCellType, SheetDrawContext, SheetDrawRect, SheetDrawTextOptions, SheetResolvedType, } from './core/cell-type';
+export type { SheetEmits, SheetFormatOption, SheetSlots, SheetToolbarProps, SheetToolbarSlots, SheetToolbarTool, SheetToolbarItem, SheetExpose, SheetExportFileOptions, SheetExporterOptions, SheetExporterOptionsOf, SheetFileErrorEvent, SheetSaveFileOptions, SheetImportEvent, SheetImportMode, SheetImportFileOptions, SheetInvalidCell, SheetExportOptions, SheetImageOptions, SheetPrintOptions, SheetMenuContext, SheetMenuItem, SheetLinkOpenEvent, SheetPasteEvent, SheetProps, } from './types';
+export { boundsOf, columnIndex, columnName, formatCell, formatRange, moveReferences, dropReferences, renameReferences, renameReferencesAll, parseCell, parseRange, quoteSheet, shiftFormula, splitSheet, } from './core/address';
+export { formatClip, parseClip, parseTSV } from './core/clipboard';
+export { detectDelimiter, parseCSV, readCSV, sheetToCSV } from './core/csv';
+export type { SheetCSVReadOptions, SheetCSVWriteOptions } from './core/csv';
+export type { SheetClip, SheetClipFormat } from './core/clipboard';
+export { continueValues, fillContinues } from './core/fill';
+export type { SheetFillMode, SheetFillOptions } from './core/fill';
+export type { SheetBounds, SheetCellTarget, SheetPoint, SheetRange, SheetRefMap, } from './core/address';
+export { cellOf, valueOf } from './core/model';
+export { checkWorkbook, emptyWorkbook, migrateWorkbook } from './core/document';
+export type { CheckWorkbookOptions, WorkbookProblem } from './core/document';
+export type { SheetCell, SheetCellInput, SheetColor, SheetCondition, SheetConditionalAverage, SheetConditionalBar, SheetConditionalDuplicates, SheetConditionalFormat, SheetConditionalFormula, SheetConditionalRank, SheetConditionalScale, SheetConditionalStyle, SheetConditionalUnique, SheetConditionalWhen, SheetData, SheetFilter, SheetFilterRule, SheetFreeze, SheetProtection, SheetRow, SheetRuleRange, SheetSelectOption, SheetSortOrder, SheetStyle, SheetTypeSetup, SheetValidation, SheetValidationFormula, SheetValidationList, SheetValidationWhen, SheetValue, SheetWorkbook, } from './core/model';
+export { compareForSort, meetsRule, sortRows, textCollator } from './core/data';
+export type { SheetSortKey } from './core/data';
+export { changeDecimals, formatValue, parseInput } from './core/format';
+export type { SheetInput } from './core/format';
+export { isSelected, selectCell } from './core/selection';
+export type { SheetSelection } from './core/selection';
+export type { SheetSearchQuery, SheetMatch } from './core/find';
+export { checkProtection, isLocked, protectionOf } from './core/protect';
+export { linkTarget } from './core/link';
+export type { SheetLinkTarget } from './core/link';
+export type { SheetProtectionCheck, SheetProtectionRefusal } from './core/protect';
+export { applySheetSteps, compactSheetSteps, sheetKey, SheetTransaction } from './core/transaction';
+export type { SheetAction, SheetAxisName, SheetCellAt, SheetLinesAt, SheetBookPatch, SheetPatch, SheetRangeAt, SheetRef, SheetStep, SheetStylePatch, SheetTransactionMeta, } from './core/transaction';
+export { criteriaOf, defineSheetFunction, numbersOf, scalarOf } from './formula/functions';
+export { compareValues, dateText, serialOf, toBoolean, toNumber, toText } from './formula/values';
+export type { SheetFunction, SheetFunctionContext } from './formula/functions';
+export { isSheetError, SheetError } from './formula/error';
+export type { SheetErrorCode } from './formula/error';
+export type { SheetArg, SheetRangeArg, SheetResult } from './formula/values';
+export { sheetMessagesFor, sheetLocales } from './locale';
+export { useSheetMessages } from './use-messages';
+export type { SheetCommentMessages, SheetCompareMessages, SheetFileMessages, SheetMessages, SheetMessagesOverride, } from './locale';
+declare module 'vue' {
+    interface GlobalComponents {
+        DouSheet: typeof DouSheet;
+        DouSheetTabs: typeof DouSheetTabs;
+        DouSheetToolbar: typeof DouSheetToolbar;
+        DouSheetFormulaBar: typeof DouSheetFormulaBar;
+    }
+}
+export type { DrawCell, DrawLook, DrawTheme, SheetDrawing } from './export/draw';
+export { lightThemeColor, plainStyle } from './core/paint';