AnalyzeOskCharacterUse class
Home > @keymanapp/kmc-analyze > AnalyzeOskCharacterUse
AnalyzeOskCharacterUse class
Analyze the characters used in On Screen Keyboard files (.kvks, .keyman-touch-layout) for use with &displayMap.
Signature:
export declare class AnalyzeOskCharacterUse Constructors
| Constructor | Modifiers | Description |
|---|---|---|
| (constructor)(callbacks, options) | Constructs a new instance of the AnalyzeOskCharacterUse class |
Methods
| Method | Modifiers | Description |
|---|---|---|
| analyze(file) | Analyzes a single source file for Unicode character usage. Can parse .kmn, .kvks, .keyman-touch-layout file formats. Can be called multiple times to collect results from more than one file. Use AnalyzeOskCharacterUse.getStrings() to retrieve results. Note: |
|
| clear() | Clears analysis data collected from previous calls to AnalyzeOskCharacterUse.analyze() | |
| getStrings(format) | Returns the collected results from earlier calls to AnalyzeOskCharacterUse.analyze(). This generates a mapping from a key cap (one or more characters) to a PUA code, for use with Three output formats are supported: - .txt: tab-separated string format, with three columns: PUA, Key Cap, and plain string. The PUA and Key Cap columns are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string is the original key cap string. - .md: formatted for documentation purposes. Generates a Markdown table (GFM) with PUA, Key Cap, and plain string. The PUA and Key Cap columns are formatted as Unicode Scalar Values, e.g. U+0061, and the plain string is the original key cap string. - .json: returns the final aggregated data as an array of strings, which can be joined to form a JSON blob of an object with a single member, |
