InputFilterCollection class

Package:

@microsoft/live-share-canvas

Represents a collection of input filters.

Constructors

InputFilterCollection(InputFilter[])

Creates a new InputFilterCollection instance.

Methods

addFilters(InputFilter[])	Adds filters to the collection.
filterPoint(IPointerPoint)	Filters (transforms) the specified point through each of the individual filters in the collection.
reset(IPointerPoint)	Resets all the filters in the collection. Some filters use information about previous points to transform the next point. reset will be called automatically by InkingManager when a new wet stroke begins.

Constructor Details

InputFilterCollection(InputFilter[])

Creates a new InputFilterCollection instance.

new InputFilterCollection(items: InputFilter[])

Parameters

items

InputFilter[]

The initial inputs filters.

Method Details

addFilters(InputFilter[])

Adds filters to the collection.

function addFilters(items: InputFilter[])

Parameters

items

InputFilter[]

The filters to add.

filterPoint(IPointerPoint)

Filters (transforms) the specified point through each of the individual filters in the collection.

function filterPoint(p: IPointerPoint): IPointerPoint

Parameters

p

IPointerPoint

The point to transform.

Returns

IPointerPoint

The transformed point.

reset(IPointerPoint)

Resets all the filters in the collection. Some filters use information about previous points to transform the next point. reset will be called automatically by InkingManager when a new wet stroke begins.

function reset(startPoint: IPointerPoint)

Parameters

startPoint

IPointerPoint

The new starting point.