API Reference > frontend-devTools > Tools > AttachMapOverlayTool

AttachMapOverlayTool Class

Beta  

This tool attaches a Overlay map layer.

Extends

Methods

Name Description
constructor(): AttachMapOverlayTool    

Inherited methods

Name Inherited from Description
doAttach(source?: MapLayerSource): void Protected AttachMapLayerTool  
parseAndRun(...args: string[]): boolean AttachMapLayerTool Executes this tool's run method with args[0] containing name.
run(name: string): boolean AttachMapLayerTool This method runs the tool, adding a map layer from a specified name in MayLayerSources.json.
register(namespace?: I18NNamespace, i18n?: I18N): void Static AttachMapLayerTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
toolId Static string    

Inherited properties

Name Type Inherited from Description
_isBackground Protected boolean AttachMapLayerTool  
_isBase Protected boolean AttachMapLayerTool  
description Accessor ReadOnly string AttachMapLayerTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string AttachMapLayerTool 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,
AttachMapLayerTool.flyover is returned.
englishKeyin Accessor StaticReadOnly string AttachMapLayerTool 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 AttachMapLayerTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string AttachMapLayerTool 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,
AttachMapLayerTool.keyin is returned.
hidden Static boolean AttachMapLayerTool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N AttachMapLayerTool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string AttachMapLayerTool Get the iconSpec from this Tool's class.
iconSpec Static string AttachMapLayerTool The icon for this Tool.
keyin Accessor ReadOnly string AttachMapLayerTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string AttachMapLayerTool 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 AttachMapLayerTool  
minArgs Accessor StaticReadOnly number AttachMapLayerTool  
namespace Static I18NNamespace AttachMapLayerTool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string AttachMapLayerTool 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: 11 June, 2024