en-US/CodeOwls.SeeShell.PowerShell.Cmdlets.dll-help.xml
|
<?xml version="1.0" encoding="utf-8" standalone="yes"?>
<helpItems schema="maml" 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"> <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"> <command:details> <command:name>Install-SeeShellLicense</command:name> <maml:description> <maml:para>Installs a SeeShell license from a string, file, or the clipboard.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Install</command:verb> <command:noun>SeeShellLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Installs a SeeShell license from a string, file, or the clipboard.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <command:name>Install-SeeShellLicense</command:name> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The license string, the path of the file containing the license string, or a file object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify this parameter to avoid being prompted to overwrite an existing license.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position="0"> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The license string, the path of the file containing the license string, or a file object.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Force</maml:name> <maml:description> <maml:para>Specify this parameter to avoid being prompted to overwrite an existing license.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para>Specify no pipeline input to use the current clipboard data as your SeeShell license.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>Specify no pipeline input to use the current clipboard data as your SeeShell license.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>String</maml:name> <maml:uri /> <maml:description> <maml:para>A string containing the SeeShell license, or the path of a file that contains the SeeShell license.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A string containing the SeeShell license, or the path of a file that contains the SeeShell license.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>File</maml:name> <maml:uri /> <maml:description> <maml:para>A file that contains the SeeShell license.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A file that contains the SeeShell license.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None.</maml:name> <maml:uri /> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>The clipboard can only be read when PowerShell is started in STA mode. If you attempt to read clipboard data in MTA mode, warnings and errors will result. For more information, type: powershell -help.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>SeeShell is licensed on a per-user basis. This cmdlet will only affect the license for the current user.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>The license string is isolated from surrounding data using special text markers. The license string must exist on a single line between the markers BEGIN_SEESHELL_LICENSE and END_SEESHELL_LICENSE. For example:</maml:para> <maml:para>...</maml:para> <maml:para>BEGIN_SEESHELL_LICENSE</maml:para> <maml:para>abcdef0123456789</maml:para> <maml:para>END_SEESHELL_LICENSE</maml:para> <maml:para>...</maml:para> <maml:para /> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- EXAMPLE 1 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>install-seeshelllicense</dev:code> <dev:remarks> <maml:para>Attempts to install a SeeShell license from the current contents of the clipboard. Note this will only work if PowerShell was started with the -sta switch.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 2 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>install-seeshelllicense 'abcdef01234356789'</dev:code> <dev:remarks> <maml:para>Installs the string "abcdef0123456789" as the SeeShell license for the current user.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 3 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>install-seeshelllicense '~\seeshell.license'</dev:code> <dev:remarks> <maml:para>Installs the SeeShell license from the file named "seeshell.license" located in the user's home folder.</maml:para> <maml:para /> <maml:para>Once this cmdlet completes, the file at ~\seeshell.license can be deleted without affecting the license state of SeeShell.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 4 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>ls *.license | install-seeshelllicense</dev:code> <dev:remarks> <maml:para>Installs the SeeShell license from the file that ends with extension ".license" located in the current directory.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_SeeShell_License</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Test-SeeShellLicense</maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name>Out-Chart</command:name> <maml:description> <maml:para>Visualizes data to a new or existing chart.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>Chart</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Visualizes data to a new or existing chart.</maml:para> <maml:para>A single chart visualization can contain multiple series of data. For example, a single chart can plot file length by file name as one series, and file line count by file name as another. Overlaying multiple series of data in a single chart is subject to limitations and guidelines described in the help topic: about_SeeShell_Charts.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <command:name>Out-Chart</command:name> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>HighFrom</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the upper data item for the Y Axis. This parameter is only valid when the Type parameter specifies a range series.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>LowFrom</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the lower data item for the Y Axis. This parameter is only valid when the Type parameter specifies a range series.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of series to plot in the chart.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">Bubble | Area | Column | Line | RangeArea | RangeColumn | SplineArea | Spline | StepArea | StepLine | Waterfall | PolarArea | PolarLine | PolarScatter | PolarSplineArea | PolarSpline | RadialArea | RadialColumn | RadialLine | RadialPie | ScatterLine | Scatter | ScatterSpline | Timeline</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>By</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the data to map to the X or radial axis.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>KeyOn</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series key for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Across</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series collection for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <command:name>Out-Chart</command:name> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>RadiusFrom</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the bubble radius data item for the Y Axis. This parameter is only valid when the Type parameter specifies a Bubble series.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of series to plot in the chart.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">Bubble | Area | Column | Line | RangeArea | RangeColumn | SplineArea | Spline | StepArea | StepLine | Waterfall | PolarArea | PolarLine | PolarScatter | PolarSplineArea | PolarSpline | RadialArea | RadialColumn | RadialLine | RadialPie | ScatterLine | Scatter | ScatterSpline | Timeline</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="true" pipelineInput="false" position=""> <maml:name>Plot</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the data to plot on the Y Axis.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>By</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the data for the X or radial Axis.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>KeyOn</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series key for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Across</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series collection for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>HighFrom</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the upper data item for the Y Axis. This parameter is only valid when the Type parameter specifies a range series.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>LowFrom</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the lower data item for the Y Axis. This parameter is only valid when the Type parameter specifies a range series.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>RadiusFrom</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the bubble radius data item for the Y Axis. This parameter is only valid when the Type parameter specifies a Bubble series.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Type</maml:name> <maml:description> <maml:para>The type of series to plot in the chart.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">CodeOwls.SeeShell.Common.Charts.ChartSeriesType</command:parameterValue> <dev:type> <maml:name>ChartSeriesType</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Area</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>By</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the data to map to the X or radial axis.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Plot</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the data to plot on the Y Axis.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>KeyOn</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series key for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Across</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series collection for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Data Source</maml:name> <maml:uri /> <maml:description> <maml:para>A reference to a data source object or a string containing the PowerShell path to a data source item on the datasources: drive. For information on creating data sources explicitly, see: about_SeeShell_DataSources.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A reference to a data source object or a string containing the PowerShell path to a data source item on the datasources: drive. For information on creating data sources explicitly, see: about_SeeShell_DataSources.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> <maml:description> <maml:para>A script block that emits data samples. Note that the script block will be run asynchronously. In addition, it will be evaluated in a runspace outside of the main PowerShell session, and will not be able to reference the local runspace state.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A script block that emits data samples. Note that the script block will be run asynchronously. In addition, it will be evaluated in a runspace outside of the main PowerShell session, and will not be able to reference the local runspace state.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para>A list of objects to visualize. The objects are considered a complete data set, with each object a single data sample.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A list of objects to visualize. The objects are considered a complete data set, with each object a single data sample.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>There are limitations to the chart series that can be overlaid on one another. For details, refer to: about_SeeShell_Charts.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>If the InputObject parameter is not an existing data source, an implicit data source will be created. Implicit data sources are limited to the default sample size of 20. If you require a larger sample size, create a data source explicitly.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>Script blocks can be piped to visualization cmdlets, but cannot be specified as parameters. This is due to the fact that script blocks are used as filters on pipeline input in PowerShell.</maml:para> <maml:para /> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- EXAMPLE 1 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>ls | out-chart -type column -name Files -plot Length -by Name</dev:code> <dev:remarks> <maml:para>Creates a column chart that plots file length by file name.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 2 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>ls | out-chart -type column -name Files -plot Length,{ $_ | get-content | measure -line | select -expand lines} -by Name</dev:code> <dev:remarks> <maml:para>Creates a column chart that plots file length and file line count by file name. The plot parameter can accept multiple property names, wildcards to match against property names, and script blocks that define individual data properties.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 3 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>{ get-counter '\processor(*)\% processor time' -continuous } | out-chart -type spline -name CPU -plot CookedValue -by Timestamp -across CounterSamples -keyon Path</dev:code> <dev:remarks> <maml:para>Creates a multi-series spline chart that plots performance counter data. The data source emits data samples containing multiple data items to plot. Using the -across parameter instructs SeeShell that the CounterSamples property of each data sample contains a collection of items to plot. The -keyon parameter instructs SeeShell that each series in the CounterSamples collection can be identified by the value of its Path property.</maml:para> <maml:para /> <maml:para>The script block will be executed asynchronously from the main PowerShell session thread and will not stop producing data until the PowerShell session is ended.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 4 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>out-chart -inputobject datasources:/mydata -type waterfall -name Chart -plot MyValue -by Name</dev:code> <dev:remarks> <maml:para>Creates a chart using a pre-existing datasource named MyData. This example assumes that a data source has been defined with the name MyData.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 5 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>out-chart -inputobject datasources:/rangeData -type RangeColumn -name Ranges -highFrom HiValue -lowFrom LoValue -by Name</dev:code> <dev:remarks> <maml:para>Creates a range column chart using a pre-existing datasource named RangeData. This example assumes that a data source has been defined with the name RangeData.</maml:para> <maml:para /> <maml:para>Range series (RangeColumn and RangeArea) plot two points of data per sample: a high value and a low value. The HighFrom parameter determines the property (or scriptblock) used as the high value for a data sample, and the LowFrom parameter determines the property (or scriptblock) used for the low value.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_SeeShell_DataSources</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_SeeShell_Charts</maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name>Out-Grid</command:name> <maml:description> <maml:para>Visualizes data to a new or existing grid.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>Grid</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Visualizes data to a new or existing grid.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <command:name>Out-Grid</command:name> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Data Source</maml:name> <maml:uri /> <maml:description> <maml:para>A reference to a data source object or a string containing the PowerShell path to a data source item on the datasources: drive. For information on creating data sources explicitly, see: about_SeeShell_DataSources.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A reference to a data source object or a string containing the PowerShell path to a data source item on the datasources: drive. For information on creating data sources explicitly, see: about_SeeShell_DataSources.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> <maml:description> <maml:para>A script block that emits data samples. Note that the script block will be run asynchronously. In addition, it will be evaluated in a runspace outside of the main PowerShell session, and will not be able to reference the local runspace state.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A script block that emits data samples. Note that the script block will be run asynchronously. In addition, it will be evaluated in a runspace outside of the main PowerShell session, and will not be able to reference the local runspace state.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para>A list of objects to visualize. The objects are considered a complete data set, with each object a single data sample.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A list of objects to visualize. The objects are considered a complete data set, with each object a single data sample.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>If the InputObject parameter is not an existing data source, an implicit data source will be created. Implicit data sources are limited to the default sample size of 20. If you require a larger sample size, create a data source explicitly.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>Script blocks can be piped to visualization cmdlets, but cannot be specified as parameters. This is due to the fact that script blocks are used as filters on pipeline input in PowerShell.</maml:para> <maml:para /> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- EXAMPLE 1 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>ls | out-grid -name Files</dev:code> <dev:remarks> <maml:para>Creates a grid that plots the properties for the list of files.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 2 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>{ get-counter '\processor(_total)\% processor time' -continuous | select -expand countersamples } | out-grid -name CPU</dev:code> <dev:remarks> <maml:para>Creates a grid that tracks performance counter data.</maml:para> <maml:para /> <maml:para>The script block will be executed asynchronously from the main PowerShell session thread and will not stop producing data until the PowerShell session is ended.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> \ </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_SeeShell_DataSources</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_SeeShell_Grids</maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name>Out-Timeline</command:name> <maml:description> <maml:para>Visualizes data to a new or existing timeline.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Out</command:verb> <command:noun>Timeline</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Visualizes data to a new or existing timeline.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <command:name>Out-Timeline</command:name> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>DetailsFrom</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the event details for the data sample. The value of the script block or property must evaluate to a string or the details will not be displayed in the timeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>DurationFrom</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the time duration for the data sample. If the timeline axis is datetime-based, this property must evalute to a TimeSpan value or an error will result. If the timeline axis is numeric, this property must evaluate to a number or an error will result.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Units</maml:name> <maml:description> <maml:para>The units to display on the timeline. Defaults to Auto. This parameter has no effect if the timeline axis is numeric.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">Auto | Days | Hours | Milliseconds | Minutes | Months | Seconds | Weeks | Years</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Plot</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the event title to plot on the timeline. The value of the script block or property must evaluate to a string or the title will not be displayed in the timeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>By</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the data to map to the timeline axis. The value of the property or script block must be a datetime or number or an error will result. If this value is a datetime, the timeline axis will be time-based; if it is a number, the axis will be numeric.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>KeyOn</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series key for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Across</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series collection for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>DetailsFrom</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the event details for the data sample. The value of the script block or property must evaluate to a string or the details will not be displayed in the timeline.</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 /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>DurationFrom</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the time duration for the data sample. If the timeline axis is datetime-based, this property must evalute to a TimeSpan value or an error will result. If the timeline axis is numeric, this property must evaluate to a number or an error will result.</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 /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Units</maml:name> <maml:description> <maml:para>The units to display on the timeline. Defaults to Auto. This parameter has no effect if the timeline axis is numeric.</maml:para> </maml:description> <command:parameterValue required="False" variableLength="false">Auto | Days | Hours | Milliseconds | Minutes | Months | Seconds | Weeks | Years</command:parameterValue> <dev:type> <maml:name>TimelineSeriesUnit</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Auto</dev:defaultValue> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>By</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the data to map to the timeline axis. The value of the property or script block must be a datetime or number or an error will result. If this value is a datetime, the timeline axis will be time-based; if it is a number, the axis will be numeric.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Plot</maml:name> <maml:description> <maml:para>The data item property name, script block, or wildcard pattern that defines the event title to plot on the timeline. The value of the script block or property must evaluate to a string or the title will not be displayed in the timeline.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object[]</command:parameterValue> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>KeyOn</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series key for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Across</maml:name> <maml:description> <maml:para>The data item property name or script block that defines the series collection for each data item.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Name</maml:name> <maml:description> <maml:para>The name of the visualization. Visualization names are unique within visualization types.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="True" variableLength="false" globbing="false" pipelineInput="true (ByValue)" position=""> <maml:name>InputObject</maml:name> <maml:description> <maml:para>The data source to visualize. This can be one of the following:</maml:para> <maml:list> <maml:listItem> <maml:para>A data source object.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The PowerShell path to a data source item on the datasources: drive.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A script block that emits data items asynchronously.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A collection of objects that represent the data items.</maml:para> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Object</command:parameterValue> <dev:type> <maml:name>Object</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>SeriesTable</maml:name> <maml:description> <maml:para>Series definitions to apply to the current visualization. This parameter must be specified as a hashtable. The hashtable keys must be:</maml:para> <maml:list> <maml:listItem> <maml:para>A string value representing the data item property name to which the series applies.</maml:para> </maml:listItem> <maml:listItem> <maml:para>A regular expression object used to match property names. The series definition is applied to all matching properties.</maml:para> </maml:listItem> </maml:list> <maml:para> The hashtable values must be series definitions in the form of <scale name>, <color name>, <ranges> </maml:para> <maml:para>where:</maml:para> <maml:list> <maml:listItem> <maml:para><scale name> is the name of the scale associated with the series (required)</maml:para> </maml:listItem> <maml:listItem> <maml:para><color name> is a standard color name, an #RRGGBB color string, or the character ? to derive a random color. This field is optional and is omitted, a random color choice will be generated</maml:para> </maml:listItem> <maml:listItem> <maml:para> <ranges> is a list of numbers and strings describing key value ranges in the data (optional). Key value ranges can be described as: </maml:para> <maml:list> <maml:listItem> <maml:para>empty (e.g., 0,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a specific color name (e.g., 0,'Green',60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using a color derived from the series color and range index (e.g., 0,?,60)</maml:para> </maml:listItem> <maml:listItem> <maml:para>using an #RRGGBB color identifier (e.g., 0,"#00FFFF",60)</maml:para> </maml:listItem> </maml:list> </maml:listItem> </maml:list> </maml:description> <command:parameterValue required="True" variableLength="false">System.Collections.Hashtable</command:parameterValue> <dev:type> <maml:name>Hashtable</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>Data Source</maml:name> <maml:uri /> <maml:description> <maml:para>A reference to a data source object or a string containing the PowerShell path to a data source item on the datasources: drive. For information on creating data sources explicitly, see: about_SeeShell_DataSources.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A reference to a data source object or a string containing the PowerShell path to a data source item on the datasources: drive. For information on creating data sources explicitly, see: about_SeeShell_DataSources.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>ScriptBlock</maml:name> <maml:uri /> <maml:description> <maml:para>A script block that emits data samples. Note that the script block will be run asynchronously. In addition, it will be evaluated in a runspace outside of the main PowerShell session, and will not be able to reference the local runspace state.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A script block that emits data samples. Note that the script block will be run asynchronously. In addition, it will be evaluated in a runspace outside of the main PowerShell session, and will not be able to reference the local runspace state.</maml:para> </maml:description> </command:inputType> <command:inputType> <dev:type> <maml:name>Object[]</maml:name> <maml:uri /> <maml:description> <maml:para>A list of objects to visualize. The objects are considered a complete data set, with each object a single data sample.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>A list of objects to visualize. The objects are considered a complete data set, with each object a single data sample.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para /> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>If the InputObject parameter is not an existing data source, an implicit data source will be created. Implicit data sources are limited to the default sample size of 20. If you require a larger sample size, create a data source explicitly.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>Script blocks can be piped to visualization cmdlets, but cannot be specified as parameters. This is due to the fact that script blocks are used as filters on pipeline input in PowerShell.</maml:para> <maml:para /> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- EXAMPLE 1 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>get-eventlog -log application -newest 10 | out-timeline -name events -plot Message -by TimeGenerated</dev:code> <dev:remarks> <maml:para>Creates a timeline that plots the last 10 messages from the application event log.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> <command:example> <maml:title>-------------- EXAMPLE 2 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>get-eventlog -log application -newest 10 | out-timeline -name events -plot Category -by TimeGenerated -detailsFrom Message</dev:code> <dev:remarks> <maml:para>Creates a timeline that plots the last 10 events from the application event log. The event category is plotted against the event generation time; clicking on an individual event in the timeline will display the event log message.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_SeeShell_DataSources</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>about_SeeShell_Timelines</maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name>Send-SeeShellIncident</command:name> <maml:description> <maml:para>Prepares an email to the Code Owls LLC incident tracking system.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Send</command:verb> <command:noun>SeeShellIncident</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>This cmdlet can be used to open a support case with Code Owls LLC.</maml:para> <maml:para /> <maml:para>This cmdlet collects the following information about your current PowerShell session:</maml:para> <maml:list> <maml:listItem> <maml:para>The list of errors that have occurred.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The history of commands run in this PowerShell session.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The internal SeeShell log.</maml:para> </maml:listItem> <maml:listItem> <maml:para>Your SeeShell license string.</maml:para> </maml:listItem> <maml:listItem> <maml:para>The version of your SeeShell module.</maml:para> </maml:listItem> </maml:list> <maml:para /> <maml:para>These data items are collated into a zip file on your Desktop. The cmdlet will attempt to attach the zip file to the incident email.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <command:name>Send-SeeShellIncident</command:name> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Message</maml:name> <maml:description> <maml:para>A short message to include with the incident report. Use this to describe the activities that led to the incident.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>IncludeCommandHistory</maml:name> <maml:description> <maml:para>Specify False for this parameter to exclude your command history in the incident report.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>IncludeErrorHistory</maml:name> <maml:description> <maml:para>Specify False for this parameter to exclude the session error history in the incident report.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> </command:parameter> </command:syntaxItem> </command:syntax> <command:parameters> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>Message</maml:name> <maml:description> <maml:para>A short message to include with the incident report. Use this to describe the activities that led to the incident.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.String</command:parameterValue> <dev:type> <maml:name>String</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>IncludeCommandHistory</maml:name> <maml:description> <maml:para>Specify False for this parameter to exclude the session command history in the incident report.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> <command:parameter required="False" variableLength="false" globbing="false" pipelineInput="false" position=""> <maml:name>IncludeErrorHistory</maml:name> <maml:description> <maml:para>Specify False for this parameter to exclude the session error history in the incident report.</maml:para> </maml:description> <command:parameterValue required="True" variableLength="false">System.Management.Automation.SwitchParameter</command:parameterValue> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue /> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para>This cmdlet does not accept pipeline input.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not accept pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>None</maml:name> <maml:uri /> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not produce pipeline output.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <maml:alertSet> <maml:title /> <maml:alert> <maml:para>This cmdlet prepares the email, but does not send it. The email must be sent manually.</maml:para> <maml:para /> <maml:para /> </maml:alert> <maml:alert> <maml:para>This cmdlet is executed automatically when SeeShell detects an unexpected error.</maml:para> <maml:para /> <maml:para /> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------- EXAMPLE 1 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>send-seeshellincident -message "I encountered unexpected behavior while attempting ..."</dev:code> <dev:remarks> <maml:para>Prepares (but does not send) a SeeShell incident email for the Code Owls LLC incident tracking system.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_SeeShell</maml:linkText> <maml:uri /> </maml:navigationLink> </maml: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"> <command:details> <command:name>Test-SeeShellLicense</command:name> <maml:description> <maml:para>Verifies the SeeShell license for the current user.</maml:para> </maml:description> <maml:copyright> <maml:para /> </maml:copyright> <command:verb>Test</command:verb> <command:noun>SeeShellLicense</command:noun> <dev:version /> </command:details> <maml:description> <maml:para>Verifies the SeeShell license for the current user, outputting a True value to the pipeline if the current license is valid and Flase if it is not. This cmdlet only verifies that the license will allow SeeShell to be used; it does not differentiate between trial and full licenses.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <command:name>Test-SeeShellLicense</command:name> </command:syntaxItem> </command:syntax> <command:parameters /> <command:inputTypes> <command:inputType> <dev:type> <maml:name>None.</maml:name> <maml:uri /> <maml:description> <maml:para>This cmdlet does not accept pipeline input.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>This cmdlet does not accept pipeline input.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>Boolean</maml:name> <maml:uri /> <maml:description> <maml:para>True if the current user's SeeShell license is valid; False otherwise.</maml:para> </maml:description> </dev:type> <maml:description> <maml:para>True if the current user's SeeShell license is valid; False otherwise.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <command:terminatingErrors /> <command:nonTerminatingErrors /> <command:examples> <command:example> <maml:title>-------------- EXAMPLE 1 --------------</maml:title> <maml:introduction> <maml:para>C:\PS></maml:para> </maml:introduction> <dev:code>test-seeshelllicense</dev:code> <dev:remarks> <maml:para>Validates the SeeShell license for the current user.</maml:para> <maml:para /> <maml:para /> <maml:para /> </dev:remarks> <command:commandLines> <command:commandLine> <command:commandText /> </command:commandLine> </command:commandLines> </command:example> </command:examples> <maml:relatedLinks> <maml:navigationLink> <maml:linkText>about_SeeShell_License</maml:linkText> <maml:uri /> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Install-SeeShellLicense</maml:linkText> <maml:uri /> </maml:navigationLink> </maml:relatedLinks> </command:command> </helpItems> |