Ink Pen Tool
Description
Properties that impact the pen tool.
- Name
- Description
- Smoothing
The smoothing that should be done when capturing Ink. The higher the value the smoother the stroke and the fewer Ink points will be captured. The default smoothing value is '2', which will lead to strokes captured at a zoomed out left still looking smooth when zoomed in.
- Active class name
A CSS class that gets added to the Ink Control when the pen tool is active.
- Memory on ink load
What should happen to the pen on ink load. The 'current' option will keep the currently active pen. The 'last' option will use the last pen that was used in the Ink. If no pen can be found and loaded, then the base pen will be used. The 'base' option will switch back to the base pen.
- Memory on ink clear
What should happen to the pen on ink clear. The 'current' option will keep the currently active pen and the 'base' option will switch back to the base pen.
- Base pen
The base pen that will be used when no other pen has been selected.
- Preview size
The size of the pen preview. The pen preview is shown if you have specified an element with an ID of the Ink controls ID plus ".PENPREVIEW".
- Preview width text
Whether to show the width of the pen in text in the preview. Options are 'never', 'auto', and 'always'. The 'auto' option will only show the width if the pen is larger than the preview area. The preview pen is shown if you have specified an element with an ID of the Ink control's ID plus ".PENPREVIEW".
- Preview clip shape
The clip shape to use on the pen preview. The 'circle' option will clip the pen preview with a circle, allowing it to fit in a round button. The pen preview is shown if you have specified an element with an ID of the Ink control's ID plus ".PENPREVIEW"