Keyboard Support

Contact and Search

Keyman.com Homepage

Header bottom

Keyman.com

Other versions
Version 19.0Version 18.0 (current version)Version 17.0

On this page

You are viewing an old version of this documentation. Click here to open the current version, 18.0.

Osk.StringResult interface

Home > @keymanapp/kmc-kmn > Osk > StringResult

Osk.StringResult interface

Represents a single key cap found by AnalyzeOskCharacterUse

Signature:

export interface StringResult 

Properties

Property Modifiers Type Description
pua string hexadecimal single character in PUA range, without 'U+' prefix, e.g. 'F100'
str string the key cap string
unicode string unicode code points in for reference, without 'U+' prefix, e.g. '0061 0301'
usages StringRefUsage[] | string[] files in which the string is referenced; will be an array of if includeCounts is true, otherwise will be an array of strings listing files in which the key cap may be found