IAddRemoveStrokeOptions interface

Package:

@microsoft/live-share-canvas

Defines options used by InkingManager.addStroke and InkingManager.removeStroke.

Properties

addToChangeLog	Optional. Indicates whether the add or remove operation should be added to the change log, which in turn will lead to StrokeAddedEvent or StrokeRemovedEvent begin emitted. Defaults to true.
forceReRender	Optional. Indicates if the canvas must be fully re-rendered at once after the stroke has been added or removed. Defaults to false.

Property Details

addToChangeLog

Optional. Indicates whether the add or remove operation should be added to the change log, which in turn will lead to StrokeAddedEvent or StrokeRemovedEvent begin emitted. Defaults to true.

addToChangeLog?: boolean

Property Value

boolean

forceReRender

Optional. Indicates if the canvas must be fully re-rendered at once after the stroke has been added or removed. Defaults to false.

forceReRender?: boolean

Property Value

boolean