API Reference > frontend-devTools > Tools > AttachWmsMapLayerByUrlTool

AttachWmsMapLayerByUrlTool Class

Beta  

This tool attaches a WMS map layer from a given URL.

Extends

  • AttachMapLayerByURLBaseTool

Methods

Name Description
constructor(): AttachWmsMapLayerByUrlTool    
parseAndRun(...args: string[]): boolean This method runs the tool, attaching a WMS map layer from a given URL.  

Inherited methods

Name Inherited from Description
doAttach(source?: MapLayerSource): void Protected AttachMapLayerByURLBaseTool  
run(url: string, name?: string, userName?: string, password?: string): boolean AttachMapLayerByURLBaseTool  
register(namespace?: I18NNamespace, i18n?: I18N): void Static AttachMapLayerByURLBaseTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
toolId Static string    

Inherited properties

Name Type Inherited from Description
_formatId Protected string AttachMapLayerByURLBaseTool  
_isBackground Protected boolean AttachMapLayerByURLBaseTool  
_isBase Protected boolean AttachMapLayerByURLBaseTool  
description Accessor ReadOnly string AttachMapLayerByURLBaseTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string AttachMapLayerByURLBaseTool Get the localized description for this Tool class. This returns the value of "tools." + this.toolId + ".description" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
flyover is returned.
englishKeyin Accessor StaticReadOnly string AttachMapLayerByURLBaseTool Get the English keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
flyover Accessor ReadOnly string AttachMapLayerByURLBaseTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string AttachMapLayerByURLBaseTool Get the localized flyover for this Tool class. This returns the value of "tools." + this.toolId + ".flyover" from
its registered Namespace (e.g. "en/MyApp.json"). If that key is not in the localization namespace,
keyin is returned.
hidden Static boolean AttachMapLayerByURLBaseTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N AttachMapLayerByURLBaseTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string AttachMapLayerByURLBaseTool Get the iconSpec from this Tool's class.
iconSpec Static string AttachMapLayerByURLBaseTool The icon for this Tool.
keyin Accessor ReadOnly string AttachMapLayerByURLBaseTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string AttachMapLayerByURLBaseTool Get the localized keyin string for this Tool class. This returns the value of "tools." + this.toolId + ".keyin" from
its registered Namespace (e.g. "en/MyApp.json").
maxArgs Accessor StaticReadOnly number AttachMapLayerByURLBaseTool  
minArgs Accessor StaticReadOnly number AttachMapLayerByURLBaseTool  
namespace Static I18NNamespace AttachMapLayerByURLBaseTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string AttachMapLayerByURLBaseTool Get the toolId string for this Tool class. This string is used to identify the Tool in the ToolRegistry and is used to localize
the keyin, description, etc. from the current locale.

Defined in

Last Updated: 12 June, 2024