HtmlForgeX

API Reference

Command

New-HtmlXVectorMap

Namespace HtmlForgeX.PowerShell
Outputs
HtmlForgeX.JsVectorMap

Creates a jsVectorMap (vector map) container.

Remarks

Part of the HtmlForgeX.PowerShell DSL.

Examples

Imported script example

New-HtmlXVectorMap -Map EuropeMill -Height "360px" -MarkerLabels {
        

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-HtmlXVectorMap [-Content <ScriptBlock>] [-Background <string>] [-BackgroundColor <Blue>] [-CustomDatasetUrl <string>] [-CustomMapId <string>] [-Draggable <bool>] [-GeoGroup <string>] [-GeoSelectionTableMode <All|SourceOnly>] [-Height <string>] [-Map <World>] [-MarkerLabels] [-RegionLabels] [-ZoomButtons <bool>] [-ZoomOnScroll <bool>] [<CommonParameters>]
#

Parameters

Content ScriptBlock optionalposition: 0pipeline: false
Scriptblock that adds markers or region settings.
Background string optionalposition: namedpipeline: false
Background color (CSS value).
BackgroundColor TablerColor optionalposition: namedpipeline: falsevalues: 62
Background color preset. 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
CustomDatasetUrl string optionalposition: namedpipeline: false
Custom dataset URL or file name.
CustomMapId string optionalposition: namedpipeline: false
Custom map id for non-standard datasets.
Draggable bool optionalposition: namedpipeline: false
Enable or disable dragging.
GeoGroup string optionalposition: namedpipeline: false
Geo selection group id for cross-component sync.
GeoSelectionTableMode GeoSelectionTableMode optionalposition: namedpipeline: falsevalues: 2
Controls geo selection table sync mode. Possible values: All, SourceOnly
Possible values: All, SourceOnly
Height string optionalposition: namedpipeline: false
Map height (e.g., "350px").
Map JsVectorMapName optionalposition: namedpipeline: falsevalues: 23
Vector map dataset preset. Possible values: World, WorldMerc, UsMillEn, UsMercEn, UsLccEn, UsAeaEn, Spain, Russia, Canada, Iraq, Brazil, AfricaMill, AsiaMill, BelgiumMill, ContinentsMill, EuropeMill, FranceMill, GermanyMill, NetherlandsMill, NorthAmericaMill, OceaniaMill, SouthAmericaMill, UkCountriesMill
Possible values: World, WorldMerc, UsMillEn, UsMercEn, UsLccEn, UsAeaEn, Spain, Russia, Canada, Iraq, Brazil, AfricaMill, AsiaMill, BelgiumMill, ContinentsMill, EuropeMill, FranceMill, GermanyMill, NetherlandsMill, NorthAmericaMill, OceaniaMill, SouthAmericaMill, UkCountriesMill
MarkerLabels SwitchParameter optionalposition: namedpipeline: false
Show marker labels based on marker names.
RegionLabels SwitchParameter optionalposition: namedpipeline: false
Show region labels based on region names.
ZoomButtons bool optionalposition: namedpipeline: false
Enable or disable zoom buttons.
ZoomOnScroll bool optionalposition: namedpipeline: false
Enable or disable zoom on scroll.

Outputs

HtmlForgeX.JsVectorMap