Class Pattern

constructor

• new Pattern(options?): Pattern

• Constructor

  Parameters

  • Optional options: Partial<Pick<Pattern, ExportedKeys>> = {}

    Options object

  Returns Pattern

crossOrigin

Copy

Optional excludeFromExport

Readonly id

offsetX

Copy

offsetY

Copy

patternTransform

Copy

repeat

source

Static type

type

• get type(): string

• Legacy identifier of the class. Prefer using this.constructor.type 'Pattern' or utils like isPattern, or instance of to indentify a pattern in your code. Will be removed in future versiones

  Returns string

  TODO

  add sustainable warning message

  Deprecated

• set type(value): void

• Parameters

  • value: string

  Returns void

isCanvasSource

• isCanvasSource(): this is {
      source: HTMLCanvasElement;
  }

• Returns this is {
      source: HTMLCanvasElement;
  }

  true if source is a element

isImageSource

• isImageSource(): this is {
      source: HTMLImageElement;
  }

• Returns this is {
      source: HTMLImageElement;
  }

  true if source is an element

sourceToString

• sourceToString(): string

• Returns string

toLive

• toLive(ctx): null | CanvasPattern

• Returns an instance of CanvasPattern

  Parameters

  • ctx: CanvasRenderingContext2D

    Context to create pattern

  Returns null | CanvasPattern

toObject

• toObject(propertiesToInclude?): Record<string, any>

• Returns object representation of a pattern

  Parameters

  • Optional propertiesToInclude: string[] = []

    Any properties that you might want to additionally include in the output

  Returns Record<string, any>

  Object representation of a pattern instance

toSVG

• toSVG(__namedParameters): string

• Returns SVG representation of a pattern

  Parameters

  • __namedParameters: TSize

  Returns string

Static fromObject

• fromObject(__namedParameters, options): Promise<Pattern>

• Parameters

  • __namedParameters: SerializedPatternOptions

  • options: Abortable

  Returns Promise<Pattern>