en-US/UniversalDashboard-help.xml
|
<?xml version="1.0" encoding="utf-8"?>
<helpItems schema="maml" xmlns="http://msh"> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Get-UDCookie</command:name> <command:verb>Get</command:verb> <command:noun>UDCookie</command:noun> <maml:description> <maml:para>Gets a cookie from the HTTP request.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Gets a cookie from the HTTP request. This cmdlet should be called within endpoints.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Get-UDCookie</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie to return.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDInput -Title "Get a cookie" -Endpoint { param() $Cookie = Get-UDCookie -Name "MyCookie" New-UDInputAction -Toast $Cookie.Value }</dev:code> <dev:remarks> <maml:para>Returns the value of MyCookie as a Toast when the user clicks the submit button.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>New-UDChartDataset</command:name> <command:verb>New</command:verb> <command:noun>UDChartDataset</command:noun> <maml:description> <maml:para>Creates a dataset for use with Out-UDChartData</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates a dataset for use with Out-UDChartData. This is an advanced scenario cmdlet that allows you to create multiple datasets within a single chart.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-UDChartDataset</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DataProperty</maml:name> <maml:Description> <maml:para>The property to select as the data for the y value of the chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>A label of this dataset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>AdditionalOptions</maml:name> <maml:Description> <maml:para>Additional options to pass to the dataset. This value can be different depending on the type of chart specified. See the ChartJS documentation for more information. http://www.chartjs.org/docs/latest/charts/line.html</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>The background color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>BorderColor</maml:name> <maml:Description> <maml:para>The border color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BorderWidth</maml:name> <maml:Description> <maml:para>The width of the border in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>HoverBackgroundColor</maml:name> <maml:Description> <maml:para>The hover background color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>HoverBorderColor</maml:name> <maml:Description> <maml:para>The hover border color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>HoverBorderWidth</maml:name> <maml:Description> <maml:para>The hover width of the border in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>XAxisId</maml:name> <maml:Description> <maml:para>The ID of the X axis. Used for advanced properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>YAxisId</maml:name> <maml:Description> <maml:para>The ID of the Y axis. Used for advanced properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="10" aliases="none"> <maml:name>AdditionalOptions</maml:name> <maml:Description> <maml:para>Additional options to pass to the dataset. This value can be different depending on the type of chart specified. See the ChartJS documentation for more information. http://www.chartjs.org/docs/latest/charts/line.html</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>The background color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>BorderColor</maml:name> <maml:Description> <maml:para>The border color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>BorderWidth</maml:name> <maml:Description> <maml:para>The width of the border in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>DataProperty</maml:name> <maml:Description> <maml:para>The property to select as the data for the y value of the chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>HoverBackgroundColor</maml:name> <maml:Description> <maml:para>The hover background color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>HoverBorderColor</maml:name> <maml:Description> <maml:para>The hover border color of the dataset in the chart. Should be in rgba() syntax.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>HoverBorderWidth</maml:name> <maml:Description> <maml:para>The hover width of the border in pixels.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Int32</command:parameterValue> <dev:type> <maml:name>Int32</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Label</maml:name> <maml:Description> <maml:para>A label of this dataset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>XAxisId</maml:name> <maml:Description> <maml:para>The ID of the X axis. Used for advanced properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="9" aliases="none"> <maml:name>YAxisId</maml:name> <maml:Description> <maml:para>The ID of the Y axis. Used for advanced properties.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDChart -Type Bar -Title "Memory" -Endpoint { Get-Process -Name chrome | Out-UDChartData -LabelProperty "Id" -Dataset @( New-UDChartDataset -DataProperty "WorkingSet" -Label "Working Set" -BackgroundColor "rgb(63,123,3)" New-UDChartDataset -DataProperty "PeakWorkingSet" -Label "Peak Working Set" -BackgroundColor "rgb(134,342,122)" New-UDChartDataset -DataProperty "VirtualMemorySize" -Label "Virtual Memory Size" -BackgroundColor "rgb(234,33,43)" ) }</dev:code> <dev:remarks> <maml:para>Creates a chart with different datasets of different types of memory usage.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDChartData</command:name> <command:verb>Out</command:verb> <command:noun>UDChartData</command:noun> <maml:description> <maml:para>Outputs data in a format that the ChartJS control understands.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data in a format that the ChartJS control understands.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDChartData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>Data to display in the chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DataProperty</maml:name> <maml:Description> <maml:para>The property to select as the y-axis of the data set. This should be used in conjunction with LabelProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>LabelProperty</maml:name> <maml:Description> <maml:para>The property to select as the dataset label (x-axis). This should be used in conjunction with DataProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DatasetLabel</maml:name> <maml:Description> <maml:para>The label for a dataset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Dataset</maml:name> <maml:Description> <maml:para>A collection of hashtables created by New-UDChartDataset. This allows for multiple datasets to be represented on a single chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>BorderColor</maml:name> <maml:Description> <maml:para>Border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>HoverBackgroundColor</maml:name> <maml:Description> <maml:para>Hover background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>HoverBorderColor</maml:name> <maml:Description> <maml:para>Hover border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="5" aliases="none"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="6" aliases="none"> <maml:name>BorderColor</maml:name> <maml:Description> <maml:para>Border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>Data to display in the chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>DataProperty</maml:name> <maml:Description> <maml:para>The property to select as the y-axis of the data set. This should be used in conjunction with LabelProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="4" aliases="none"> <maml:name>Dataset</maml:name> <maml:Description> <maml:para>A collection of hashtables created by New-UDChartDataset. This allows for multiple datasets to be represented on a single chart.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Hashtable[]</command:parameterValue> <dev:type> <maml:name>Hashtable[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="3" aliases="none"> <maml:name>DatasetLabel</maml:name> <maml:Description> <maml:para>The label for a dataset.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="7" aliases="none"> <maml:name>HoverBackgroundColor</maml:name> <maml:Description> <maml:para>Hover background colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="8" aliases="none"> <maml:name>HoverBorderColor</maml:name> <maml:Description> <maml:para>Hover border colors for the chart data.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">DashboardColor[]</command:parameterValue> <dev:type> <maml:name>DashboardColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>LabelProperty</maml:name> <maml:Description> <maml:para>The property to select as the dataset label (x-axis). This should be used in conjunction with DataProperty.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDChart -Type Line -Title "CPU" -Endpoint { Get-Process -Name chrome | Out-UDChartData -LabelProperty "Id" -DataProperty "CPU" }</dev:code> <dev:remarks> <maml:para>Outputs data from Get-Process and selects the Id as the label (x-axis) and the CPU as the data (y-axis).</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>Example 2</maml:title> <dev:code>PS C:\> New-UDChart -Type Bar -Title "Memory" -Endpoint { Get-Process -Name chrome | Out-UDChartData -LabelProperty "Id" -Dataset @( New-UDChartDataset -DataProperty "WorkingSet" -Label "Working Set" -BackgroundColor "rgb(63,123,3)" New-UDChartDataset -DataProperty "PeakWorkingSet" -Label "Peak Working Set" -BackgroundColor "rgb(134,342,122)" New-UDChartDataset -DataProperty "VirtualMemorySize" -Label "Virtual Memory Size" -BackgroundColor "rgb(234,33,43)" ) }</dev:code> <dev:remarks> <maml:para>Outputs data from Get-Process and selects WorkingSet, PeakWorkingSet and VritualMemorySize as data sets from the output.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDGridData</command:name> <command:verb>Out</command:verb> <command:noun>UDGridData</command:noun> <maml:description> <maml:para>Outputs data in a format that the jQuery DataTables grid will support.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data in a format that the jQuery DataTables grid will support.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDGridData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The data to output.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TotalItems</maml:name> <maml:Description> <maml:para>{{Fill TotalItems Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoAutoPage</maml:name> <maml:Description> <maml:para>This cmdlet automatically pages data down to the client. To disable this feature, specify this parameter.</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The data to output.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>NoAutoPage</maml:name> <maml:Description> <maml:para>This cmdlet automatically pages data down to the client. To disable this feature, specify this parameter.</maml:para> </maml:Description> <command:parameterValue required="false" variableLength="false">SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>TotalItems</maml:name> <maml:Description> <maml:para>{{Fill TotalItems Description}}</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDGrid -Title "Process Information" -Headers @("Name", "Process Id", "Start Time", "Responding") -Properties @("Name", "Id", "StartTime", "Responding") -Endpoint { Get-Process -Name Chrome | Out-UDGridData }</dev:code> <dev:remarks> <maml:para>Outputs the data from Get-Process to a New-UDGrid</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDMonitorData</command:name> <command:verb>Out</command:verb> <command:noun>UDMonitorData</command:noun> <maml:description> <maml:para>Outputs data for the New-UDMonitor components.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data for the New-UDMonitor components. The data value should be a single data point.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDMonitorData</maml:name> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>A single data point on the running monitor.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>A single data point on the running monitor.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDMonitor -Type Line -Title "Available Memory" -RefreshInterval 1 -DataPointHistory 100 -Endpoint { Get-Counter '\Memory\Available MBytes' | Select-Object -ExpandProperty CounterSamples | Select -ExpandProperty CookedValue | Out-UDMonitorData }</dev:code> <dev:remarks> <maml:para>Outputs the available memory on the current machine.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Out-UDTableData</command:name> <command:verb>Out</command:verb> <command:noun>UDTableData</command:noun> <maml:description> <maml:para>Outputs data as a table.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Outputs data as a table.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Out-UDTableData</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The data to show in the table.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>The properties, or columns, to display in the table. Should match the -Header parameter of New-UDTable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="True (ByValue)" position="0" aliases="none"> <maml:name>Data</maml:name> <maml:Description> <maml:para>The data to show in the table.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Property</maml:name> <maml:Description> <maml:para>The properties, or columns, to display in the table. Should match the -Header parameter of New-UDTable.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String[]</command:parameterValue> <dev:type> <maml:name>String[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDTable -Title "Process Ids" -Header @("Name", "Process Id") -Endpoint { Get-Process -Name Chrome | Out-UDTableData -Property @("name", "id") }</dev:code> <dev:remarks> <maml:para>Outputs data from Get-Process as a table. Selects the Name and ID property from each item.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Remove-UDCookie</command:name> <command:verb>Remove</command:verb> <command:noun>UDCookie</command:noun> <maml:description> <maml:para>Removes an HTTP cookie</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Removes an HTTP cookie. This cmdlet is intended to be called in an Endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Remove-UDCookie</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CookieOptions</maml:name> <maml:Description> <maml:para>HTTP cookie options for the cookie to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CookieOptions</command:parameterValue> <dev:type> <maml:name>CookieOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>CookieOptions</maml:name> <maml:Description> <maml:para>HTTP cookie options for the cookie to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CookieOptions</command:parameterValue> <dev:type> <maml:name>CookieOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie to remove.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDInput -SubmitText "Remove Cookie" -Endpoint { param() Remove-UDCookie -Name "Hello" New-UDInputAction -Toast "Cookie removed" }</dev:code> <dev:remarks> <maml:para>Removes the cookie "Hello" when the user clicks the Remove Cookie button.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDBackwardsCompatbility</command:name> <command:verb>Set</command:verb> <command:noun>UDBackwardsCompatbility</command:noun> <maml:description> <maml:para>Creates aliases for backwards compatibility.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Creates aliases for backwards compatibility.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDBackwardsCompatbility</maml:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> Set-UDBackwardsCompatbility PS C:\> Start-Dashboard -Dashboard { New-Dashboard }</dev:code> <dev:remarks> <maml:para>Creates a dashboard using the old cmdlet names.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> <command:command xmlns:maml="http://schemas.microsoft.com/maml/2004/10" xmlns:command="http://schemas.microsoft.com/maml/dev/command/2004/10" xmlns:dev="http://schemas.microsoft.com/maml/dev/2004/10" xmlns:MSHelp="http://msdn.microsoft.com/mshelp"> <command:details> <command:name>Set-UDCookie</command:name> <command:verb>Set</command:verb> <command:noun>UDCookie</command:noun> <maml:description> <maml:para>Sets an HTTP cookie to a specified value.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>Sets an HTTP cookie to a specified value. This cmdlet is intended to be called from an endpoint.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>Set-UDCookie</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The value of the cookie.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>CookieOptions</maml:name> <maml:Description> <maml:para>Cookie options for the cookie.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CookieOptions</command:parameterValue> <dev:type> <maml:name>CookieOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="2" aliases="none"> <maml:name>CookieOptions</maml:name> <maml:Description> <maml:para>Cookie options for the cookie.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">CookieOptions</command:parameterValue> <dev:type> <maml:name>CookieOptions</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="none"> <maml:name>Name</maml:name> <maml:Description> <maml:para>The name of the cookie.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="1" aliases="none"> <maml:name>Value</maml:name> <maml:Description> <maml:para>The value of the cookie.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.Object</maml:name> </dev:type> <maml:description> <maml:para></maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para></maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>Example 1</maml:title> <dev:code>PS C:\> New-UDInput -Id "Input" -Title "Input Cookie" -Endpoint { param([string]$Name, [string]$Value) Set-UDCookie -Name $Name -Value $Value }</dev:code> <dev:remarks> <maml:para>Sets a cookie to the HTTP session based on the name and value specified by the user.</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks /> </command:command> </helpItems> |