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

    Interface RenderRegionsOptions

    Options for renderRegions.

    interface RenderRegionsOptions {
        maxCategories?: number;
        maxProfileCells?: number;
        maxProfiled?: number;
        maxRegions?: number;
        maxSeries?: number;
        recovery?: string;
    }

    Hierarchy (View Summary)

    Index
    maxCategories?: number

    Distinct values listed for a categorical series before ….

    3
    
    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 a Contentful listing — the rest list address and size only.

    Lower than maxRegions on purpose: listing a region is one line and one lookup, while profiling it scans its cells. A sheet with 400 stray labels should still list all 400 without paying 400 scans, and the listing says plainly which ones went undescribed so the reader can ask for the rest rather than assume there was nothing to say.

    12
    
    maxRegions?: number

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

    200
    
    maxSeries?: number

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

    24
    
    recovery?: string

    How to recover the regions the cap ate — appended to the overflow line.

    A cap is a report-length decision, and "raise it" is the one recovery that does not scale: the reader who needs all 400 regions needs them in a loop, not in a longer listing. Sections that know the query behind the listing — a sheet report's feature partition knows its sheet and its feature — pass the call that returns the whole set, so the next step is an SDK query rather than a knob.

    a pointer at narrowing the range