en-US/PSWordCloudCmdlet.dll-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>New-WordCloud</command:name> <command:verb>New</command:verb> <command:noun>WordCloud</command:noun> <maml:description> <maml:para>Describes the syntax and behaviour of the New-WordCloud cmdlet.</maml:para> </maml:description> </command:details> <maml:description> <maml:para>New-WordCloud takes input text either over the pipeline or directly to its -InputObject parameter, and uses the word frequency distribution to create a word cloud image. More frequently-used words are rendered larger in the final image.</maml:para> </maml:description> <command:syntax> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <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="named" aliases="Backdrop, CanvasColor"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the background of the canvas. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. The value "Transparent" is also accepted here. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Determines the canvas size for the word cloud image.</maml:para> <maml:para>Input can be passed directly as a [SkiaSharp.SKSizeI] object, or in one of the following formats:</maml:para> <maml:para>1. A predefined size string. One of: - 720p (canvas size: 1280x720) - 1080p (canvas size: 1920x1080) - 4K (canvas size: 3840x2160) - A4 (canvas size: 816x1056) - Poster11x17 (canvas size: 1056x1632) - Poster18x24 (canvas size: 1728x2304) - Poster24x36 (canvas size: 2304x3456)</maml:para> <maml:para>2. Single integer (e.g., -ImageSize 1024). This will be used as both the width and height of the image, creating a square canvas. 3. Any image size string (e.g., 1024x768). The first number will be used as the width, and the second number used as the height of the canvas. 4. A hashtable or custom object with keys or properties named "Width" and "Height" that contain integer values</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKSizeI</command:parameterValue> <dev:type> <maml:name>SKSizeI</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3840x2160</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="True (ByValue)" position="named" aliases="InputString, Text, String, Words, Document, Page"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Provides the input text to supply to the word cloud. All input is accepted, but will be treated as string data regardless of the input type. If you are entering complex object input, ensure the objects have a meaningful ToString() method override defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <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="named" aliases="Backdrop, CanvasColor"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the background of the canvas. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. The value "Transparent" is also accepted here. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="Title"> <maml:name>FocusWord</maml:name> <maml:Description> <maml:para>Determines the focus word string to be used in the word cloud. This string will typically appear in the centre of the cloud, larger than all the other words.</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="named" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Determines the canvas size for the word cloud image.</maml:para> <maml:para>Input can be passed directly as a [SkiaSharp.SKSizeI] object, or in one of the following formats:</maml:para> <maml:para>1. A predefined size string. One of: - 720p (canvas size: 1280x720) - 1080p (canvas size: 1920x1080) - 4K (canvas size: 3840x2160) - A4 (canvas size: 816x1056) - Poster11x17 (canvas size: 1056x1632) - Poster18x24 (canvas size: 1728x2304) - Poster24x36 (canvas size: 2304x3456)</maml:para> <maml:para>2. Single integer (e.g., -ImageSize 1024). This will be used as both the width and height of the image, creating a square canvas. 3. Any image size string (e.g., 1024x768). The first number will be used as the width, and the second number used as the height of the canvas. 4. A hashtable or custom object with keys or properties named "Width" and "Height" that contain integer values</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKSizeI</command:parameterValue> <dev:type> <maml:name>SKSizeI</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3840x2160</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="True (ByValue)" position="named" aliases="InputString, Text, String, Words, Document, Page"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Provides the input text to supply to the word cloud. All input is accepted, but will be treated as string data regardless of the input type. If you are entering complex object input, ensure the objects have a meaningful ToString() method override defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="RotateTitle"> <maml:name>RotateFocusWord</maml:name> <maml:Description> <maml:para>Specify an angle in degrees to rotate the focus word by, overriding the default random rotations for the focus word only.</maml:para> <maml:para>Values from -360 to 360, including sub-degree increments, are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <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="named" aliases="Backdrop, CanvasColor"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the background of the canvas. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. The value "Transparent" is also accepted here. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Determines the canvas size for the word cloud image.</maml:para> <maml:para>Input can be passed directly as a [SkiaSharp.SKSizeI] object, or in one of the following formats:</maml:para> <maml:para>1. A predefined size string. One of: - 720p (canvas size: 1280x720) - 1080p (canvas size: 1920x1080) - 4K (canvas size: 3840x2160) - A4 (canvas size: 816x1056) - Poster11x17 (canvas size: 1056x1632) - Poster18x24 (canvas size: 1728x2304) - Poster24x36 (canvas size: 2304x3456)</maml:para> <maml:para>2. Single integer (e.g., -ImageSize 1024). This will be used as both the width and height of the image, creating a square canvas. 3. Any image size string (e.g., 1024x768). The first number will be used as the width, and the second number used as the height of the canvas. 4. A hashtable or custom object with keys or properties named "Width" and "Height" that contain integer values</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKSizeI</command:parameterValue> <dev:type> <maml:name>SKSizeI</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3840x2160</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="named" aliases="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="WordSizeTable, CustomWordSizes"> <maml:name>WordSizes</maml:name> <maml:Description> <maml:para>Instead of supplying a chunk of text as the input, this parameter allows you to define your own relative word sizes. Supply a dictionary or hashtable object where the keys are the words you want to draw in the cloud, and the values are their relative sizes. Words will be scaled as a percentage of the largest sized word in the table. In other words, if you have @{ text = 10; image = 100 }, then "text" will appear 10 times smaller than "image".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <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="named" aliases="Backdrop, CanvasColor"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the background of the canvas. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. The value "Transparent" is also accepted here. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="Title"> <maml:name>FocusWord</maml:name> <maml:Description> <maml:para>Determines the focus word string to be used in the word cloud. This string will typically appear in the centre of the cloud, larger than all the other words.</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="named" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Determines the canvas size for the word cloud image.</maml:para> <maml:para>Input can be passed directly as a [SkiaSharp.SKSizeI] object, or in one of the following formats:</maml:para> <maml:para>1. A predefined size string. One of: - 720p (canvas size: 1280x720) - 1080p (canvas size: 1920x1080) - 4K (canvas size: 3840x2160) - A4 (canvas size: 816x1056) - Poster11x17 (canvas size: 1056x1632) - Poster18x24 (canvas size: 1728x2304) - Poster24x36 (canvas size: 2304x3456)</maml:para> <maml:para>2. Single integer (e.g., -ImageSize 1024). This will be used as both the width and height of the image, creating a square canvas. 3. Any image size string (e.g., 1024x768). The first number will be used as the width, and the second number used as the height of the canvas. 4. A hashtable or custom object with keys or properties named "Width" and "Height" that contain integer values</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKSizeI</command:parameterValue> <dev:type> <maml:name>SKSizeI</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3840x2160</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="named" aliases="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="RotateTitle"> <maml:name>RotateFocusWord</maml:name> <maml:Description> <maml:para>Specify an angle in degrees to rotate the focus word by, overriding the default random rotations for the focus word only.</maml:para> <maml:para>Values from -360 to 360, including sub-degree increments, are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="WordSizeTable, CustomWordSizes"> <maml:name>WordSizes</maml:name> <maml:Description> <maml:para>Instead of supplying a chunk of text as the input, this parameter allows you to define your own relative word sizes. Supply a dictionary or hashtable object where the keys are the words you want to draw in the cloud, and the values are their relative sizes. Words will be scaled as a percentage of the largest sized word in the table. In other words, if you have @{ text = 10; image = 100 }, then "text" will appear 10 times smaller than "image".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundImage</maml:name> <maml:Description> <maml:para>Specifies the path to the background image to be used as a base for the final word cloud image.</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="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="True (ByValue)" position="named" aliases="InputString, Text, String, Words, Document, Page"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Provides the input text to supply to the word cloud. All input is accepted, but will be treated as string data regardless of the input type. If you are entering complex object input, ensure the objects have a meaningful ToString() method override defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundImage</maml:name> <maml:Description> <maml:para>Specifies the path to the background image to be used as a base for the final word cloud image.</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="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="Title"> <maml:name>FocusWord</maml:name> <maml:Description> <maml:para>Determines the focus word string to be used in the word cloud. This string will typically appear in the centre of the cloud, larger than all the other words.</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="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="True (ByValue)" position="named" aliases="InputString, Text, String, Words, Document, Page"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Provides the input text to supply to the word cloud. All input is accepted, but will be treated as string data regardless of the input type. If you are entering complex object input, ensure the objects have a meaningful ToString() method override defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="RotateTitle"> <maml:name>RotateFocusWord</maml:name> <maml:Description> <maml:para>Specify an angle in degrees to rotate the focus word by, overriding the default random rotations for the focus word only.</maml:para> <maml:para>Values from -360 to 360, including sub-degree increments, are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundImage</maml:name> <maml:Description> <maml:para>Specifies the path to the background image to be used as a base for the final word cloud image.</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="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="named" aliases="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="WordSizeTable, CustomWordSizes"> <maml:name>WordSizes</maml:name> <maml:Description> <maml:para>Instead of supplying a chunk of text as the input, this parameter allows you to define your own relative word sizes. Supply a dictionary or hashtable object where the keys are the words you want to draw in the cloud, and the values are their relative sizes. Words will be scaled as a percentage of the largest sized word in the table. In other words, if you have @{ text = 10; image = 100 }, then "text" will appear 10 times smaller than "image".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:syntaxItem> <command:syntaxItem> <maml:name>New-WordCloud</maml:name> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Vertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">FlippedVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">EitherVertical</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">UprightDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">InvertedDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllDiagonals</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllUpright</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">AllInverted</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">All</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</maml:para> </maml:Description> <dev:type> <maml:name>SwitchParameter</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>False</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundImage</maml:name> <maml:Description> <maml:para>Specifies the path to the background image to be used as a base for the final word cloud image.</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="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="Title"> <maml:name>FocusWord</maml:name> <maml:Description> <maml:para>Determines the focus word string to be used in the word cloud. This string will typically appear in the centre of the cloud, larger than all the other words.</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="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="named" aliases="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</maml:para> </maml:Description> <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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</maml:para> </maml:Description> <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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="RotateTitle"> <maml:name>RotateFocusWord</maml:name> <maml:Description> <maml:para>Specify an angle in degrees to rotate the focus word by, overriding the default random rotations for the focus word only.</maml:para> <maml:para>Values from -360 to 360, including sub-degree increments, are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValueGroup> <command:parameterValue required="false" command:variableLength="false">None</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Rectangle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Square</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Circle</command:parameterValue> <command:parameterValue required="false" command:variableLength="false">Oval</command:parameterValue> </command:parameterValueGroup> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="WordSizeTable, CustomWordSizes"> <maml:name>WordSizes</maml:name> <maml:Description> <maml:para>Instead of supplying a chunk of text as the input, this parameter allows you to define your own relative word sizes. Supply a dictionary or hashtable object where the keys are the words you want to draw in the cloud, and the values are their relative sizes. Words will be scaled as a percentage of the largest sized word in the table. In other words, if you have @{ text = 10; image = 100 }, then "text" will appear 10 times smaller than "image".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</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="named" aliases="AllowBleed"> <maml:name>AllowOverflow</maml:name> <maml:Description> <maml:para>This option permits the word cloud to overflow the bounds of the canvas.</maml:para> <maml:para>Use this in conjunction with the -WordScale parameter to create partially-clipped word clouds.</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="named" aliases="none"> <maml:name>AllowRotation</maml:name> <maml:Description> <maml:para>Specify -AllowRotation None to prevent word rotation entirely, or use one of the options to permit specific rotation modes.</maml:para> <maml:para>All modes permit the "upright" standard orientation, as well as their specified additions.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WordOrientations</command:parameterValue> <dev:type> <maml:name>WordOrientations</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>EitherVertical</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="IgnoreStopWords"> <maml:name>AllowStopWords</maml:name> <maml:Description> <maml:para>This option disables the use of the standard Stop Words list. By default, the following words are ignored during text processing as they otherwise typically are extremely common and would dominate the word cloud:</maml:para> <maml:para>a, about, above, after, again, against, all, am, an, and, any, are, aren't, as, at, be, because, been, before, being, below, between, both, but, by, can't, cannot, could, couldn't, did, didn't, do, does, doesn't, doing, don't, down, during, each, few, for, from, further, had, hadn't, has, hasn't, have, haven't, having, he, he'd, he'll, he's, her, here, here's, hers, herself, him, himself, his, how, how's, I, I'd, I'll, I'm, I've, if, in, into, is, isn't, it, it's, its, itself, let's, me, more, most, mustn't, my, myself, no, nor, not, of, off, on, once, only, or, other, ought, our, ours, ourselves, out, over, own, same, shan't, she, she'd, she'll, she's, should, shouldn't, so, some, such, than, that, that's, the, their, theirs, them, themselves, then, there, there's, these, they, they'd, they'll, they're, they've, this, those, through, to, too, under, until, up, very, was, wasn't, we, we'd, we'll, we're, we've, were, weren't, what, what's, when, when's, where, where's, which, while, who, who's, whom, why, why's, with, won't, would, wouldn't, you, you'd, you'll, you're, you've, your, yours, yourself, yourselves</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="named" aliases="Backdrop, CanvasColor"> <maml:name>BackgroundColor</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the background of the canvas. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. The value "Transparent" is also accepted here. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>BackgroundImage</maml:name> <maml:Description> <maml:para>Specifies the path to the background image to be used as a base for the final word cloud image.</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="named" aliases="none"> <maml:name>ColorSet</maml:name> <maml:Description> <maml:para>Specifies the SKColor values used for the words in the cloud. Multiple values are accepted, and each new word pulls the next color from the set. If the end of the set is reached, the next word will reset the index to the start and retrieve the first color again.</maml:para> <maml:para>Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. One or more strings matching one of the named color fields in [SkiaSharp.SKColors]. These values will be pulled for tab-completion automatically. Names containing wildcards may be used, and all matching colors will be included in the set. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values may range from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque).</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor[]</command:parameterValue> <dev:type> <maml:name>SKColor[]</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>*</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>DistanceStep</maml:name> <maml:Description> <maml:para>Determines the value to scale the distance step by. Larger numbers will result in more radially spread-out clouds.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="ForbidWord, IgnoreWord"> <maml:name>ExcludeWord</maml:name> <maml:Description> <maml:para>Determines the words to be explicitly ignored when rendering the word cloud. This is usually used to exclude irrelevant words, unwanted URL segments, etc.</maml:para> <maml:para>Values from -IncludeWord take precedence over those from this parameter.</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="named" aliases="Title"> <maml:name>FocusWord</maml:name> <maml:Description> <maml:para>Determines the focus word string to be used in the word cloud. This string will typically appear in the centre of the cloud, larger than all the other words.</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="named" aliases="none"> <maml:name>ImageSize</maml:name> <maml:Description> <maml:para>Determines the canvas size for the word cloud image.</maml:para> <maml:para>Input can be passed directly as a [SkiaSharp.SKSizeI] object, or in one of the following formats:</maml:para> <maml:para>1. A predefined size string. One of: - 720p (canvas size: 1280x720) - 1080p (canvas size: 1920x1080) - 4K (canvas size: 3840x2160) - A4 (canvas size: 816x1056) - Poster11x17 (canvas size: 1056x1632) - Poster18x24 (canvas size: 1728x2304) - Poster24x36 (canvas size: 2304x3456)</maml:para> <maml:para>2. Single integer (e.g., -ImageSize 1024). This will be used as both the width and height of the image, creating a square canvas. 3. Any image size string (e.g., 1024x768). The first number will be used as the width, and the second number used as the height of the canvas. 4. A hashtable or custom object with keys or properties named "Width" and "Height" that contain integer values</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKSizeI</command:parameterValue> <dev:type> <maml:name>SKSizeI</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>3840x2160</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>IncludeWord</maml:name> <maml:Description> <maml:para>Specifies normally-excluded words to include in the word cloud.</maml:para> <maml:para>This parameter takes precedence over the -ExcludeWord parameter.</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="True (ByValue)" position="named" aliases="InputString, Text, String, Words, Document, Page"> <maml:name>InputObject</maml:name> <maml:Description> <maml:para>Provides the input text to supply to the word cloud. All input is accepted, but will be treated as string data regardless of the input type. If you are entering complex object input, ensure the objects have a meaningful ToString() method override defined.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">PSObject</command:parameterValue> <dev:type> <maml:name>PSObject</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="MaxColours"> <maml:name>MaxColors</maml:name> <maml:Description> <maml:para>Determines the maximum number of colors to use from the values contained in the -ColorSet parameter.</maml:para> <maml:para>The values from the -ColorSet parameter are shuffled before being trimmed down here, so that you are given a variety of color selections even under default conditions.</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>[int]::MaxValue</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="MaxWords"> <maml:name>MaxRenderedWords</maml:name> <maml:Description> <maml:para>Specifies the maximum number of words to draw in the rendered cloud. More words take longer to render, and after a few hundred words the visible sizes become unreadable in all but the largest images.</maml:para> <maml:para>However, an appropriate vector graphics viewer or editor is still capable of zooming in far enough to see them.</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>100</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="BlackAndWhite, Greyscale"> <maml:name>Monochrome</maml:name> <maml:Description> <maml:para>If this option is specified, New-WordCloud draws the word cloud in monochrome (greyscale). Only the Brightness values from the SKColors in the color set provided will be used.</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="named" aliases="Spacing"> <maml:name>Padding</maml:name> <maml:Description> <maml:para>Determines the float value to scale the padding space around the words by.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>5.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>PassThru</maml:name> <maml:Description> <maml:para>Specifying this option causes New-WordCloud to emit a FileInfo object representing the finished SVG file when it is completed.</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="true" variableLength="true" globbing="false" pipelineInput="False" position="0" aliases="OutFile, ExportPath, ImagePath"> <maml:name>Path</maml:name> <maml:Description> <maml:para>The output file path to save the final SVG vector image to. Output is written as a stream, while the image is being generated. Terminating the command early may result in a usable but partially-formed image, or an invalid SVG file with missing tags.</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="named" aliases="none"> <maml:name>RadialStep</maml:name> <maml:Description> <maml:para>Determines the distance around each radial arc that the scanning algorithm takes for each circular sweep. Larger values correspond to fewer points checked on each radial sweep. This value is scaled according to distance from the center, so there will be more steps on a larger radius.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>15.0</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="SeedValue"> <maml:name>RandomSeed</maml:name> <maml:Description> <maml:para>Determines the seed value for the random numbers used to vary the position and placement patterns.</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="named" aliases="RotateTitle"> <maml:name>RotateFocusWord</maml:name> <maml:Description> <maml:para>Specify an angle in degrees to rotate the focus word by, overriding the default random rotations for the focus word only.</maml:para> <maml:para>Values from -360 to 360, including sub-degree increments, are permitted.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="OutlineColor"> <maml:name>StrokeColor</maml:name> <maml:Description> <maml:para>Determines the SKColor value used as the stroke color for the words in the image. Accepts input as a complete SKColor object, or one of the following formats:</maml:para> <maml:para>1. A string color name matching one of the fields in SkiaSharp.SKColors. These values will be pulled for tab-completion automatically. Wildcards may be used only if the pattern matches exactly one color name. 2. A hexadecimal number string with or without the preceding #, in the form: AARRGGBB, RRGGBB, ARGB, or RGB. 3. A hashtable or custom object with keys or properties named: "Red, Green, Blue", and/or "Alpha", with values from 0-255. Omitted color values are assumed to be 0, but omitting alpha defaults it to 255 (fully opaque)</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKColor</command:parameterValue> <dev:type> <maml:name>SKColor</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Black</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="OutlineWidth"> <maml:name>StrokeWidth</maml:name> <maml:Description> <maml:para>Determines the width of the word outline. Values from 0-10 are permitted. A zero value indicates the special "Hairline" width, where the width of the stroke depends on the SVG viewing scale.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</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="FontFamily, FontFace"> <maml:name>Typeface</maml:name> <maml:Description> <maml:para>Gets or sets the typeface to be used in the word cloud. Input can be processed as a SkiaSharp.SKTypeface object, or one of the following formats:</maml:para> <maml:para>1. String value matching a valid font name. These can be autocompleted by pressing [Tab]. An invalid value will cause the system default to be used. 2. A custom object or hashtable object containing the following keys or properties: - FamilyName: string value. If no font by this name is available, the system default will be used. - FontWeight: "Invisible", "ExtraLight", Light", "Thin", "Normal", "Medium", "SemiBold", "Bold", "ExtraBold", "Black", "ExtraBlack" (Default: "Normal") - FontSlant: "Upright", "Italic", "Oblique" (Default: "Upright") - FontWidth: "UltraCondensed", "ExtraCondensed", "Condensed", "SemiCondensed", "Normal", "SemiExpanded", "Expanded", "ExtraExpanded", "UltraExpanded" (Default: "Normal")</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">SKTypeface</command:parameterValue> <dev:type> <maml:name>SKTypeface</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>Consolas</dev:defaultValue> </command:parameter> <command:parameter required="false" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="none"> <maml:name>WordBubble</maml:name> <maml:Description> <maml:para>Gets or sets the shape of backdrop to place behind each word. The default is no bubble. Be aware that circle or square bubbles will take up a lot more space than most words typically do; you may need to reduce the `-WordSize` parameter accordingly if you start getting warnings about words being skipped due to insufficient space.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">WordBubbleShape</command:parameterValue> <dev:type> <maml:name>WordBubbleShape</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="ScaleFactor"> <maml:name>WordScale</maml:name> <maml:Description> <maml:para>Applies a scaling value to the words in the cloud. Use this parameter to shrink or expand your total word cloud area with respect to the size of the image. The default of 1.0 is approximately equivalent to the total image size. Scale as appropriate according to how much of the total canvas you would like the cloud to cover.</maml:para> <maml:para>The cloud size is restricted to the canvas size by default, so values above 1.0 will typically not have an impact without also supplying the -AllowOverflow option.</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">Single</command:parameterValue> <dev:type> <maml:name>Single</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>1.0</dev:defaultValue> </command:parameter> <command:parameter required="true" variableLength="true" globbing="false" pipelineInput="False" position="named" aliases="WordSizeTable, CustomWordSizes"> <maml:name>WordSizes</maml:name> <maml:Description> <maml:para>Instead of supplying a chunk of text as the input, this parameter allows you to define your own relative word sizes. Supply a dictionary or hashtable object where the keys are the words you want to draw in the cloud, and the values are their relative sizes. Words will be scaled as a percentage of the largest sized word in the table. In other words, if you have @{ text = 10; image = 100 }, then "text" will appear 10 times smaller than "image".</maml:para> </maml:Description> <command:parameterValue required="true" variableLength="false">IDictionary</command:parameterValue> <dev:type> <maml:name>IDictionary</maml:name> <maml:uri /> </dev:type> <dev:defaultValue>None</dev:defaultValue> </command:parameter> </command:parameters> <command:inputTypes> <command:inputType> <dev:type> <maml:name>System.Management.Automation.PSObject</maml:name> </dev:type> <maml:description> <maml:para>New-WordCloud accepts pipeline input of any type to its -InputObject parameter. Due to the nature of the command, all inputs will be transformed to string before they are used in the final word cloud. Complex objects may be reduced to their type names only, if they do not have a predefined conversion path to a string representation.</maml:para> </maml:description> </command:inputType> </command:inputTypes> <command:returnValues> <command:returnValue> <dev:type> <maml:name>System.IO.FileInfo</maml:name> </dev:type> <maml:description> <maml:para>If the -PassThru switch is used, New-WordCloud will output the FileInfo object representing the completed image file. Otherwise, there is no output to the console.</maml:para> </maml:description> </command:returnValue> </command:returnValues> <maml:alertSet> <maml:alert> <maml:para>Due to its dependence on the SkiaSharp library, loading the New-WordCloud module will also expose the SkiaSharp library types for you to use. This is both by necessity and for configurability. SkiaSharp types are accessible in the SkiaSharp namespace, for example [SkiaSharp.SKTypeface]. It is also possible to surface the type names with a using namespace declaration.</maml:para> <maml:para>While a lot of work has gone into the parameter transforms to ensure you can customise the final look of the word cloud as much as possible, New-WordCloud seamlessly accepts direct input of the SkiaSharp objects it utilises, so that you can obtain and use your own SkiaSharp library objects for maximum configurability.</maml:para> </maml:alert> </maml:alertSet> <command:examples> <command:example> <maml:title>-------------------------- Example 1 --------------------------</maml:title> <dev:code>PS> Get-Content .\MyEntireBook.txt | New-WordCloud -Path .\BookCloud.svg</dev:code> <dev:remarks> <maml:para>Creates a word cloud and saves it to a file called BookCloud.svg in the current folder.</maml:para> <maml:para>The default font, color, and layout settings will be used.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 2 --------------------------</maml:title> <dev:code>PS> Get-ChildItem .\scripts -Recurse -Filter "*.ps1" | >> Get-Content | >> New-WordCloud -Path .\BookCloud.svg -FocusWord Scripts -ColorSet *blue*, *white*, *tan*, *yellow*, *gold* -Typeface Scriptina -StrokeWidth 2 -StrokeColor Brown -MaxRenderedWords 250</dev:code> <dev:remarks> <maml:para>Creates a word cloud from all PS1 files in the scripts directory, with the word "Scripts" emblazoned in the centre.</maml:para> <maml:para>Word colors will be chosen from the specified set, including all named SKColors that match the specified patterns.</maml:para> <maml:para>The font Scriptina will be used, and all words will have a brown stroke (outline).</maml:para> <maml:para>Up to 250 words will be used in the final image.</maml:para> </dev:remarks> </command:example> <command:example> <maml:title>-------------------------- Example 3 --------------------------</maml:title> <dev:code>PS> $Params = @{ Path = '.\BookCloud.svg' FocusWord = 'News' ColorSet = @( @{Red = 200; Green = 180; Blue = 54} "1899FF" "*white*" "*gold*" ) StrokeWidth = 0 StrokeColor = @{Red = 10; Green = 5; Blue = 45; Alpha = 128} } PS> Get-Content .\Newspaper.md | New-WordCloud @Params</dev:code> <dev:remarks> <maml:para>Creates a word cloud from the Newspaper.md file in the current directory, with the word "News" emblazoned in the centre.</maml:para> <maml:para>Word colors will be chosen from the specified set, including all named SKColors that match the specified patterns and those specified by use of the hashtable and hex-string values.</maml:para> <maml:para>The default font will be used, and all words will have a hairline-width semi-transparent dark blue stroke (outline).</maml:para> </dev:remarks> </command:example> </command:examples> <command:relatedLinks> <maml:navigationLink> <maml:linkText>Online Version:</maml:linkText> <maml:uri></maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>Online Version</maml:linkText> <maml:uri>https://github.com/vexx32/PSWordCloud/blob/master/docs/New-WordCloud.md</maml:uri> </maml:navigationLink> <maml:navigationLink> <maml:linkText>SkiaSharp API Reference</maml:linkText> <maml:uri>https://docs.microsoft.com/en-us/dotnet/api/skiasharp</maml:uri> </maml:navigationLink> </command:relatedLinks> </command:command> </helpItems> |