LiveCanvas class

Enables live and collaborative inking.

Constructors

LiveCanvas(IDataObjectProps<DataObjectTypes>)

Properties

allowedRoles	Gets the list of roles that are allowed to emit wet stroke events.
disposed
factory	The object's Fluid type factory.
handle	Handle to a data store
id
IFluidHandle
IFluidLoadable
IFluidRouter
initializeState	The initialization status of the data object.
isCursorShared	Gets the current cursor sharing status of this client.
isInitialized	Flag that indicates whether initialization has succeeded or not.
onCreateLiveCursor	Optional callback that allows the consuming application to provide its own live cursor visual representation by extending the abstract `LiveCursor` class. The callback is passed the user information retrieved via the `onGetLocalUserInfo` calback, if provided.
onGetLocalUserPictureUrl	Optional callback that allows the consuming application to provide a a profile picture that will be used on remote devices to render shared cursors.
TypeName	The object's Fluid type/name.

Inherited Properties

addListener
off
on
once
prependListener
prependOnceListener
removeListener

Methods

initialize(InkingManager, UserMeetingRole[])

Initializes the live inking session.

Inherited Methods

dispose()	Called when the host container closes and disposes itself
emit<E>(string \| symbol, any[])	Synchronously calls each of the listeners registered for the event named `eventName`, in the order they were registered, passing the supplied arguments to each. Returns `true` if the event had listeners, `false` otherwise. import { EventEmitter } from 'node:events'; const myEmitter = new EventEmitter(); // First listener myEmitter.on('event', function firstListener() { console.log('Helloooo! first listener'); }); // Second listener myEmitter.on('event', function secondListener(arg1, arg2) { console.log(`event with parameters ${arg1}, ${arg2} in second listener`); }); // Third listener myEmitter.on('event', function thirdListener(...args) { const parameters = args.join(', '); console.log(`event with parameters ${parameters} in third listener`); }); console.log(myEmitter.listeners('event')); myEmitter.emit('event', 1, 2, 3, 4, 5); // Prints: // [ // [Function: firstListener], // [Function: secondListener], // [Function: thirdListener] // ] // Helloooo! first listener // event with parameters 1, 2 in second listener // event with parameters 1, 2, 3, 4, 5 in third listener
eventNames()	Returns an array listing the events for which the emitter has registered listeners. `import { EventEmitter } from 'node:events'; const myEE = new EventEmitter(); myEE.on('foo', () => {}); myEE.on('bar', () => {}); const sym = Symbol('symbol'); myEE.on(sym, () => {}); console.log(myEE.eventNames()); // Prints: [ 'foo', 'bar', Symbol(symbol) ]`
finishInitialization(boolean)	Call this API to ensure PureDataObject is fully initialized. Initialization happens on demand, only on as-needed bases. In most cases you should allow factory/object to decide when to finish initialization. But if you are supplying your own implementation of DataStoreRuntime factory and overriding some methods and need a fully initialized object, then you can call this API to ensure object is fully initialized.
getClientInfo(string)	Get the client info for a given clientId
getDataObject(IFluidDataStoreRuntime)
getFluidObjectFromDirectory<T>(string, IDirectory, (id: string, directory: IDirectory) => undefined \| IFluidHandle<FluidObject<unknown> & IFluidLoadable>)	Retrieve Fluid object using the handle get
getMaxListeners()	Returns the current max listener value for the `EventEmitter` which is either set by `emitter.setMaxListeners(n)` or defaults to `events.defaultMaxListeners`.
initializeInternal(boolean)	Initializes internal objects and calls initialization overrides. Caller is responsible for ensuring this is only invoked once.
listenerCount<E>(string \| symbol, (args: any[]) => void)	Returns the number of listeners listening for the event named `eventName`. If `listener` is provided, it will return how many times the listener is found in the list of the listeners of the event.
listeners<E>(string \| symbol)	Returns a copy of the array of listeners for the event named `eventName`. `server.on('connection', (stream) => { console.log('someone connected!'); }); console.log(util.inspect(server.listeners('connection'))); // Prints: [ [Function] ]`
rawListeners<E>(string \| symbol)	Returns a copy of the array of listeners for the event named `eventName`, including any wrappers (such as those created by `.once()`). import { EventEmitter } from 'node:events'; const emitter = new EventEmitter(); emitter.once('log', () => console.log('log once')); // Returns a new Array with a function `onceWrapper` which has a property // `listener` which contains the original listener bound above const listeners = emitter.rawListeners('log'); const logFnWrapper = listeners[0]; // Logs "log once" to the console and does not unbind the `once` event logFnWrapper.listener(); // Logs "log once" to the console and removes the listener logFnWrapper(); emitter.on('log', () => console.log('log persistently')); // Will return a new Array with a single function bound by `.on()` above const newListeners = emitter.rawListeners('log'); // Logs "log persistently" twice newListeners[0](); emitter.emit('log');
removeAllListeners<E>(string \| symbol)	Removes all listeners, or those of the specified `eventName`. It is bad practice to remove listeners added elsewhere in the code, particularly when the `EventEmitter` instance was created by some other component or module (e.g. sockets or file streams). Returns a reference to the `EventEmitter`, so that calls can be chained.
request(IRequest)	{@inheritDoc PureDataObject.request}
setMaxListeners(number)	By default `EventEmitter`s will print a warning if more than `10` listeners are added for a particular event. This is a useful default that helps finding memory leaks. The `emitter.setMaxListeners()` method allows the limit to be modified for this specific `EventEmitter` instance. The value can be set to `Infinity` (or `0`) to indicate an unlimited number of listeners. Returns a reference to the `EventEmitter`, so that calls can be chained.
[captureRejectionSymbol](Error, string \| symbol, any[])	The `Symbol.for('nodejs.rejection')` method is called in case a promise rejection happens when emitting an event and `captureRejections` is enabled on the emitter. It is possible to use `events.captureRejectionSymbol` in place of `Symbol.for('nodejs.rejection')`. `import { EventEmitter, captureRejectionSymbol } from 'node:events'; class MyClass extends EventEmitter { constructor() { super({ captureRejections: true }); } [captureRejectionSymbol](err, event, ...args) { console.log('rejection happened for', event, 'with', err, ...args); this.destroy(err); } destroy(err) { // Tear the resource down here. } }`

