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 incomplete pre-release version of this documentation. Click here to open the current version, 18.0.

AnalyzeOskRewritePua class

Home > @keymanapp/kmc-analyze > AnalyzeOskRewritePua

AnalyzeOskRewritePua class

Rewrite On Screen Keyboard files (.kvks, .keyman-touch-layout) with PUA codepoints, based on analysis provided by AnalyzeOskCharacterUse class.

Signature:

export declare class AnalyzeOskRewritePua 

Constructors

Constructor Modifiers Description
[(constructor)(callbacks)](./kmc-analyze.analyzeoskrewritepua._constructor_.md) Constructs a new instance of the `AnalyzeOskRewritePua` class

Properties

Property Modifiers Type Description
[data](./kmc-analyze.analyzeoskrewritepua.data.md) `readonly` { \[index: string\]: Uint8Array; } Returns the file data for OSK files rewritten with PUA characters, for use with `&displayMap`.

Methods

Method Modifiers Description
[analyze(file, mapping)](./kmc-analyze.analyzeoskrewritepua.analyze.md) Analyze a keyboard file or files, and provide a remapped output. Accepts a .kmn, .kvks, .keyman-touch-layout file formats. For .kmn, will rewrite associated On Screen Keyboard file formats. Can be called multiple times to rewrite multiple files. Use the [AnalyzeOskRewritePua.data](./kmc-analyze.analyzeoskrewritepua.data.md) property to retrieve the output file content for writing. This does not modify the source file.
[clear()](./kmc-analyze.analyzeoskrewritepua.clear.md) Clears data collected from previous calls to [AnalyzeOskRewritePua.analyze()](./kmc-analyze.analyzeoskrewritepua.analyze.md)