What's new

Introducing iink SDK 4.️0 native APIs

If you upgrade from 3.2, please take a look at the migration guide.

Major enhancements to our Editor and OffscreenEditor Raw Content

New analyzer

Our advanced analyzer, developed for the Raw Content Recognizer, has been ported to the Editor and OffscreenEditor, improving their document layout analysis and ink classification. This new analyzer also makes it possible to perform math automatic classification in Editor and OffscreenEditor Raw Content.

  • To use the new analyzer, all you need to do is configure the raw-content.configuration.analyzer.bundle property of your analyzer bundle with raw-content2, which points to the corresponding resource contained in the myscript-iink-recognition-raw-content2.zip package, and deploy it into your project.
  • To perform math automatic classification with it, you must also adjust your recognizer.raw-content.classification.types to add math.

Math recognition enhancements

Our cutting-edge math recognition engine, developed for the Math Recognizer, is now available with Editor and OffscreenEditor Raw Content. It is based on our latest math technology and improves recognition accuracy and performance.

  • To use it, you need to use our latest analyzer described above, and configure the math bundle of your Raw Content to math2, which points to the corresponding resource contained in the myscript-iink-recognition-math2.zip package, and deploy that resource into your project.

Math solver

You can now use a MathSolverController object to get solver output from a Math block in a Raw Content part with Editor and OffscreenEditor. This object allows you to:

  • list the available actions with the getAvailableActions method (currently only numeric calculation is available),
  • get the solution result as a LaTeX or JIIX string with the getActionOutput method,
  • add the solution output to the math block in the current Content Part with the applyAction method (currently only available with the Editor).

➤ These three new features bring the full support for math content within a Raw Content part. For more details on all Raw Content features, see the Raw Content Highlights section.

Pressure, tilt and orientation support

When digital pens provide pressure levels, tilt and orientation angles in the input pointer events for the Editor, our Renderer now adjusts the stroke rendering depending on the styling CSS properties. For example, tilting a pen with our pencil-style brush can create wider, softer strokes, much like shading with the side of a real pencil. In order to support this new feature, we have introduced:

  • New APIs that will allow you to send us this tilt and orientation information:
    • New InkPoint, InkPoints and PointerEvent constructors with tilt and orientation information.
    • Editor has new pointerDown, pointerUp and pointerMove methods with tilt and orientation information.
    • If tilt and orientation are provided in pointer events, they will also be present in the stroke items of the JIIX export.
  • Three new CSS styling options -myscript-pen-orientation-sensitivity, -myscript-pen-tilt-sensitivity and -myscript-pen-pressure-sensitivity to adjust the effect of orientation, tilt and pressure sensitivity on stroke rendering. By default, these styling effects are disabled, so refer to the styling page to learn how to configure them.

Other changes

JIIX changes

To support the JIIX export of our new analyzer and math recognition outputs, we have introduced new items in the JIIX export. To get these new items in your JIIX file you should enable the two new properties export.jiix.text.lines and export.jiix.text.spans.

➤ See the JIIX reference page and the configuration page for more information.

➤ To support these changes, we have also refactored some character information in the JIIX file, so be sure to read the migration guide.

Deprecations to prepare the generalization of our latest analyzer and recognition engines

Our new analyzer and latest recognition engines are based on new neural network architectures that provide highly accurate results with high performance processing. MyScript iink SDK is gradually migrating to them.

➤ The UWP and WinUI 2 frameworks that are part of the Windows SDK lack support for some libraries that allow the use of these architectures. Therefore, the latest engines cannot be used in UWP applications. In addition, Microsoft has announced that most new features and capabilities, including support for the latest .NET runtimes, will only be added to the Windows App SDK / WinUI 3.

For both reasons, support for UWP / WinUI 2 in iink SDK is deprecated and may be removed in a future release.