new LiveCanvas(props: IDataObjectProps<DataObjectTypes>)

Parameters

props: IDataObjectProps<DataObjectTypes>

Gets the list of roles that are allowed to emit wet stroke events.

UserMeetingRole[] allowedRoles

Property Value

UserMeetingRole[]

boolean disposed

Property Value

boolean

The object's Fluid type factory.

static factory: DataObjectFactory<LiveCanvas, DataObjectTypes>

Property Value

DataObjectFactory<LiveCanvas, DataObjectTypes>

Handle to a data store

IFluidHandle<this> handle

Property Value

IFluidHandle<this>

string id

Property Value

string

IFluidHandle<this> IFluidHandle

Property Value

IFluidHandle<this>

this IFluidLoadable

Property Value

this

this IFluidRouter

Property Value

this

The initialization status of the data object.

LiveDataObjectInitializeState initializeState

Property Value

LiveDataObjectInitializeState

Gets the current cursor sharing status of this client.

boolean isCursorShared

Property Value

boolean

Flag that indicates whether initialization has succeeded or not.

boolean isInitialized

Property Value

boolean

Optional callback that allows the consuming application to provide its own live cursor visual representation by extending the abstract LiveCursor class. The callback is passed the user information retrieved via the onGetLocalUserInfo calback, if provided.

onCreateLiveCursor?: (clientId: string, userInfo?: IUserInfo) => LiveCursor

Property Value

(clientId: string, userInfo?: IUserInfo) => LiveCursor

Optional callback that allows the consuming application to provide a a profile picture that will be used on remote devices to render shared cursors.

onGetLocalUserPictureUrl?: () => undefined | string

Property Value

() => undefined | string

The object's Fluid type/name.

static TypeName: "@microsoft/shared-inking-session" = "@microsoft/shared-inking-session"