API Reference › frontend-devTools › Tools › AttachMapLayerTool

AttachMapLayerTool Class

This tool add a Map Layer from a specified name (look up in MapLayerSources.json).

Extends

  • AttachMapLayerBaseTool

Extended by

Methods

Name Description
constructor(_isBackground: boolean = true, _isBase: boolean = false): AttachMapLayerTool    
parseAndRun(...args: string[]): Promise<boolean> Executes this tool's run method with args[0] containing name.  
run(name: string): Promise<boolean> This method runs the tool, adding a map layer from a specified name in MayLayerSources.json.  

Inherited methods

Name Inherited from Description
doAttach(source?: MapLayerSource): void Protected AttachMapLayerBaseTool  
register(namespace?: string): void Static AttachMapLayerBaseTool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
maxArgs Accessor StaticReadOnly number    
minArgs Accessor StaticReadOnly number    
toolId Static string    

Inherited properties

Name Type Inherited from Description
_isBackground Protected boolean AttachMapLayerBaseTool  
_isBase Protected boolean AttachMapLayerBaseTool  
description Accessor ReadOnly string AttachMapLayerBaseTool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string AttachMapLayerBaseTool 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 AttachMapLayerBaseTool 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 AttachMapLayerBaseTool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string AttachMapLayerBaseTool 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 AttachMapLayerBaseTool If true, this Tool will not appear in the list from getToolList.
iconSpec Accessor ReadOnly string AttachMapLayerBaseTool Get the iconSpec from this Tool's class.
iconSpec Static string AttachMapLayerBaseTool The icon for this Tool.
keyin Accessor ReadOnly string AttachMapLayerBaseTool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string AttachMapLayerBaseTool 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").
namespace Static string AttachMapLayerBaseTool The namespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string AttachMapLayerBaseTool 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: 25 April, 2024