Pattern
Defined in: src/Pattern/Pattern.ts:21
Constructors
Section titled “Constructors”Constructor
Section titled “Constructor”new Pattern(
options?):Pattern
Defined in: src/Pattern/Pattern.ts:92
Constructor
Parameters
Section titled “Parameters”options?
Section titled “options?”Options object
Returns
Section titled “Returns”Pattern
Properties
Section titled “Properties”crossOrigin
Section titled “crossOrigin”crossOrigin:
TCrossOrigin=''
Defined in: src/Pattern/Pattern.ts:61
excludeFromExport?
Section titled “excludeFromExport?”
optionalexcludeFromExport:boolean
Defined in: src/Pattern/Pattern.ts:79
If true, this object will not be exported during the serialization of a canvas
readonlyid:number
Defined in: src/Pattern/Pattern.ts:85
ID used for SVG export functionalities
offsetX
Section titled “offsetX”offsetX:
number=0
Defined in: src/Pattern/Pattern.ts:50
Pattern horizontal offset from object’s left/top corner
offsetY
Section titled “offsetY”offsetY:
number=0
Defined in: src/Pattern/Pattern.ts:56
Pattern vertical offset from object’s left/top corner
patternTransform?
Section titled “patternTransform?”
optionalpatternTransform:TMat2D
Defined in: src/Pattern/Pattern.ts:68
transform matrix to change the pattern, imported from svgs.
verify if using the identity matrix as default makes the rest of the code more easy
repeat
Section titled “repeat”repeat:
PatternRepeat='repeat'
Defined in: src/Pattern/Pattern.ts:44
Defaults
Section titled “Defaults”source
Section titled “source”source:
CanvasImageSource
Defined in: src/Pattern/Pattern.ts:73
The actual pixel source of the pattern
statictype:string='Pattern'
Defined in: src/Pattern/Pattern.ts:22
Accessors
Section titled “Accessors”Get Signature
Section titled “Get Signature”get type():
string
Defined in: src/Pattern/Pattern.ts:32
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
add sustainable warning message
Returns
Section titled “Returns”string
Set Signature
Section titled “Set Signature”set type(
value):void
Defined in: src/Pattern/Pattern.ts:36
Parameters
Section titled “Parameters”string
Returns
Section titled “Returns”void
Methods
Section titled “Methods”isCanvasSource()
Section titled “isCanvasSource()”isCanvasSource():
this is { source: HTMLCanvasElement }
Defined in: src/Pattern/Pattern.ts:109
Returns
Section titled “Returns”this is { source: HTMLCanvasElement }
true if source is a
isImageSource()
Section titled “isImageSource()”isImageSource():
this is { source: HTMLImageElement }
Defined in: src/Pattern/Pattern.ts:100
Returns
Section titled “Returns”this is { source: HTMLImageElement }
true if source is an element
sourceToString()
Section titled “sourceToString()”sourceToString():
string
Defined in: src/Pattern/Pattern.ts:113
Returns
Section titled “Returns”string
toLive()
Section titled “toLive()”toLive(
ctx):null|CanvasPattern
Defined in: src/Pattern/Pattern.ts:126
Returns an instance of CanvasPattern
Parameters
Section titled “Parameters”CanvasRenderingContext2D
Context to create pattern
Returns
Section titled “Returns”null | CanvasPattern
toObject()
Section titled “toObject()”toObject(
propertiesToInclude?):Record<string,any>
Defined in: src/Pattern/Pattern.ts:147
Returns object representation of a pattern
Parameters
Section titled “Parameters”propertiesToInclude?
Section titled “propertiesToInclude?”string[] = []
Any properties that you might want to additionally include in the output
Returns
Section titled “Returns”Record<string, any>
Object representation of a pattern instance
toSVG()
Section titled “toSVG()”toSVG(
__namedParameters):string
Defined in: src/Pattern/Pattern.ts:167
Returns SVG representation of a pattern
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”Returns
Section titled “Returns”string
fromObject()
Section titled “fromObject()”
staticfromObject(__namedParameters,options?):Promise<Pattern>
Defined in: src/Pattern/Pattern.ts:193
Parameters
Section titled “Parameters”__namedParameters
Section titled “__namedParameters”options?
Section titled “options?”Returns
Section titled “Returns”Promise<Pattern>