Configuration

MyScript iink SDK is a flexible toolkit, and its default configuration can be adjusted to meet different needs. This page lists available options, their default values and usage.

The configuration is to be sent with the configuration message.

General

For the sake of clarity, path of parameter are given. For example export.jiix.bounding-box key match following entry in the body :

"configuration": {
  "export": {
    "jiix": {
      "bounding-box": "..."
    }
  }
}

Content type compatibility

Interactive Ink using WebSocket protocol supports MATH and TEXT recognition in onscreen mode and RAW CONTENT in offscreen mode. See architecture for more details on both modes.

General iink parameters

Key	Type	Default value	Description
`export.image-resolution`	number	96	Resolution of the images that are exported, in dpi.
`export.image.guides`	boolean	`false`	If `true`, show guides in the exported images.
`export.image.viewport.x`	number	none	The x-coordinate, in pixels, of the viewport origin to be used for the image export.
`export.image.viewport.y`	number	none	The y-coordinate, in pixels, of the viewport origin to be used for the image export.
`export.image.viewport.width`	number	none	The width, in pixels, of the viewport to be used for the image export.
`export.image.viewport.height`	number	none	The height, in pixels, of the viewport to be used for the image export
`export.jiix.bounding-box`	boolean	`false`	If `true`, JIIX export will contain the bounding boxes of exported items.
`export.jiix.strokes`	boolean	`true`	If `true`, JIIX export will include the detailed ink information.
`export.jiix.glyphs`	boolean	`true`	If `true`, JIIX export will include the converted glyphs.
`export.jiix.primitives`	boolean	`true`	If `true`, JIIX export will include the converted shape primitives.
`export.jiix.style`	boolean	`false`	If `true`, JIIX export will include the styling information.
`export.jiix.decimal-places`	number	-1	The maximum number of decimal places after the decimal separator for decimal precision in the JIIX export.
`export.jiix.math-label`	boolean	`true`	If `true`, JIIX export will include the LaTeX label for Math blocks.
`export.jiix.ids`	boolean	`false`	If `true`, JIIX export will include item ids: is useful to get items id, without having all item information: for instance having strokes ids without their full coordinates to avoid an heavy .jiix file.
`export.jiix.full-stroke-ids`	boolean	`false`	If `true`, JIIX export will include the IDs of the full strokes associated with each stroke. This is helpful for determining the origin of a partial stroke.
`export.jiix.ranges`	boolean	`false`	If `true`, JIIX export will include ink ranges of every object ^2: is useful for having strokes ranges without their full coordinates to avoid an heavy .jiix file.
`export.jiix.text.chars`	boolean	`false`	If `true`, JIIX export will include the detailed characters information.
`export.jiix.text.words`	boolean	`true`	If `true`, JIIX export will include the detailed words information.
`export.jiix.text.lines`	boolean	`false`	If `true`, JIIX export will include the detailed geometric information per line in the text interpretation.
`export.jiix.text.structure`	boolean	`false`	If `true`, JIIX export will include detailed information about the text layout structure for Text blocks.
`export.mathml.flavor`	string	`standard`	Defines the flavor you want for MathML export: possible values are `standard` and `ms-office`. The latter is recommended if you want to use exported MathML into Microsoft Office suite.
`lang`	string	`en_US`	Defines the language used in the editor.
`alwaysConnected`	boolean	`true`	Prevents the WebSocket session to be reinitialized every 5 minutes.
`renderer.debug.draw-image-boxes`	boolean	`false`	If `true`, displays the bounding of the images.
`renderer.debug.draw-text-boxes`	boolean	`false`	If `true`, displays the bounding of the words (for text) or characters (for math).
`gesture.enable`	boolean	`true`	If `true`, iink SDK will attempt to detect gestures while writing.

Text

