Project

PSWriteOffice

PowerShell document automation across OfficeIMO's document, spreadsheet, presentation, PDF, Project, Access, EPUB, invoicing, and conversion engines.

View on GitHub Releases Get package
Stars 654
Forks 82
Open issues 1
Total downloads 4,320,051
Release OfficeIMO-v3.5.3
Language: C# Updated: 2026-11-03
Cmdlet

Add-OfficeExcelReportKpiRow

Aliases: ExcelReportKpiRow
Module
PSWriteOffice
Aliases
ExcelReportKpiRow
Inputs
None
Source
OfficeExcelReportBlockCommands.cs:178 Edit on GitHub

Adds a KPI row to the current Excel report sheet.

Syntax

Add-OfficeExcelReportKpiRow
[-InputObject] <Object>
[-LabelFillColor <String>]
[-PassThru]
[-PerRow <Int32>]
[<CommonParameters>]
#
Parameter set: All Parameter Sets

Examples

Add three KPI values to a summary sheet.

New-OfficeExcel -Path .\Operations.xlsx {
    Add-OfficeExcelReportSheet -Name Summary {
        Add-OfficeExcelReportKpiRow -InputObject @{ Revenue = 125000; Incidents = 3; Status = 'Ready' } -PerRow 3
    }
}

Renders PowerShell key/value data as a KPI row through the OfficeIMO sheet composer.

Parameters

-InputObject Object requiredposition: 0aliases: Data
Hashtable or objects with Label/Value, Key/Value, Name/Value, or Title/Value properties.
-LabelFillColor String optional
Optional fill color for KPI labels.
-PassThru SwitchParameter optional
Emit the object created or changed by the command.
-PerRow Int32 optional
Number of KPI cards per rendered row.

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.