MyScript iink SDK lets you consistently interact with different types of content via a unified API. This page lists supported content types and outlines the potential specificities of each of them.
MyScript iink SDK provides a generic way to interact with all types of content, conceptually illustrated by the diagram below:
For each type of content, and provided that it makes sense, you can consistently:
- Input digital ink and have it interpreted, or import data from supported import formats,
- Display the content,
- Interact with the content via editing/decoration gestures,
- Convert it to typeset form,
- Save/load content to/from the file system,
- Export/import ink and interpretation to/from MyScript’s readable and parseable exchange format, and integrate with your application or ecosystem,
- Export to a set of built-in supported export formats.
MyScript iink SDK currently supports the following content types:
"Text") - Simple block of multi-line text (including possible line breaks), responsive reflow. It shows guides by default but these can be deactivated (for instance when processing ink from an outside source that is not aligned on the guides).
"Math") - Block supporting one or more equation.
"Diagram") - Block supporting a diagram, with automatic text/non-text distinction and dynamic reorganization possibilities.
"Drawing") - Block hosting a collection of strokes without any interpretation. Useful for scribbles and drawing activities.
Text Document (
"Text Document") - Container hosting an ordered collection of text, math, diagram, raw content and drawing blocks. It is a vertical, dynamic and responsive stream of structured content.
Raw Content (
"Raw Content") - Block hosting digital ink with no explicit segmentation into text, math, diagram or other items which semantics is known by iink SDK. Content is analyzed by MyScript iink SDK to retrieve ink corresponding to text blocks from the rest of the content. In non-text blocks, according to its configuration, MyScript iink SDK can further distinguish shape from other blocks.
Raw Content is key to implement the following use cases: * Word search functionality on raw digital ink. You can obtain this information via a JIIX export. * Interactive raw content, where you write and draw freely on a wide canvas and interact with the content thanks to MyScript iink SDK interactive features: you can select some content to apply actions as copying or exporting it for further use, converting it, or transforming it. Note that by default, these features are not activated for the “Raw Content” type, so you should tune your configuration to benefit from them. For an overview of what is possible, refer to the interactive features page. For integration advice, take a look at the interactive white boards page that illustrates such a use case. In addition the “Raw Content” configuration section lists what you may tune.
The string value provided between brackets is case-sensitive and identifies the type in the model in an unambiguous way.
For a wider presentation of all types of content that MyScript technology can recognize, along with possible use cases, refer to the detailed presentation in the Concepts section of this documentation.
Drawing and Text Document are currently only supported by native platforms. Web support is planned for future versions.