iink-ts - v4.0.0
    Preparing search index...

    iink-ts - v4.0.0

    iinkTS

    npm version Examples Documentation

    The fastest way to integrate rich handwriting features in your webapp.

    :point_right: Examples:point_left:

    iinkTS is a TypeScript library that can be used in every web application to bring handwriting recognition.

    It integrates all you need:

    • Signal capture for all devices,
    • Digital ink rendering,
    • Link to MyScript Cloud to bring handwriting recognition.
    • Text and Math support,
    • Easy to integrate,
    • Digital ink capture and rendering,
    • Rich editing gestures,
    • Import and export content,
    • Styling,
    • Typeset support,
    • More than 200 mathematical symbols supported,
    • 72 supported languages.

    You can discover all the features on our Developer website for Text and Math.

    1. Have npm, yarn.
    2. Have a MyScript developer account. You can create one here.
    3. Get your keys and the free monthly quota to access MyScript Cloud at developer.myscript.com

    iinkTS can be installed with the well known package managers npm, yarn.

    If you want to use npm or yarn you first have to init a project (or use an existing one).

    npm init
    OR
    yarn init

    You can then install iinkTS and use it as showed in the Usage section.

    npm install iink-ts
    OR
    yarn add iink-ts

    1. Create an index.html file in the same directory.

    2. Add the following lines in the head section of your file to use iinkTS and the css :

    <script src="node_modules/iink-ts/dist/iink.min.js"></script>
    1. Still in the head section, add a style and specify the height and the width of your canvas:
    <style>
      #canvas {
        width: 100%;
        height: 100%;
      }
    </style>
    1. In the body tag, create a div tag that will contain the drawing area:
    <div id="canvas"></div>
    1. In JavaScript and within a <script> tag placed before the closing </body> tag, create the canvas using the load function, your HTML element, the desired type and the possible options depending on the type, then initialize it:
        const canvasElement = document.getElementById('canvas');
        const options = {
          configuration: {
            server: {
              scheme: "https",
              host: "cloud.myscript.com",
              applicationKey: "<YOU-APPLICATION-KEY>",
              hmacKey: "<YOUR-HMAC-KEY>",
            }
          }
        }
        const canvasType = "INTERACTIVE_INK" /* or INTERACTIVE_INK_SSR or INK_V1 or INK_V2 */
        const canvas = iink.Canvas.load(canvasElement, canvasType, options);
    1. Your index.html file should look like this:
    <html>
      <head>
        <script src="node_modules/iink-ts/dist/iink.min.js"></script>
        <style>
          #canvas {
            width: 100%;
            height: 100%;
          }
        </style>
      </head>
      <body>
        <div id="canvas"></div>
        <script>
          const canvasElement = document.getElementById("canvas")
          const options = {
            configuration: {
              server: {
                scheme: "https",
                host: "cloud.myscript.com",
                applicationKey: "<YOU-APPLICATION-KEY>",
                hmacKey: "<YOUR-HMAC-KEY>",
              },
            }
          }
          const canvasType = "INTERACTIVE_INK" /* or INTERACTIVE_INK_SSR or INK_V1 or INK_V2 */
          const canvas = iink.Canvas.load(canvasElement, canvasType, options)
        </script>
      </body>
    </html>
    1. Open index.html in your browser or serve your folder content using any web server.

    You can find this guide, and a more complete example on the MyScript Developer website.

    1. Create an index.html file in the same directory.

    2. Add the following lines in the body section of your file to use iinkTS and the css :

    <body>
      <div id="canvasEl"></div>

      <script type="module">
        import { Canvas, getAvailableLanguageList } from "../../dist/iink.esm.js"
        const canvasElement = document.getElementById("canvasEl")

        const options = {
          configuration : {
            server: {
              scheme: "https",
              host: "cloud.myscript.com",
              applicationKey: "<YOU-APPLICATION-KEY>",
              hmacKey: "<YOUR-HMAC-KEY>",
            },
          }
        }

        const canvasType =
          "INTERACTIVE_INK" /* or INTERACTIVE_INK_SSR or INK_V1 or INK_V2 */
        const canvas = await Canvas.load(canvasElement, canvasType, options)
      </script>
    </body>
    1. Your index.html file should look like this:
    <html>
      <head>
        <style>
          #canvasEl {
            width: 100%;
            height: 100%;
          }
        </style>
      </head>
      <body>
        <div id="canvasEl"></div>
        <script type="module">
          import { Canvas, getAvailableLanguageList } from '../../dist/iink.esm.js'
          const canvasElement = document.getElementById('canvasEl')

          const options = {
            configuration: {
              server: {
                scheme: "https",
                host: "cloud.myscript.com",
                applicationKey: "<YOU-APPLICATION-KEY>",
                hmacKey: "<YOUR-HMAC-KEY>",
              }
            }
          }

          const canvas = await Canvas.load(canvasElement, 'INTERACTIVE_INK_SSR', options)
        </script>
      </body>
    </html>

    You can find a complete documentation with the following sections on our Developer website:

    We also provide a complete API Reference.

    If you're integrating iinkTS or rebuilding your own client from scratch, these diagrams cover the class organization and the WebSocket protocol:

    Upgrading from an earlier major version? See MIGRATION.md for breaking changes and step-by-step instructions.

    Instructions to help you build the project and develop are available in the SETUP.md file.

    You can get support and ask your questions on the dedicated section of MyScript Developer website.

    Made a cool app with iinkTS? We would love to hear about you! We’re planning to showcase apps using it so let us know by sending a quick mail to myapp@myscript.com.

    We welcome your contributions: if you would like to extend iinkTS for your needs, feel free to fork it!

    Please take a look at our contributing guidelines before submitting your pull request.

    If you encounter the error: Unrecognized property: convert.force, this means your server version is lower than 2.3.0. To correct the problem, you have 2 options:

    • either update your server
    • either add in the iink-ts configuration configuration.server.info.version = 2.2.0

    If you encounter the error: Unrecognized property: configuration.export.jiix.text.lines, this means your server version is lower than 3.2.0. To correct the problem, you have 2 options:

    • either update your server
    • either add in the iink-ts configuration configuration.server.info.version = 3.1.0

    This library is licensed under the Apache 2.0.

    Settings
    Member Visibility

    On This Page
    iinkTS