Interface: IPaintImageModule

Table of contents

Methods

• image
• film
• video
• checkImage
• drawImage
• getImageRenderScaleData
• recycleImage
• createPatternTask
• createPattern
• getPatternFixScale
• createData
• getPatternData
• applyFilter
• recycleFilter
• stretchMode
• fillOrFitMode
• clipMode
• repeatMode

Methods

image

▸ image(ui, attrName, paint, boxBounds, firstUse): ILeafPaint

Parameters

Name	Type
ui	IUI
attrName	string
paint	IImagePaint
boxBounds	IBoundsData
firstUse	boolean

Returns

ILeafPaint

Defined in

src/ui/packages/interface/src/module/IPaint.ts:31

---

film

▸ film(paint): void

Parameters

Name	Type
paint	ILeafPaint

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:33

---

video

▸ video(paint): void

Parameters

Name	Type
paint	ILeafPaint

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:34

---

checkImage

▸ checkImage(paint, allowDraw, ui, canvas, renderOptions): boolean

Parameters

Name	Type
paint	ILeafPaint
allowDraw	boolean
ui	IUI
canvas	ILeaferCanvas
renderOptions	IRenderOptions

Returns

boolean

Defined in

src/ui/packages/interface/src/module/IPaint.ts:36

---

drawImage

▸ drawImage(paint, imageScaleX, imageScaleY, ui, canvas, renderOptions): void

Parameters

Name	Type
paint	ILeafPaint
imageScaleX	number
imageScaleY	number
ui	IUI
canvas	ILeaferCanvas
renderOptions	IRenderOptions

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:37

---

getImageRenderScaleData

▸ getImageRenderScaleData(paint, ui, canvas?, renderOptions?): IScaleData

Parameters

Name	Type
paint	ILeafPaint
ui	IUI
canvas?	ILeaferCanvas
renderOptions?	IRenderOptions

Returns

IScaleData

Defined in

src/ui/packages/interface/src/module/IPaint.ts:38

---

recycleImage

▸ recycleImage(attrName, data): IBooleanMap

Parameters

Name	Type
attrName	IPaintAttr
data	IUIData

Returns

IBooleanMap

Defined in

src/ui/packages/interface/src/module/IPaint.ts:39

---

createPatternTask

▸ createPatternTask(paint, ui, canvas, renderOptions): void

Parameters

Name	Type
paint	ILeafPaint
ui	IUI
canvas	ILeaferCanvas
renderOptions	IRenderOptions

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:41

---

createPattern

▸ createPattern(paint, ui, canvas, renderOptions, resolve?, task?): void

Parameters

Name	Type
paint	ILeafPaint
ui	IUI
canvas	ILeaferCanvas
renderOptions	IRenderOptions
resolve?	IFunction
task?	ITaskItem

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:42

---

getPatternFixScale

▸ getPatternFixScale(paint, imageScaleX, imageScaleY): number

Parameters

Name	Type
paint	ILeafPaint
imageScaleX	number
imageScaleY	number

Returns

number

Defined in

src/ui/packages/interface/src/module/IPaint.ts:43

---

createData

▸ createData(leafPaint, image, paint, box): void

Parameters

Name	Type
leafPaint	ILeafPaint
image	ILeaferImage
paint	IImagePaint
box	IBoundsData

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:45

---

getPatternData

▸ getPatternData(paint, box, image): ILeafPaintPatternData

Parameters

Name	Type
paint	IImagePaint
box	IBoundsData
image	ILeaferImage

Returns

ILeafPaintPatternData

Defined in

src/ui/packages/interface/src/module/IPaint.ts:46

---

applyFilter

▸ applyFilter(leafPaint, image, filter, ui): void

Parameters

Name	Type
leafPaint	ILeafPaint
image	ILeaferImage
filter	IImageFilters
ui	IUI

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:49

---

recycleFilter

▸ recycleFilter(image, ui): void

Parameters

Name	Type
image	ILeaferImage
ui	IUI

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:50

---

stretchMode

▸ stretchMode(data, box, scaleX, scaleY): void

Parameters

Name	Type
data	ILeafPaintPatternData
box	IBoundsData
scaleX	number
scaleY	number

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:52

---

fillOrFitMode

▸ fillOrFitMode(data, box, x, y, scaleX, scaleY, rotation): void

Parameters

Name	Type
data	ILeafPaintPatternData
box	IBoundsData
x	number
y	number
scaleX	number
scaleY	number
rotation	number

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:53

---

clipMode

▸ clipMode(data, box, x, y, scaleX, scaleY, rotation, skew, clipScaleX?, clipScaleY?): void

Parameters

Name	Type
data	ILeafPaintPatternData
box	IBoundsData
x	number
y	number
scaleX	number
scaleY	number
rotation	number
skew	IPointData
clipScaleX?	number
clipScaleY?	number

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:54

---

repeatMode

▸ repeatMode(data, box, width, height, x, y, scaleX, scaleY, rotation, skew, align, freeTransform?): void

Parameters

Name	Type
data	ILeafPaintPatternData
box	IBoundsData
width	number
height	number
x	number
y	number
scaleX	number
scaleY	number
rotation	number
skew	IPointData
align	IDirection
freeTransform?	boolean

Returns

void

Defined in

src/ui/packages/interface/src/module/IPaint.ts:55