API Reference > imodeljs-frontend > Tools > ToolAssistance

ToolAssistance Class

Beta  

Tool Assistance helper methods.

Methods

Name Description
createInstruction(image: string | ToolAssistanceImage, text: string, isNew?: false | true, inputMethod?: ToolAssistanceInputMethod, keyboardInfo?: ToolAssistanceKeyboardInfo): ToolAssistanceInstruction Static Creates a ToolAssistanceInstruction.  
createInstructions(mainInstruction: ToolAssistanceInstruction, sections?: ToolAssistanceSection[]): ToolAssistanceInstructions Static Creates a ToolAssistanceInstructions.  
createKeyboardInfo(keys: string[], bottomKeys?: string[]): ToolAssistanceKeyboardInfo Static Creates a ToolAssistanceKeyboardInfo.  
createKeyboardInstruction(keyboardInfo: ToolAssistanceKeyboardInfo, text: string, isNew?: false | true, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction Static Creates a ToolAssistanceInstruction with a ToolAssistanceKeyboardInfo.  
createModifierKeyInstruction(modifierKey: string, image: string | ToolAssistanceImage, text: string, isNew?: false | true, inputMethod?: ToolAssistanceInputMethod): ToolAssistanceInstruction Static Creates a ToolAssistanceInstruction with a modifier key and an image.  
createSection(instructions: ToolAssistanceInstruction[], label?: string): ToolAssistanceSection Static Creates a ToolAssistanceSection.  
createTouchCursorInstructions(instructions: ToolAssistanceInstruction[]): boolean Static Creates instructions for interaction with the touch cursor that are appended to the supplied ToolAssistanceInstruction array.  

Properties

Name Type Description
altKey Accessor StaticReadOnly string Alt key text.  
altKeyboardInfo Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Alt key.  
altSymbol Static string Alt key symbol.  
altSymbolKeyboardInfo Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Alt key symbol.  
ctrlKey Accessor StaticReadOnly string Ctrl key text.  
ctrlKeyboardInfo Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Ctrl key.  
ctrlSymbol Static string Ctrl key symbol.  
ctrlSymbolKeyboardInfo Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Ctrl key symbol.  
downSymbol Static string Down key symbol.  
inputsLabel Accessor StaticReadOnly string Inputs text.  
leftSymbol Static string Left key symbol.  
rightSymbol Static string Right key symbol.  
shiftKey Accessor StaticReadOnly string Shift key text.  
shiftKeyboardInfo Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Shift key with symbol.  
shiftKeyboardInfoNoSymbol Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Shift key without symbol.  
shiftSymbol Static string Shift key symbol.  
shiftSymbolKeyboardInfo Accessor StaticReadOnly ToolAssistanceKeyboardInfo Keyboard info for Shift key symbol.  
upSymbol Static string Up key symbol.  

Object Literals

Name Description
arrowKeyboardInfo Static Keyboard info for Arrow keys.

Defined in

Last Updated: 13 June, 2024