SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface AutoFitOptions

    Options for ICellRange.autoFit.

    interface AutoFitOptions {
        author?: Author;
        autoSelect?: boolean | ITypes.SelectOptions;
        axes?: AxisSelection;
        description?: string;
        expandOnly?: boolean | Axis;
        expectedCommitId?: string;
        formulaView?: boolean;
        minContent?: boolean;
        readOnly?: boolean;
        skipCustomSize?: boolean;
    }

    Hierarchy (View Summary)

    Index
    author? autoSelect? axes? description? expandOnly? expectedCommitId? formulaView? minContent? readOnly? skipCustomSize?
    author?: Author

    Who authored this change. Recorded on the commit (ICommit.getAuthor).

    the store's author, else null (unattributed)

    autoSelect?: boolean | ITypes.SelectOptions

    If true or set then this will select the affect item after the transaction is complete.

    If this is set to true then any restore will also select.

    axes?: AxisSelection

    The axes to autoFit.

    IRange.AxisSelection.Both
    description?: string

    A human description.

    'determined by the set operation and locale'
    expandOnly?: boolean | Axis

    Restricts autoFit to only grow, never shrink.

    false - adjust in both directions.

    This is useful when adjusting fonts and wan the columns to resize but not the rows.

    expectedCommitId?: string

    Optimistic concurrency guard. If set, the operation only begins if the store's current commit id matches; otherwise a TransactionConflictError is thrown.

    The check happens atomically as the root transaction begins — there is no window between check and commit. If any transaction is already open the check fails with reason open (the head could move beneath the operation).

    formulaView?: boolean

    Fit to what formula view displays rather than to the rendered values.

    the sheet view's ISheetView.isShowFormulas

    In formula view a cell with a formula shows = + its formula text, and every other cell shows its raw value with no number format. Both are usually much wider than the formatted value, which is why Excel also renders columns at twice their stored width while it is on.

    Normally left unset — autoFit follows the view. Pass it explicitly to fit for a view other than the current one (or, in tests, without a view at all).

    minContent?: boolean

    Best fit using the minimum amount of space required.

    false

    When true the numbers will include as few decimals as allowed overflow into the next cell. For example allowing numbers to round or use scientific notation.

    readOnly?: boolean

    Declares the operation read-only: any state update within it throws.

    false

    Writes are tracked automatically — a batch that performs no updates never creates a commit (no new commit id, no events, no undo entry) whether or not this is set. The flag is purely an assertion for callers that want the guarantee enforced. Nested transactions inherit it; they cannot opt back out.

    skipCustomSize?: boolean

    If this is set to true then any headers that have custom sizes will be ignored.

    false

    Settings
    Member Visibility

    On This Page
    Properties