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 sent in the request body with each call the REST endpoint. Refer to the user guide for more instructions.
Defines the flavor you want for GraphML export: possible values are standard and yed. The latter is recommended if you want to edit exported GraphML into yEd. The yEd flavor is also more expressive and thus truthful.
export.image-resolution
number
96
Resolution of the images that are exported, in dpi.
export.image-max-size
number
4096
Maximum width and height of exported images.
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.style
boolean
false
If true, JIIX export will include the styling information.
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.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.
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.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.
If true, Diagram blocks contain sub blocks that describe the diagram content.
diagram.convert.edge
boolean
true
If true, Diagram edges will be turned into neat primitives when converting.
diagram.convert.node
boolean
true
If true, Diagram nodes will be turned into neat shapes when converting.
diagram.convert.text
boolean
true
If true, Diagram text will be turned into typeset when converting.
diagram.text.customResources
array of strings
[]
Name of the custom resources uploaded in the developer space to use for the text recognition. See the custom recognition reference documentation
diagram.text.customLexicon
array of strings
[]
List of custom words to be added to the recognition capabilities. See more about the lexicon.
diagram.text.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.
Activate the recognition of the extracted text parts
raw-content.recognition.shape
boolean
false
Activate the recognition of the extracted shape parts
raw-content.text.customResources
array of strings
[]
Name of the custom resources uploaded in the developer space to use for the text recognition. See the custom recognition reference documentation
raw-content.text.customLexicon
array of strings
[]
List of custom words to be added to the recognition capabilities. See more about the lexicon.
raw-content.text.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.
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.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.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.0”), 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.customGrammarId
string
undefined
Name of the custom grammar uploaded in the developer space to use. See the custom recognition documentation.