Add-OfficeExcelReportKpiRow

Aliases: ExcelReportKpiRow

Namespace PSWriteOffice

Aliases

ExcelReportKpiRow

Inputs

None

Source

Sources/PSWriteOffice/Cmdlets/Excel/OfficeExcelReportBlockCommands.cs:178 Edit on GitHub

Adds a KPI row to the current Excel report sheet.

Remarks

Adds a KPI row to the current Excel report sheet.

Examples

Authored help example

Add three KPI values to a summary sheet.

PS>


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.

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.

Syntax

Add-OfficeExcelReportKpiRow -InputObject <Object> [-LabelFillColor <String>] [-PassThru] [-PerRow <Int32>] [<CommonParameters>]

Parameter set: All Parameter Sets

Parameters

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