API Reference
Command
New-BGInfoChart
Creates a BGInfo chart definition.
Remarks
Creates a BGInfo chart definition.
Examples
EXAMPLE 1
New-BGInfoChart -Anchor 'Value'
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
New-BGInfoChart [-Anchor <TopLeft>] [-BackgroundColor <Object>] [-BarGap <Single>] [-DonutCenterLabel <String>] [-DonutCenterValue <String>] [-DonutInnerRadiusRatio <Double>] [-FillColor <Object>] [-FontFamilyName <String>] [-GridColor <Object>] [-GridLineCount <Int32>] [-Height <Int32>] [-Id <String>] [-Kind <Sparkline>] [-Labels <String[]>] [-LegendPosition <Bottom|Top|Left|Right>] [-LineColor <Object>] [-Maximum <Double>] [-MaxPoints <Int32>] [-Metric <CpuPercent>] [-MetricArgument <String>] [-Minimum <Double>] [-NoCircleStatusLabel] [-NoDonutCenterLabel] [-NoHistory] [-NoProgressHandles] [-NoProgressValues] [-NoRadialBarCenterLabel] [-OffsetX <Int32>] [-OffsetY <Int32>] [-Padding <Int32>] [-Palette <Object[]>] [-PictorialColumns <Int32>] [-PictorialSymbol <Circle>] [-PositionX <Int32>] [-PositionY <Int32>] [-ProgressBarThicknessRatio <Double>] [-RangeEnds <Double[]>] [-ReplaceHistory] [-ShowDataLabels] [-ShowGrid] [-ShowLatestValue] [-ShowLegend] [-ShowPointLegend] [-Target <Double>] [-TextColor <Object>] [-Title <String>] [-TitleFontSize <Single>] [-Value <Double>] [-ValueFontSize <Single>] [-ValueFormat <String>] [-ValueSuffix <String>] [-Width <Int32>] [<CommonParameters>]Parameter set:
SingleParameters
- Anchor BgInfoTextPosition
- Anchor position for placement.
- Possible values:
TopLeft,TopCenter,TopRight,MiddleLeft,MiddleCenter,MiddleRight,BottomLeft,BottomCenter,BottomRight - BackgroundColor Object
- Background color for the chart block.
- BarGap Single
- Gap between bars (0-1).
- DonutCenterLabel String
- Donut center label text.
- DonutCenterValue String
- Donut center value text.
- DonutInnerRadiusRatio Double
- Donut inner radius ratio.
- FillColor Object
- Fill color for sparklines.
- FontFamilyName String
- Font family for title and value.
- GridColor Object
- Grid line color.
- GridLineCount Int32
- Number of horizontal grid lines.
- Height Int32
- Chart height in pixels.
- Id String
- Chart identifier used for history storage.
- Kind BgInfoChartKind
- Chart kind to render, such as Sparkline, Line, Area, Bar, HorizontalBar, Gauge, Circle, RadialBar, Bullet, Pie, Donut, ProgressBar, or Pictorial.
- Possible values:
Sparkline,Line,Area,Bar,HorizontalBar,Gauge,Circle,RadialBar,Bullet,Pie,Donut,ProgressBar,Pictorial - Labels String[]
- Optional labels used by point-based charts.
- LegendPosition BgInfoChartLegendPosition
- Chart legend position.
- Possible values:
Bottom,Top,Left,Right - LineColor Object
- Line or bar color.
- Maximum Double
- Optional maximum scale value.
- MaxPoints Int32
- Maximum number of samples to keep in history.
- Metric BgInfoChartMetric
- Built-in metric source used when no explicit values are provided.
- Possible values:
CpuPercent,MemoryPercent,DiskFreePercent,DiskUsedPercent,DiskFreeGb,UptimeHours,UptimeDays - MetricArgument String
- Optional metric argument (for example drive letter).
- Minimum Double
- Optional minimum scale value.
- NoCircleStatusLabel SwitchParameter
- Hide circle status label.
- NoDonutCenterLabel SwitchParameter
- Hide donut center label.
- NoHistory SwitchParameter
- Disable history storage and render only provided values.
- NoProgressHandles SwitchParameter
- Hide progress handles.
- NoProgressValues SwitchParameter
- Hide progress values.
- NoRadialBarCenterLabel SwitchParameter
- Hide radial-bar center label.
- OffsetX Int32
- Horizontal offset from the anchor.
- OffsetY Int32
- Vertical offset from the anchor.
- Padding Int32
- Padding inside the chart.
- Palette Object[]
- Palette colors for point-based charts.
- PictorialColumns Int32
- Pictorial symbols per row.
- PictorialSymbol BgInfoChartPictorialSymbol
- Pictorial chart symbol.
- Possible values:
Circle,Square,Diamond,Triangle,Star,Person - PositionX Int32
- Absolute X position for placement.
- PositionY Int32
- Absolute Y position for placement.
- ProgressBarThicknessRatio Double
- Progress-bar thickness ratio.
- RangeEnds Double[]
- Qualitative range ends used by bullet charts.
- ReplaceHistory SwitchParameter
- Replace history instead of appending values.
- ShowDataLabels SwitchParameter
- Show supported data labels.
- ShowGrid SwitchParameter
- Show chart grid lines.
- ShowLatestValue SwitchParameter
- Show the latest value text.
- ShowLegend SwitchParameter
- Show the chart legend.
- ShowPointLegend SwitchParameter
- Show point-level legend entries.
- Target Double
- Target value used by bullet charts.
- TextColor Object
- Text color for title/value.
- Title String
- Chart title displayed above the plot.
- TitleFontSize Single
- Title font size.
- Value Double
- Single value to append.
- ValueFontSize Single
- Value font size.
- ValueFormat String
- Format string for the latest value.
- ValueSuffix String
- Suffix appended to the latest value.
- Width Int32
- Chart width in pixels.
Outputs
PowerBGInfo.BgInfoChart
New-BGInfoChart [-Anchor <TopLeft>] [-BackgroundColor <Object>] [-BarGap <Single>] [-DonutCenterLabel <String>] [-DonutCenterValue <String>] [-DonutInnerRadiusRatio <Double>] [-FillColor <Object>] [-FontFamilyName <String>] [-GridColor <Object>] [-GridLineCount <Int32>] [-Height <Int32>] [-Id <String>] [-Kind <Sparkline>] [-Labels <String[]>] [-LegendPosition <Bottom|Top|Left|Right>] [-LineColor <Object>] [-Maximum <Double>] [-MaxPoints <Int32>] [-Metric <CpuPercent>] [-MetricArgument <String>] [-Minimum <Double>] [-NoCircleStatusLabel] [-NoDonutCenterLabel] [-NoHistory] [-NoProgressHandles] [-NoProgressValues] [-NoRadialBarCenterLabel] [-OffsetX <Int32>] [-OffsetY <Int32>] [-Padding <Int32>] [-Palette <Object[]>] [-PictorialColumns <Int32>] [-PictorialSymbol <Circle>] [-PositionX <Int32>] [-PositionY <Int32>] [-ProgressBarThicknessRatio <Double>] [-RangeEnds <Double[]>] [-ReplaceHistory] [-ShowDataLabels] [-ShowGrid] [-ShowLatestValue] [-ShowLegend] [-ShowPointLegend] [-Target <Double>] [-TextColor <Object>] [-Title <String>] [-TitleFontSize <Single>] [-ValueFontSize <Single>] [-ValueFormat <String>] [-Values <Double[]>] [-ValueSuffix <String>] [-Width <Int32>] [<CommonParameters>]Parameter set:
MultipleParameters
- Anchor BgInfoTextPosition
- Anchor position for placement.
- Possible values:
TopLeft,TopCenter,TopRight,MiddleLeft,MiddleCenter,MiddleRight,BottomLeft,BottomCenter,BottomRight - BackgroundColor Object
- Background color for the chart block.
- BarGap Single
- Gap between bars (0-1).
- DonutCenterLabel String
- Donut center label text.
- DonutCenterValue String
- Donut center value text.
- DonutInnerRadiusRatio Double
- Donut inner radius ratio.
- FillColor Object
- Fill color for sparklines.
- FontFamilyName String
- Font family for title and value.
- GridColor Object
- Grid line color.
- GridLineCount Int32
- Number of horizontal grid lines.
- Height Int32
- Chart height in pixels.
- Id String
- Chart identifier used for history storage.
- Kind BgInfoChartKind
- Chart kind to render, such as Sparkline, Line, Area, Bar, HorizontalBar, Gauge, Circle, RadialBar, Bullet, Pie, Donut, ProgressBar, or Pictorial.
- Possible values:
Sparkline,Line,Area,Bar,HorizontalBar,Gauge,Circle,RadialBar,Bullet,Pie,Donut,ProgressBar,Pictorial - Labels String[]
- Optional labels used by point-based charts.
- LegendPosition BgInfoChartLegendPosition
- Chart legend position.
- Possible values:
Bottom,Top,Left,Right - LineColor Object
- Line or bar color.
- Maximum Double
- Optional maximum scale value.
- MaxPoints Int32
- Maximum number of samples to keep in history.
- Metric BgInfoChartMetric
- Built-in metric source used when no explicit values are provided.
- Possible values:
CpuPercent,MemoryPercent,DiskFreePercent,DiskUsedPercent,DiskFreeGb,UptimeHours,UptimeDays - MetricArgument String
- Optional metric argument (for example drive letter).
- Minimum Double
- Optional minimum scale value.
- NoCircleStatusLabel SwitchParameter
- Hide circle status label.
- NoDonutCenterLabel SwitchParameter
- Hide donut center label.
- NoHistory SwitchParameter
- Disable history storage and render only provided values.
- NoProgressHandles SwitchParameter
- Hide progress handles.
- NoProgressValues SwitchParameter
- Hide progress values.
- NoRadialBarCenterLabel SwitchParameter
- Hide radial-bar center label.
- OffsetX Int32
- Horizontal offset from the anchor.
- OffsetY Int32
- Vertical offset from the anchor.
- Padding Int32
- Padding inside the chart.
- Palette Object[]
- Palette colors for point-based charts.
- PictorialColumns Int32
- Pictorial symbols per row.
- PictorialSymbol BgInfoChartPictorialSymbol
- Pictorial chart symbol.
- Possible values:
Circle,Square,Diamond,Triangle,Star,Person - PositionX Int32
- Absolute X position for placement.
- PositionY Int32
- Absolute Y position for placement.
- ProgressBarThicknessRatio Double
- Progress-bar thickness ratio.
- RangeEnds Double[]
- Qualitative range ends used by bullet charts.
- ReplaceHistory SwitchParameter
- Replace history instead of appending values.
- ShowDataLabels SwitchParameter
- Show supported data labels.
- ShowGrid SwitchParameter
- Show chart grid lines.
- ShowLatestValue SwitchParameter
- Show the latest value text.
- ShowLegend SwitchParameter
- Show the chart legend.
- ShowPointLegend SwitchParameter
- Show point-level legend entries.
- Target Double
- Target value used by bullet charts.
- TextColor Object
- Text color for title/value.
- Title String
- Chart title displayed above the plot.
- TitleFontSize Single
- Title font size.
- ValueFontSize Single
- Value font size.
- ValueFormat String
- Format string for the latest value.
- Values Double[]
- Multiple values to append or replace.
- ValueSuffix String
- Suffix appended to the latest value.
- Width Int32
- Chart width in pixels.
Outputs
PowerBGInfo.BgInfoChart