SheetXL - v1.0.2
    Preparing search index...

    Interface RenderWorksheetOptions

    Options for renderWorksheet.

    interface RenderWorksheetOptions {
        features?: Feature | readonly Feature[];
        layerScope?: ICellRange;
        maxProfiled?: number;
        maxRegions?: number;
        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.

    layerScope?: ICellRange

    The extent the layers authored over cells list over, when it is not the range's: the Sparkline, Conditionals and DataValidations sections.

    They are not cell content, so a layer over empty cells lies outside the used range a sheet report is scoped to, as it does in Excel's UsedRange. A sheet report passes the whole sheet, so a layer that exists is always reported. Direct style stays scoped to the range: a column style is a format, not a layer, and its cells are not used either.

    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.

    profile?: boolean

    Profile the Contentful section's regions, as a standalone partition report does.

    false
    

    This adds depth, never breadth. Profiling describes the regions a partition already returned — it cannot produce more of them, so it is not the fragmentation that combining features causes. What it costs is report LENGTH: one line per series inside each profiled block, bounded by maxProfiled and by ProfileRegionOptions.maxSeries.

    Off by default because the two callers want different budgets, not because the answer is unwanted: a sheet report was directly asked about one sheet and can afford the depth, while a workbook report is routing across up to eight of them and profiles a few per sheet.