Interface DrawBlockOptions

Options for drawBlock

interface DrawBlockOptions {
    alignment?: Placement2D;
    containerSize?: Partial<Size2D>;
    drawFn?: ((text, x, y, maxWidth?) => void);
    origin?: Placement2D;
    textAlignment?: Placement1D;
}

Hierarchy (view full)

Properties

alignment? containerSize? drawFn? origin? textAlignment?

Properties

Optional alignment

alignment?: Placement2D

How to fit the content to be drawn inside its container

Default

Placement2D.TopLeft

Optional containerSize

containerSize?: Partial<Size2D>

The size of the container where the content will be drawn

Default

{width: 0, height: 0}

Optional drawFn

drawFn?: ((text, x, y, maxWidth?) => void)

Function called to draw the text on the canvas.

By default, it is ctx.fillText.

Provided in case you want to, for example, draw an outline in a bigger font for each line.

Type declaration

    • (text, x, y, maxWidth?): void

    • Function called to draw the text on the canvas.

      By default, it is ctx.fillText.

      Provided in case you want to, for example, draw an outline in a bigger font for each line.

      Parameters

      • text: string
      • x: number
      • y: number
      • Optional maxWidth: number

      Returns void

Optional origin

origin?: Placement2D

Set the origin of the content inside its container

Default

Placement2D.TopLeft

Optional textAlignment

textAlignment?: Placement1D

Alignment of the text within the block

Default

Placement1D.Left

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc