Interface ComponentBuilder

interface ComponentBuilder {
    autocorrectShape?: (() => Promise<null | AbstractComponent>);
    addPoint(point): void;
    build(): AbstractComponent;
    getBBox(): Rect2;
    preview(renderer): void;
}

Index

Properties

autocorrectShape?

Methods

addPoint build getBBox preview

Properties

`Optional` autocorrectShape

autocorrectShape?: (() => Promise<null | AbstractComponent>)

Called when the pen is stationary (or the user otherwise activates autocomplete). This might attempt to fit the user's drawing to a particular shape.

The shape returned by this function may be ignored if it has an empty bounding box.

Although this returns a Promise, it should return as fast as possible.

Type declaration

- (): Promise<null | AbstractComponent>
- Called when the pen is stationary (or the user otherwise activates autocomplete). This might attempt to fit the user's drawing to a particular shape.
  
  The shape returned by this function may be ignored if it has an empty bounding box.
  
  Although this returns a Promise, it should return as fast as possible.
  
  Returns Promise<null | AbstractComponent>

Methods

addPoint

addPoint(point): void
Parameters
- point: StrokeDataPoint
Returns void
- Defined in components/builders/types.ts:25

build

build(): AbstractComponent
Returns AbstractComponent
- Defined in components/builders/types.ts:9

getBBox

getBBox(): Rect2
Returns Rect2
- Defined in components/builders/types.ts:8

preview

preview(renderer): void
Parameters
- renderer: AbstractRenderer
Returns void
- Defined in components/builders/types.ts:10

Generated using TypeDoc

OpenSource licenses