Key	Type	Default value	Description
`text.eraser.erase-precisely`	boolean	`false`	If `false`, the eraser removes any character it touches, else it only erases ink portions within its trajectory.
`text.margin.bottom`	number	10	Margin from the bottom of the part to the bottom of the text bounding box (used for reflow).
`text.margin.left`	number	15	Margin from the left of the part to the left of the text bounding box (used for reflow).
`text.margin.right`	number	15	Margin from the right of the part to the right of the text bounding box (used for reflow).
`text.margin.top`	number	10	Margin from the top of the part to the top of the text bounding box (used for reflow).
`text.guides.enable`	boolean	`true`	If `true`, guides are visible and used for convert and reflow operations.
`text.configuration.customResources`	array of strings	`[]`	Name of the custom resources uploaded in the developer space to use. See the custom recognition reference documentation
`text.configuration.customLexicon`	array of strings	`[]`	List of custom words to be added to the recognition capabilities. See more about the lexicon.
`text.configuration.addLKText`	boolean	`true`	Choice to add to the configured custom resources, words in the lexicon of the current language. Note that, if set to `false`, only one word will be recognized from the inks you send.

Math

Key	Type	Default value	Description
`math.eraser.erase-precisely`	boolean	`false`	If `false`, the eraser removes any symbol it touches, else it only erases ink portions within its trajectory.
`math.margin.bottom`	number	10	Margin from the bottom of the part to the top of the math expression bounding box (used for conversion operations)
`math.margin.left`	number	15	Margin from the left of the part to the left of the math expression bounding box (used for conversion operations)
`math.margin.right`	number	15	Margin from the right of the part to the right of the math expression bounding box (used for conversion operations)
`math.margin.top`	number	10	Margin from the top of the part to the top of the math expression bounding box (used for conversion operations)
`math.customGrammarId`	string	`undefined`	Name of the custom grammar uploaded in the developer space to use. See the custom recognition documentation.
`math.customGrammarContent`	string	`undefined`	Custom math grammar text. See the reference documentation to know how to build your custom grammar.

Math solver

Key	Type	Default value	Description
`math.solver.angle-unit`	string	`deg`	Unit of the angle computation in the solver: It must be either `deg` (degrees) or `rad` (radians)
`math.solver.decimal-separator`	string	`.`	The decimal separator symbol (usually `.` or `,`).
`math.solver.enable`	boolean	`true`	If `true`, displays solver result upon conversion.
`math.solver.number-format`	string	`decimal`	The way the solver displays the results: `decimal` (e.g. "2.4"), `rational` (e.g. "3/2") or `mixed` (e.g. "1½").
`math.solver.fractional-part-digits`	number	3	The number of decimals to display in solver computation result.
`math.solver.rounding-mode`	string	`half up`	Rounding method used display solver results: It must be either `half up` or `truncate`.
`math.solver.fraction-mode`	string	`decimal`	The way solver results shall be displayed: `decimal` (e.g. "2.4"), `rational` (e.g. "3/2") or `mixed` (e.g. "1½").
`math.solver.options`	string	`algebraic`	Use `numeric` to let the solver potentially modify the structure of the expression to obtain something computable. Use `algebraic` to preserve the structure of the input in any case.
`math.solver.auto-variable-management.enable`	boolean	`false`	If true, enables the automatic management of variables.
`math.solver.auto-variable-management.scoping-policy`	string	`closest`	The scoping policy determines which variable definitions apply to a formula, identified by its block Id, when variables are used across formulas. Possible values are: `closest` the definition from the closest block in spatial distance is used, `last-modified` the most recently modified block is used, `last-edited`, similar to `last-modified`, but moving a block does not count as a modification.

Raw Content

Key	Type	Default value	Description
`raw-content.classification.types`	string array	`["text","shape","drawing"]`	Controls the list of content types that can be output by the ink strokes classifier. If content types are removed from this list, the corresponding strokes are output as part of the most likely alternative choice among the remaining content types. Possible values are `text`, `shape`, `math`, `decoration` and `drawing`.
`raw-content.recognition.types`	string array	<empty>	Defines the type of recognition that will be performed on this content and the result that will be available in the JIIX export. Possible values are `text`, `math`, and `shape`.
`raw-content.eraser.erase-precisely`	boolean	`false`	If `false`, the eraser removes any symbol it touches, else it only erases ink portions within its trajectory.
`raw-content.gestures`	array of strings	`[]`	A string array containing any of the enabled gestures: {scratch-out, underline, insert, join, strike-through, surround}. By default, it is empty, so no gesture is enabled.