SheetXL - v1.0.2
    Preparing search index...

    Interface JSON

    JSON representation of an IWorksheet used for serialization and deserialization.

    interface JSON {
        autoTable?: JSONReference<ITable.JSON>;
        baseColSize?: number;
        cellControls?: JSONReference<ICellControl.JSON>[];
        codeName?: string;
        cols?: JSONReference<ICellHeader.JSON>[];
        comments?: JSONReference<IComment.JSON>[];
        conditionalFormatCalculation?: boolean;
        conditionals?: JSONReference<IConditionalFormat.JSON>[];
        data?: GridTuple<JSON>;
        defaultColSize?: number;
        defaultRowSize?: number;
        directStyles?: JSONReferenceTuple<number>[];
        entireSize?: Partial<Size>;
        entireSizeFit?: { height?: boolean; width?: boolean };
        excludeFromPublishing?: boolean;
        formulaArray?: JSONReferenceTuple<FormulaArrayKind>[];
        formulas?: JSONReferenceTuple<string>[];
        hyperlinks?: JSONReference<IHyperlink.JSON>[];
        ignoredErrors?: JSONReference<ICell.ErrorCheck[]>[];
        legacyDrawing?: LegacyDrawingJSON;
        legacyDrawingHF?: LegacyDrawingJSON;
        merges?: Address[];
        modules?: Record<string, CompiledModule>;
        movables?: IMovable.JSON<any>[];
        outline?: IOutline.JSON;
        pageLayout?: IPageLayout.JSON;
        picture?: IPicture.JSON;
        pivotTables?: IPivotTable.JSON[];
        protectedRanges?: JSONReference<IProtectedRange.JSON>[];
        protection?: IWorksheetProtection.JSON;
        resources?: IResource.JSON[];
        richData?: JSON[];
        richTypes?: JSON[];
        rows?: JSONReference<ICellHeader.JSON>[];
        sparklineGroups?: JSONReference<ISparklineGroup.JSON>[];
        strings?: string[];
        styles?: IStyleCollection.JSON;
        syncScroll?: SyncScroll;
        tabColor?: string;
        tables?: JSONReference<ITable.JSON>[];
        transitionFormulaEntry?: boolean;
        transitionFormulaEvaluation?: boolean;
        validations?: JSONReference<IDataValidation.JSON>[];
        validationSettings?: Settings;
        view?: IWorksheetView.JSON;
        volatile?: Address[];
    }

    Hierarchy (View Summary)

    Index
    autoTable? baseColSize? cellControls? codeName? cols? comments? conditionalFormatCalculation? conditionals? data? defaultColSize? defaultRowSize? directStyles? entireSize? entireSizeFit? excludeFromPublishing? formulaArray? formulas? hyperlinks? ignoredErrors? legacyDrawing? legacyDrawingHF? merges? modules? movables? outline? pageLayout? picture? pivotTables? protectedRanges? protection? resources? richData? richTypes? rows? sparklineGroups? strings? styles? syncScroll? tabColor? tables? transitionFormulaEntry? transitionFormulaEvaluation? validations? validationSettings? view? volatile?
    autoTable?: JSONReference<ITable.JSON>
    baseColSize?: number

    The width, in digits of the Normal font, that the default column width is derived from when there is no defaultColSize. Absent, 8.

    cellControls?: JSONReference<ICellControl.JSON>[]
    codeName?: string

    The sheet's VBA code name. Absent when it has none.

    IWorksheet.getCodeName

    cols?: JSONReference<ICellHeader.JSON>[]

    Column headers, each addressed as an entire-column run ('E:E', 'E:H').

    Can be empty. The address carries the orientation, so a row address is read here too.

    comments?: JSONReference<IComment.JSON>[]

    The comments and notes, one per cell, each thread with its replies.

    IWorksheet.getComments

    conditionalFormatCalculation?: boolean

    Present, as false, only when conditional format calculation is turned off.

    IWorksheet.isConditionalFormatCalculationEnabled

    conditionals?: JSONReference<IConditionalFormat.JSON>[]
    data?: GridTuple<JSON>
    defaultColSize?: number
    defaultRowSize?: number
    directStyles?: JSONReferenceTuple<number>[]

    Either an object with RangeAddress to style id or an array of RangeCoordValue to style id.

    entireSize?: Partial<Size>

    If specified this indicates the entire range of the sheet.

    entireSizeFit?: { height?: boolean; width?: boolean }

    The axes of entireSize that end where the content does.

    IWorksheet.setEntireSize

    excludeFromPublishing?: boolean

    IWorksheet.isExcludedFromPublishing

    formulaArray?: JSONReferenceTuple<FormulaArrayKind>[]

    The extent occupied by an array formula, and which of the three kinds of array formula it is.

    Every array formula earns an entry, degenerate 1x1 ones included - a 1x1 extent is not the same thing as no extent. Only the kind distinguishes a fixed one-cell block from a dynamic formula that happened not to spill; the extent cannot.

    formulas?: JSONReferenceTuple<string>[]
    hyperlinks?: JSONReference<IHyperlink.JSON>[]
    ignoredErrors?: JSONReference<ICell.ErrorCheck[]>[]

    The cells where Excel's error checks are ignored (the green triangle's Ignore Error): each reference's value is the set of checks its cells ignore.

    ICellRange.setErrorIgnored

    legacyDrawing?: LegacyDrawingJSON

    The sheet's legacy drawing: note boxes and form control shapes.

    IWorksheet.LegacyDrawingJSON

    legacyDrawingHF?: LegacyDrawingJSON

    The legacy drawing for the sheet's header and footer, which holds their pictures.

    IWorksheet.LegacyDrawingJSON

    merges?: Address[]
    modules?: Record<string, CompiledModule>

    Modules owned by this sheet, keyed by module name.

    IWorksheet.getModules

    movables?: IMovable.JSON<any>[]
    outline?: IOutline.JSON

    The outline settings that differ from their defaults.

    IWorksheet.getOutline

    pageLayout?: IPageLayout.JSON

    The print layout settings that differ from their defaults.

    IWorksheet.getPageLayout

    picture?: IPicture.JSON

    The sheet's picture.

    pivotTables?: IPivotTable.JSON[]

    The sheet's pivot tables.

    IWorksheet.getPivotTables

    protectedRanges?: JSONReference<IProtectedRange.JSON>[]
    protection?: IWorksheetProtection.JSON
    resources?: IResource.JSON[]
    richData?: JSON[]

    The rich values cells name by id ({ t: 'r', v: id }), when the sheet owns its own.

    richTypes?: JSON[]

    The kinds richData names that are not registered in code (a kind read from a file).

    rows?: JSONReference<ICellHeader.JSON>[]

    Row headers, each addressed as an entire-row run ('5:5', '5:12').

    Can be empty. The address carries the orientation, so a column address is read here too.

    sparklineGroups?: JSONReference<ISparklineGroup.JSON>[]

    The sparkline groups. Each group's ranges pair by position with the areas of its data.

    strings?: string[]
    styles?: IStyleCollection.JSON
    syncScroll?: SyncScroll

    IWorksheet.getSyncScroll

    tabColor?: string
    tables?: JSONReference<ITable.JSON>[]
    transitionFormulaEntry?: boolean

    IWorksheet.isTransitionFormulaEntry

    transitionFormulaEvaluation?: boolean

    IWorksheet.isTransitionFormulaEvaluation

    validations?: JSONReference<IDataValidation.JSON>[]
    validationSettings?: Settings

    IDataValidationCollection.getSettings

    view?: IWorksheetView.JSON
    volatile?: Address[]

    Settings
    Member Visibility

    On This Page
    Properties