API Reference > frontend-devTools > Tools > SourceAspectIdTool

SourceAspectIdTool Class

Beta  

Base class for a tool that can convert between source aspect Ids and element Ids. A "source aspect Id" is a string that identifies an object (such as an element) in the source document from which the iModel originated. For example, if the iModel was produced by the MicroStation bridge, the source aspect Id is usually a V8 element Id.

Extends

Extended by

Methods

Name Description
constructor(..._args: any[]): SourceAspectIdTool    
getECSql(queryId: string): string ProtectedAbstract    
parseAndRun(...keyinArgs: string[]): boolean    
run(idToQuery?: string, copyToClipboard?: boolean): boolean    

Inherited methods

Name Inherited from Description
register(namespace?: I18NNamespace, i18n?: I18N): void Static Tool Register this Tool class with the ToolRegistry.

Properties

Name Type Description
maxArgs Accessor StaticReadOnly number    
minArgs Accessor StaticReadOnly number    

Inherited properties

Name Type Inherited from Description
description Accessor ReadOnly string Tool Get the localized description string from this Tool's class
description Accessor StaticReadOnly string Tool 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 Tool 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 Tool Get the localized flyover string from this Tool's class
flyover Accessor StaticReadOnly string Tool 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 Tool If true, this Tool will not appear in the list from getToolList.
i18n Static I18N Tool The internationalization services instance used to translate strings from the namespace.
iconSpec Accessor ReadOnly string Tool Get the iconSpec from this Tool's class.
iconSpec Static string Tool The icon for this Tool.
keyin Accessor ReadOnly string Tool Get the localized keyin string from this Tool's class
keyin Accessor StaticReadOnly string Tool 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 I18NNamespace Tool The I18NNamespace that provides localized strings for this Tool.
toolId Accessor ReadOnly string Tool 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.
toolId Static string Tool The unique string that identifies this tool.

Defined in

Last Updated: 12 June, 2024