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

33 lines
1.8 KiB
Markdown

<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md) &gt; [@keymanapp/kmc-analyze](./kmc-analyze.md) &gt; [AnalyzeOskRewritePua](./kmc-analyze.analyzeoskrewritepua.md)
## AnalyzeOskRewritePua class
Rewrite On Screen Keyboard files (.kvks, .keyman-touch-layout) with PUA codepoints, based on analysis provided by [AnalyzeOskCharacterUse](./kmc-analyze.analyzeoskcharacteruse.md) class.
**Signature:**
```typescript
export declare class AnalyzeOskRewritePua
```
## Constructors
| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(callbacks)](./kmc-analyze.analyzeoskrewritepua._constructor_.md) | | Constructs a new instance of the <code>AnalyzeOskRewritePua</code> class |
## Properties
| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [data](./kmc-analyze.analyzeoskrewritepua.data.md) | <code>readonly</code> | { \[index: string\]: Uint8Array; } | Returns the file data for OSK files rewritten with PUA characters, for use with <code>&amp;displayMap</code>. |
## 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) |