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

    Interface RenderCellRangeOptions

    Options for renderCellRange.

    interface RenderCellRangeOptions {
        features?: Feature | readonly Feature[];
        maxCategories?: number;
        maxCells?: number;
        maxProfileCells?: number;
        maxProfiled?: number;
        maxRegions?: number;
        maxSeries?: number;
        maxTreeRows?: number;
        mode?: CellEncoding.Mode;
        profile?: boolean;
    }

    Hierarchy (View Summary)

    Index
    features?: Feature | readonly Feature[]

    Narrows Counts and the feature partition sections to these features.

    every public feature
    

    A reporting filter, not a query one. Partitioning by feature is what ICellRange.getRegions is for and this does not duplicate it — it decides which of those partitions a report bothers to print, which is why it lives on the renderer and not on the range. --features fill,borders on a sheet with forty formatted regions is the difference between an answer and a haystack.

    The scalar kinds are accepted and reach Counts; they have no partition to list, so they never produce a section.

    maxCategories?: number

    Distinct values listed for a categorical series before ….

    3
    
    maxCells?: number

    Cap on rendered data cells; the report notes truncation when exceeded.

    1000
    
    maxProfileCells?: number

    Cells scanned per region. Above this the profile is taken from a leading slice and says so — the alternative is a report whose cost is unbounded in the size of the sheet.

    A scan budget, not a listing cap: it bounds what profiling reads, where every other max* bounds what a report prints. The distinction is the reason for the name — spelled maxCells it merged with RenderCellRangeOptions.maxCells on Renderer.Options, where one value silently shrank the values table and put every profile on a leading slice.

    20000
    
    maxProfiled?: number

    Cap on regions profiled in the Contentful section — the rest list address and size only, and the listing says how many went undescribed.

    12 — deferred to appendRegionList.

    maxRegions?: number

    Cap on regions listed per feature; the report notes truncation when exceeded.

    200 — deferred to appendRegionList, the one place the default lives.

    maxSeries?: number

    Series (columns, or rows on a wide block) described before the profile elides the rest.

    24
    
    maxTreeRows?: number

    Rows each tree prints before the rest of the graph is left to the flat call.

    A line budget, not a depth cut: the tree is filled level by level, so a budget that runs out drops the deepest nodes first, and every node with unshown children says how many.

    12
    

    How much formatting cell text carries.

    profile?: boolean

    Compute and print the Profile section — per-series counts, types and aggregates.

    true
    

    On by default here, unlike AppendFeatureOptions.profile (off by default for a sheet report's Contentful section): a sheet report is scanning every block on the caller's behalf, while this range was named directly, so the same budget reasoning argues the other way. Set false to skip the scan — e.g. a caller only after the raw values, or one already holding a getStats() result of its own.