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

      iink-ts - v4.0.0

      <internal>
      Canvas

      Main Canvas facade for loading canvas instances

      This class provides a convenient interface for loading canvas instances. It delegates to CanvasFactory for the actual implementation.

      CanvasEvent
      CanvasEventName
      CanvasLayer
      CanvasThemes
      CanvasTool

      List the possibilities of interactions

      CanvasWriteTool

      List all the shapes that can be drawn

      DefaultCanvasTriggerConfiguration
      DefaultInkCanvasConfiguration
      DefaultInkCanvasDeprecatedConfiguration
      DefaultInteractiveInkCanvasConfiguration
      DefaultInteractiveInkSSRCanvasConfiguration
      GESTURE_OPERATION_LABELS
      InkCanvas
      InkCanvasConfiguration
      InkCanvasDeprecated
      InkCanvasDeprecatedConfiguration
      InteractiveInkCanvas
      InteractiveInkCanvasConfiguration
      InteractiveInkSSRCanvas
      InteractiveInkSSRCanvasConfiguration
      TCanvasConnectionState
      TCanvasLayerUI
      TCanvasLayerUIState
      TCanvasOperationLabel
      TCanvasStateDetail
      TCanvasTheme
      TCanvasTriggerConfiguration
      TCanvasType
      THEME_STORAGE_KEY
      TInkCanvasConfiguration
      TInkCanvasDeprecatedConfiguration
      TInkCanvasDeprecatedOptions
      TInkCanvasOptions
      TInteractiveInkCanvas
      TInteractiveInkCanvasConfiguration
      TInteractiveInkCanvasOptions
      TInteractiveInkSSRCanvasConfiguration
      TInteractiveInkSSRCanvasOptions
      ClientError
      ClientEvent
      ClientEventName

      Lists all events that can be listened to on the canvas or DOM element

      DefaulRecognitionHTTPV1ConfigurationConfiguration
      DefaultConvertionConfiguration
      DefaultDebugConfiguration
      DefaultDiagramConfiguration
      DefaultDiagramConvertConfiguration
      DefaultEraserConfiguration
      DefaultExportConfiguration
      DefaultHTTPClientV1Configuration
      DefaultHTTPClientV2Configuration
      DefaultHTTPClientV2RecognitionConfiguration
      DefaultJiixConfiguration
      DefaultMarginConfiguration
      DefaultMathConfiguration
      DefaultMathUndoRedoConfiguration
      DefaultMathV2Configuration
      DefaultRawContentConfiguration
      DefaultRawContentV2Configuration
      DefaultRecognitionRendererConfiguration
      DefaultRecognitionWebSocketConfiguration
      DefaultServerHTTPConfiguration
      DefaultServerWebsocketConfiguration
      DefaultShapeBeautificationConfiguration
      DefaultShapeConfiguration
      DefaultShapeConvertConfiguration
      DefaultSolverConfiguration
      DefaultTexConfigurationV2
      DefaultTextConfiguration
      DefaultTextGuidesConfiguration
      DefaultTextGuidesConfigurationV2
      DefaultWebSocketClientConfiguration
      DefaultWebSocketSSRClientConfiguration
      DefaultWebSocketSSRClientRecognitionConfiguration
      HTTPClientV1
      HTTPClientV1Configuration
      HTTPClientV2
      HTTPClientV2Configuration
      mapCloseCodeToMessage
      TAngleUnit
      TConnectionStatus
      TConverstionState
      TConvertionConfiguration
      TDiagramConfiguration
      TDiagramConvertConfiguration
      TEraserConfiguration
      TExportConfiguration
      THTTPClientV1Configuration
      THTTPClientV1PostConfiguration
      THTTPClientV1PostData
      THTTPClientV2Configuration
      THTTPClientV2PostConfiguration
      THTTPClientV2PostData
      THTTPClientV2RecognitionConfiguration
      TImageConfiguration
      TImageViewportConfiguration
      TInteractiveInkSessionDescriptionMessage
      TJiixConfiguration
      TMarginConfiguration
      TMathConfiguration
      TMathEvaluable
      TMathMLExport
      TMathMLFlavor
      TMathUndoRedoConfiguration
      TMathVariable
      TMathVariableDefinition
      TMathVariableDefinitionInfo
      TMathVariableDefinitions
      TRawContentConfiguration
      TRecognitionHTTPV1Configuration
      TRecognitionRendererConfiguration
      TRecognitionRendererDebugConfiguration
      TRecognitionTypeBase
      TRecognitionTypeV1
      TRecognitionTypeV2
      TRecognitionWebSocketConfiguration
      TRoundingMode
      TScheme
      TServerHTTPConfiguration
      TServerWebsocketConfiguration
      TShapeBeautificationConfiguration
      TShapeConfiguration
      TShapeConvertConfiguration
      TSolverConfiguration
      TSolverOptions
      TTextConfConfiguration
      TTextConfiguration
      TTextGuidesConfiguration
      TTextGuidesConfigurationV2
      TTextHTTPClientV2ConfConfiguration
      TTextHTTPClientV2Configuration
      TUndoRedoMode
      TUpdatePatch
      TUpdatePatchAppendChild
      TUpdatePatchInsertBefore
      TUpdatePatchRemoveAttribut
      TUpdatePatchRemoveChild
      TUpdatePatchRemoveElement
      TUpdatePatchReplaceAll
      TUpdatePatchReplaceELement
      TUpdatePatchSetAttribut
      TUpdatePatchType
      TWebSocketClientConfiguration
      TWebSocketClientMessage
      TWebSocketClientMessageAck
      TWebSocketClientMessageAuthenticated
      TWebSocketClientMessageContentChange
      TWebSocketClientMessageContextlessGesture
      TWebSocketClientMessageError
      TWebSocketClientMessageExport
      TWebSocketClientMessageGesture
      TWebSocketClientMessageHMACChallenge
      TWebSocketClientMessageIdle
      TWebSocketClientMessageMathSolverAsVariableDefinition
      TWebSocketClientMessageMathSolverAvailableActions
      TWebSocketClientMessageMathSolverEvaluate
      TWebSocketClientMessageMathSolverGetDiagnostic
      TWebSocketClientMessageMathSolverGetEvaluables
      TWebSocketClientMessageMathSolverGetVariableDefinitions
      TWebSocketClientMessageMathSolverGetVariables
      TWebSocketClientMessageMathSolverGetVariableValue
      TWebSocketClientMessageMathSolverNumericalComputation
      TWebSocketClientMessageMathSolverRemoveVariableValue
      TWebSocketClientMessageMathSolverResult
      TWebSocketClientMessageMathSolverSetVariableValue
      TWebSocketClientMessageNewPart
      TWebSocketClientMessagePartChange
      TWebSocketClientMessagePong
      TWebSocketClientMessageReceived
      TWebSocketClientMessageType
      TWebSocketSSRClientConfiguration
      TWebSocketSSRClientMessage
      TWebSocketSSRClientMessageContentChange
      TWebSocketSSRClientMessageContentPackageDescriptionMessage
      TWebSocketSSRClientMessageError
      TWebSocketSSRClientMessageExport
      TWebSocketSSRClientMessageHMACChallenge
      TWebSocketSSRClientMessagePartChange
      TWebSocketSSRClientMessageSVGPatch
      TWebSocketSSRClientRecognitionConfiguration
      WebSocketClient
      WebSocketClientConfiguration
      WebSocketSSRClient
      WebSocketSSRClientConfiguration
      Chart
      IIMathCapabilitiesTable
      IIMathDiagnosticChecker
      IIMathFunctionEvaluator
      IIMathVariableCanvas
      IIMathVariableInputList
      IIMathVariablePerBlockCanvas
      Minimap
      SOURCE_TYPE_COLORS
      SOURCE_TYPE_LABELS
      Table
      TChartConfig
      TEvaluationResult
      TMathEvaluableFunction
      TMathSymbolCapabilities
      TMinimapOptions
      TModalConfig
      TModalField
      TModalFieldOption
      TModalType
      TSymbolDiagnostic
      TSymbolVariables
      TTableCellConfig
      TTableColumn
      TTableConfig
      TTableRow
      TVariableInputItem
      MathDiagnosticMessages
      TWO_PI
      buildButton
      buildCanvas
      buildCheckbox
      buildDiv
      buildFileInput
      buildH3
      buildLabel
      buildNumberInput
      buildOption
      buildOutput
      buildP
      buildRange
      buildSection
      buildSelect
      buildSpan
      buildStyle
      buildTable
      buildTBody
      buildTd
      buildTextInput
      buildTh
      buildTHead
      buildTr
      DOMFactory
      TButtonElConfig
      TCheckboxElConfig
      TContainerElConfig
      TFileInputElConfig
      TInputElConfig
      TLabelElConfig
      TOutputElConfig
      TRangeElConfig
      TSelectElConfig
      TSelectElOption
      TTableBaseElConfig
      TTableCellElConfig
      ExportType
      ExportV2Type
      JIIXEdgeKind
      JIIXElementType
      JIIXMathExpressionType
      JIIXNodeKind
      JIIXV2ShapeKind
      TExport
      TExportV2
      TJIIXBase
      TJIIXChar
      TJIIXEdgeArc
      TJIIXEdgeElement
      TJIIXEdgeElementBase
      TJIIXEdgeLine
      TJIIXEdgePolyEdge
      TJIIXElement
      TJIIXElementBase
      TJIIXExport
      TJIIXLine
      TJIIXMathElement
      TJIIXMathExpression
      TJIIXMathExpressionBase
      TJIIXMathExpressionTypeValue
      TJIIXMathFraction
      TJIIXMathGroup
      TJIIXMathNumber
      TJIIXMathOperator
      TJIIXMathPower
      TJIIXMathRoot
      TJIIXMathSquareRoot
      TJIIXMathSubscript
      TJIIXMathSubsuperscript
      TJIIXMathSuperscript
      TJIIXMathSymbol
      TJIIXMathSymbolExpression
      TJIIXMathUnderoverscript
      TJIIXMathVariable
      TJIIXNodeCircle
      TJIIXNodeElement
      TJIIXNodeElementBase
      TJIIXNodeEllipse
      TJIIXNodeParallelogram
      TJIIXNodePolygon
      TJIIXNodeRectangle
      TJIIXNodeRhombus
      TJIIXNodeTriangle
      TJIIXStrokeItem
      TJIIXTextElement
      TJIIXV2Base
      TJIIXV2Circle
      TJIIXV2DrawingElement
      TJIIXV2Element
      TJIIXV2ElementBase
      TJIIXV2Ellipse
      TJIIXV2EllipseBase
      TJIIXV2Export
      TJIIXV2Expression
      TJIIXV2Line
      TJIIXV2LineSpan
      TJIIXV2MathElement
      TJIIXV2PolygonBase
      TJIIXV2PolygonType
      TJIIXV2PrimitiveArc
      TJIIXV2PrimitiveLine
      TJIIXV2Range
      TJIIXV2RangeItem
      TJIIXV2RawContentBase
      TJIIXV2RawContentElement
      TJIIXV2RawContentItemShape
      TJIIXV2RawContentItemText
      TJIIXV2RawContentShape
      TJIIXV2RawContentTextLine
      TJIIXV2ShapeArcOfCircle
      TJIIXV2ShapeArcOfEllipse
      TJIIXV2ShapeCurvedArrow
      TJIIXV2ShapeCurvedDoubleArrow
      TJIIXV2ShapeElement
      TJIIXV2ShapeItemBase
      TJIIXV2ShapeLine
      TJIIXV2ShapeLineArrow
      TJIIXV2ShapeLineDoubleArrow
      TJIIXV2ShapeLinePolyline
      TJIIXV2ShapeLinePolylineArrow
      TJIIXV2ShapeLinePolylineDoubleArrow
      TJIIXV2ShapePolygon
      TJIIXV2ShapePolygonEquilateralTriangle
      TJIIXV2ShapePolygonIsoscelesTriangle
      TJIIXV2ShapePolygonParallelogram
      TJIIXV2ShapePolygonQuadrilateral
      TJIIXV2ShapePolygonRectangle
      TJIIXV2ShapePolygonRhombus
      TJIIXV2ShapePolygonRightIsoscelesTriangle
      TJIIXV2ShapePolygonRightTriangle
      TJIIXV2ShapePolygonSquare
      TJIIXV2ShapePolygonTrapezoid
      TJIIXV2ShapePolygonTriangle
      TJIIXV2TextElement
      TJIIXWord
      DefaultGrabberConfiguration
      DefaultListenerConfiguration
      PointerEventGrabber
      TGrabberConfiguration
      TListenerConfiguration
      TPointerInfo
      AbstractHistoryStack
      DefaultHistoryConfiguration
      extractIIBackendChanges
      getInitialHistoryContext
      HistoryManager
      IHistoryManager
      IIHistoryManager
      THistoryConfiguration
      THistoryContext
      TIHistoryChanges
      TIHistoryStackItem
      TIIHistoryBackendChanges
      TIIHistoryChanges
      TIIHistoryStackItem
      DefaultLoggerConfiguration
      Logger
      LoggerCategory
      LoggerLevel
      LoggerManager
      TLoggerConfiguration
      AbstractWriterManager
      ColorPaletteManager
      DefaultGestureConfiguration
      DefaultOverlayConfig
      DefaultSelectionConfig
      DefaultSnapConfiguration
      EraseManager
      GestureHandler
      GestureHelpers
      IDebugSVGManager
      IIAbstractManager
      IIAbstractTransformManager
      IIConnectorManager
      IIConversionManager
      IIGestureAnnotationProcessor
      IIGestureManager
      IIJiixQueryManager
      IIKeyboardManager
      IIMathCapabilitiesSubManager
      IIMathComputationSubManager
      IIMathFunctionEvaluationSubManager
      IIMathManager
      IIMathVariableSubManager
      IIMenuManager
      IIMoveManager
      IIOverlayManager
      IIPlaybackManager
      IIResizeManager
      IIRotationManager
      IISelectionManager
      IISnapManager
      IISynchronizerManager
      IITransformManager
      IITranslateManager
      IITypesetManager
      IIWriterManager
      InsertAction

      List all action allowed on split detected

      InsertGestureHandler
      IWriterManager
      JoinGestureHandler
      ScratchGestureHandler
      SnapConfiguration
      StrikeThroughAction

      List all action allowed on strikeThrough detected

      StrikeThroughGestureHandler
      SurroundAction

      List all action allowed on surround detected

      SurroundGestureHandler
      TBlockTextMetadata
      TGesture
      TGestureAnnotation
      TGestureConfiguration
      TGestureHandler
      TGestureType

      List all authorized gestures

      THittable
      TJiixIndex
      TMathBlockCapabilities
      TMathBlockComputation
      TMathComputationConfig
      TMathConfig
      TMathDependencies
      TMathInteractionConfig
      TMathResultMode
      TMathSelectionLevel
      TMathVariableUsage
      TOverlayConfig
      TPlaybackState
      TSelectionConfig
      TShapeSelectionLevel
      TSnapConfiguration
      TSnapLineInfos
      TSnapNudge
      TStrokeQueryResult
      TTextSelectionLevel
      TVariableEncartItem
      UnderlineAction

      List all action allowed on underline detected

      UnderlineGestureHandler
      BaseMenuItem
      ButtonListMenuItem
      ButtonMenuItem
      CheckboxMenuItem
      ClearMenuAction
      CollapsibleWrapper
      ColorListMenuItem
      ConvertContextMenu
      ConvertMenuAction
      createMenuItemInstance
      DecoratorContextMenu
      DEFAULT_ERASER_SIZE_LIST
      DEFAULT_FONT_SIZE_LIST
      DEFAULT_FONT_WEIGHT_LIST
      DEFAULT_MENU_COLORS
      DEFAULT_THICKNESS_LIST
      DefaultMenuActionConfig
      DefaultMenuConfiguration
      DefaultMenuContextConfig
      DefaultMenuStyleConfig
      DefaultMenuToolConfig
      DuplicateContextMenu
      EdgeTool
      EditContextMenu
      EraseTool
      ExportContextMenu
      ExportMenuAction
      FileInputMenuItem
      FillColorStyle
      FontSizeStyle
      FontWeightStyle
      GestureMenuAction
      GuideMenuAction
      IIMenuAction
      IIMenuContext
      IIMenuStyle
      IIMenuTool
      ImportMenuAction
      LanguageMenuAction
      MathContextMenu
      MathMenuAction
      MinimapMenuAction
      MoveTool
      OpacityStyle
      OverlayMenuAction
      RangeMenuItem
      RemoveContextMenu
      ReorderContextMenu
      SelectAllContextMenu
      SelectionMenuAction
      SelectMenuItem
      SelectTool
      ShapeTool
      SnapMenuAction
      StrokeColorStyle
      TAllMenuItems
      TContextDecoratorConfig
      TContextDecoratorItemsConfig
      TContextExportConfig
      TContextExportItemsConfig
      TContextMathConfig
      TContextMathItemsConfig
      TContextReorderConfig
      TContextReorderItemsConfig
      TExportActionConfig
      TExportActionItemsConfig
      TGenericMenuItem
      TGestureActionConfig
      TGestureActionItemsConfig
      TGuideActionConfig
      TGuideActionItemsConfig
      ThemeMenuAction
      ThicknessStyle
      TMathActionConfig
      TMathActionItemsConfig
      TMenuActionConfig
      TMenuButton
      TMenuButtonList
      TMenuCheckbox
      TMenuColorList
      TMenuConfigUpdate
      TMenuConfiguration
      TMenuContextConfig
      TMenuFileInput
      TMenuItemBase
      TMenuPosition
      TMenuRange
      TMenuSelect
      TMenuStyleConfig
      TMenuSubMenu
      TMenuToolConfig
      TOverlayActionConfig
      TOverlayActionItemsConfig
      TSelectionActionConfig
      TSelectionActionItemsConfig
      TSnapActionConfig
      TSnapActionItemsConfig
      TSubMenuItems
      UndoRedoMenuAction
      WriteTool
      ZoomMenuAction
      IIModel
      IModel
      Model
      TRecognitionPositions
      BaseRenderer

      Abstract base class for all renderer implementations

      Defines the common interface that both Canvas and SVG renderers must implement, enabling consistent rendering behavior across different output formats.

      CanvasRenderer
      CanvasRendererShape
      CanvasRendererStroke
      CanvasRendererText
      DefaultGuidesConfiguration
      DefaultIIRendererConfiguration
      DefaultRendererConfiguration
      GUIDE_PATH_ATTRS
      InteractiveInkSSRSVGRenderer
      ResizeDirection

      List all svg elements resize direction

      SELECTION_MARGIN
      SUB_GUIDE_PATH_ATTRS
      SvgElementRole

      List all svg elements roles

      SVGRenderer
      SVGRendererConst
      SVGStroker
      TBaseRendererConfiguration

      Base renderer configuration interface

      Common configuration properties required by all renderer implementations.

      TGuidesConfiguration
      TIIRendererConfiguration
      TRendererConfiguration
      InteractiveInkSSRSmartGuide
      DefaultPenStyle
      DefaultStyle
      DefaultTheme
      StyleHelper
      StyleManager
      TPenStyle
      TStyle
      TTheme
      TThemeMath
      TThemeMathSolved
      TThemeText
      BoxOps
      cloneSymbol

      Clone any TSymbol — all types are now plain objects, use structuredClone.

      computeClosedEdges
      computeEdgeBounds
      computeNormalizedAnchor
      computeTypesetSnapPoints
      computeTypesetVertices
      convertPartialStrokesToStrokes
      DecoratorKind
      DecoratorOps
      EdgeArcOps
      EdgeDecoration
      EdgeKind
      EdgeLineOps
      EdgeOps
      EdgePolyLineOps
      EraserOps
      extractStrokes

      Filter the stroke symbols out of a list that may contain other symbol types (text, math, shapes, ...).

      isDecorator

      Check if symbol is a standalone decorator

      isMath

      Check if symbol is math

      isRecognizedMath

      Check if symbol is a stroke with Math JIIX metadata

      isRecognizedText

      Check if symbol is a stroke with Text JIIX metadata

      isStroke

      Check if symbol is a stroke

      isStrokeSolverOutput

      Check if symbol is a stroke with Solver Output JIIX metadata

      isText

      Check if symbol is text

      isValidPoint
      MathOps
      OBBOps
      resolveAnchorPoint
      ShapeCircleOps
      ShapeEllipseOps
      ShapeKind
      ShapeOps
      ShapePolygonOps
      Stroke
      StrokeOps
      SymbolType
      TAnchor
      TBaseSymbol
      TBox
      TCanvasShapeEllipseSymbol
      TCanvasShapeLineSymbol
      TCanvasShapeTableLineSymbol
      TCanvasShapeTableSymbol
      TCanvasTextSymbol
      TCanvasTextUnderlineSymbol
      TCanvasUnderLineSymbol
      TDecorator
      TEdge
      TEdgeArc
      TEdgeLine
      TEdgePolyLine
      TEraser
      TextOps
      TLegacyStroke
      TMath
      TMathElement
      TOBB
      TPoint
      TPointer
      TRotation
      TSegment
      TShape
      TShapeCircle
      TShapeEllipse
      TShapePolygon
      TStroke
      TStrokeGroup
      TStrokeGroupToSend
      TStrokeMinimal
      TSymbol
      TSymbolChar
      TText
      TTypesetChild
      arrowHeadEndMarkerId
      arrowHeadStartMarkerId
      createSymbolFromPartial

      Create any TSymbol from partial data — dispatches by type using the registry for custom types.

      createSymbolsFromPartial

      Create multiple TSymbols from partial data — accumulates errors.

      DecoratorUtil
      EdgeUtil
      MathUtil
      registerBuiltinSymbolUtils
      ShapeUtil
      StrokeUtil
      SVGBuilder
      symbolRegistry
      SymbolRegistryClass

      Registry for SymbolUtil implementations.

      Built-in types are registered via registerBuiltinSymbolUtils(), which the canvas calls on initialisation. External consumers may register additional types before or after canvas creation:

      SymbolUtil

      Plugin interface for registering symbol behaviour.

      Implement this class to add a new symbol type that participates in the standard dispatch for factory, derived-field updates, overlap detection, snap-point extraction, and capability flags.

      Register with symbolRegistry.register(new MyUtil()).

      TextUtil
      areValidCoordinates
      assertServerConfig
      bumpSvgTransformVersion
      computeAngleAxeRadian
      computeAngleFromPointOnEllipse
      computeAngleRadian
      computeAverage
      computeDistance
      computeDistanceBetweenPointAndSegment
      computeDistanceSquared
      computeEllipseArcPoints
      computeEllipseRadiusAverage

      Compute approximate average radius of an ellipse

      computeHmac
      computeLinksPointers
      computeMiddlePointer
      computeNearestPointOnSegment
      computePointOnEllipse
      computeRotatedPoint
      convertBoundingBoxMillimeterToPixel
      convertDegreeToRadian
      convertMillimeterToPixel
      convertPixelToMillimeter
      convertRadianToDegree
      createPointsOnSegment
      createUUID
      DeferredPromise
      findIntersectBetweenSegmentAndCircle
      findIntersectionBetween2Segment
      getApiInfos
      getAvailableFontList
      getAvailableLanguageList
      getBoxConnectionPoint
      getClosestPoint
      getClosestPoints
      getMathDiagnosticMessage

      Get diagnostic message for a given diagnostic code

      getSvgTransformVersion
      isBetween
      isDeepEqual
      isDeepEqualIgnoring
      isPointInsideBox
      isPointInsidePolygon
      isValidNumber
      isVersionSuperiorOrEqual
      latexToUnicodeMath

      Convert a LaTeX math string into a flat UnicodeMath-compatible linear string

      MatrixTransform
      mergeDeep
      normalizeAngle
      roundTo

      Round a value to the nearest multiple of a step

      scalaire
      TApiInfos
      TMatrixTransform
      TPartialDeep