HtmlForgeX

API Reference

Command

New-HtmlXGlobeRing

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.GlobeGl

Adds a ring to the current globe.

Remarks

Use inside New-HtmlXGlobe { }.

Examples

Imported script example

New-HtmlXGlobeRing -Latitude 40.7128 -Longitude -74.0060 -Color Warning -MaxRadius 2.5 -PropagationSpeed 0.6 -RepeatPeriodMs 2000

Common Parameters

This command supports the common parameters: -Debug, -ErrorAction, -ErrorVariable, -InformationAction, -InformationVariable, -OutVariable, -OutBuffer, -PipelineVariable, -Verbose, -WarningAction, and -WarningVariable.

For more information, see about_CommonParameters.

Syntax

New-HtmlXGlobeRing [-Altitude <double>] [-Color <Blue>] [-ColorHex <string>] [-Latitude <double>] [-Longitude <double>] [-MaxRadius <double>] [-PropagationSpeed <double>] [-RepeatPeriodMs <int>] [<CommonParameters>]
#

Parameters

Altitude double optionalposition: namedpipeline: false
Ring altitude.
Color TablerColor optionalposition: namedpipeline: falsevalues: 62
Ring color (Tabler palette). Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
Possible values: Blue, Azure, Indigo, Purple, Pink, Red, Orange, Yellow, Lime, Green, Teal, Cyan, White, Black, BlueLight, AzureLight, IndigoLight, PurpleLight, PinkLight, RedLight, OrangeLight, YellowLight, LimeLight, GreenLight, TealLight, CyanLight, Gray50, Gray100, Gray200, Gray300, Gray400, Gray500, Gray600, Gray700, Gray800, Gray900, Facebook, Twitter, Linkedin, Google, Youtube, Vimeo, Dribbble, Github, Instagram, Pinterest, Vk, Rss, Flickr, Bitbucket, Tabler, Default, Primary, Secondary, Success, Failed, Info, Warning, Danger, Light, Dark, Transparent
ColorHex string optionalposition: namedpipeline: false
Ring color (custom hex).
Latitude double optionalposition: namedpipeline: false
Ring latitude.
Longitude double optionalposition: namedpipeline: false
Ring longitude.
MaxRadius double optionalposition: namedpipeline: false
Ring max radius.
PropagationSpeed double optionalposition: namedpipeline: false
Ring propagation speed.
RepeatPeriodMs int optionalposition: namedpipeline: false
Ring repeat period in milliseconds.

Outputs

HtmlForgeX.GlobeGl