erabo/spiegel-keyman
1
0
Fork 0
mirror of https://github.com/keymanapp/keyman.git synced 2026-08-05 08:25:32 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 10
spiegel-keyman/developer/docs/help/reference/api/kmc-analyze.analyzeoskrewritepua.md
Marc Durdin b751336c13 refactor(developer): copy dev 17.0 help into repo 
1. Copy help.keyman.com/developer/17.0/* into /developer/docs/help
2. Update references to 18.0 where appropriate
3. Copy all referenced images from /cdn/dev into
   /developer/docs/help/images and update links in documentation

Next commit: add deployment to help-keyman-com.sh. Note: simplest way to
test links at this point is to use the help.keyman.com auto deploy and
wait for the PR on help.keyman.com to be validated; we could look at an
internal link validation tool that verifies markdown links?

Relates-to: #12347
2024-09-16 08:46:24 +07:00

1.8 KiB
Raw Blame History

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) Constructs a new instance of the AnalyzeOskRewritePua class

Properties

Property Modifiers Type Description
data 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) 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 property to retrieve the output file content for writing. This does not modify the source file.
clear() Clears data collected from previous calls to AnalyzeOskRewritePua.analyze()