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

    Class IISynchronizerManager

    Simplified synchronizer that only manages JIIX block IDs and stroke lifecycle

    Hierarchy (View Summary)

    Index
    constructor
    canvas logger managerName MAX_RETRY_ATTEMPTS SYNC_YIELD_CHUNK_SIZE SYNCHRONIZE_TIMEOUT
    client configuration model renderer
    destroy onDestroy? onInit? synchronize
    canvas: TInteractiveInkCanvas

    The Interactive Ink Canvas instance

    logger: Logger

    Logger instance for this manager Automatically uses LoggerCategory.MANAGER

    managerName: string = "IISynchronizerManager"

    Name of the manager for logging purposes Must be overridden in concrete classes

    "IITypesetManager", "IIMathManager"
    MAX_RETRY_ATTEMPTS: 3
    SYNC_YIELD_CHUNK_SIZE: 50

    Elements processed between yields in #doSynchronize's loop, so a large document doesn't block the main thread (and pending pointer input) in one go.

    SYNCHRONIZE_TIMEOUT: 30000
    • get client(): WebSocketClient

      Get the client from the canvas Convenience getter to avoid accessing canvas.client everywhere

      Returns WebSocketClient

    • get model(): IIModel

      Get the model from the canvas Convenience getter to avoid accessing canvas.model everywhere

      Returns IIModel

    • get renderer(): SVGRenderer

      Get the renderer from the canvas Convenience getter to avoid accessing canvas.renderer everywhere

      Returns SVGRenderer

    • Destroy the manager and cleanup resources Calls the onDestroy hook if defined

      Returns void

    • Lifecycle hook called when the manager is being destroyed Override in subclasses to cleanup resources

      Returns void

      protected onDestroy(): void {
        this.logger.info(`${this.managerName} destroyed`)
        // Remove event listeners, clear intervals, etc.
      }

    • Lifecycle hook called after manager initialization Override in subclasses if needed

      This is called at the end of the constructor, allowing subclasses to perform initialization that requires access to this.managerName or other properties set in the subclass constructor.

      Returns void

      protected onInit(): void {
        this.logger.info(`${this.managerName} initialized`)
        // Setup event listeners, etc.
      }

    • Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Constructors
    Properties
    Accessors
    Methods