Migration guide

This page lists the key points to pay attention to when migrating existing code from MyScript iink SDK 3.2 to the new MyScript iink SDK 4.0.

MyScript iink SDK 4.0 comes packed with improvements and several noticeable new features. This page provides an overview of the changes.

Changes for pressure

When digital pens provide pressure levels in the input pointer events for the Editor, our Renderer now adjusts the stroke rendering depending on the value of the -myscript-pen-pressure-sensitivity styling CSS property.

With the introduction of this new CSS property, we have deprecated the renderer.stroker.real-pressure-factor configuration property. If you were using this configuration property, we recommend replacing its use with a style that sets the -myscript-pen-pressure-sensitivity value. For more details, refer to the styling guide.

JIIX changes

  • For clarity, the generated attribute for the math node block in JIIX file has been renamed to solver-output.
  • For consistency, first-char and last-char character indices in words, lines and style spans objects are now only present if chars objects are exported, i.e. if export.jiix.text.chars is true.
  • From now, the label for the text elements words, lines and spans have inlined math label included where appropriate. Inlined math labels are delimited by $.

➤ For more details, refer to the JIIX reference page.

Text Document changes

Up to iink SDK 4.0, the configuration name and bundle for each block type of the Text Document had preset values corresponding to the block default values and could not be changed.

The configuration name and bundle of the “Math”, “Diagram” and “Raw Content” blocks now also apply within a Text Document.

Backward and forward compatibility

The new iink SDK 4.0 features are the new analyzer, the new math recognition engine and math solver for Raw Content Editor and OffScreenEditor, and the pen tilt and pen orientation support.

  • Any ContentPart/ContentPackage created with iink SDK 4.0 is compatible with previous iink SDK versions, if no new feature is used.
  • Any ContentPart/ContentPackage created with iink SDK 4.0 is NOT compatible with previous iink SDK versions if any of the new iink SDK 4.0 features is used.
  • If you change the recognition configuration of an existing iink file when you reopen it, all previous recognition results are lost and recognition is performed again.