@univerjs/engine-render v0.4.2 • Docs

Class: Transform

Constructors

new Transform()

new Transform(m): Transform

Parameters

Parameter	Type	Default value
`m`	`number`[]	`INITIAL_MATRIX`

Returns

Transform

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:30 (opens in a new tab)

Properties

Property	Type	Default value	Defined in
`dirty`	`boolean`	`false`	submodules/univer/packages/engine-render/src/basics/transform.ts:26 (opens in a new tab)

Methods

applyPoint()

applyPoint(point, ignoreOffset): Vector2

Transform point

Parameters

Parameter	Type	Default value	Description
`point`	`Vector2`	`undefined`	2D point(x, y)
`ignoreOffset`	`boolean`	`false`	-

Returns

Vector2

2D point(x, y)

Method

Name

universheet.Transform#point

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:75 (opens in a new tab)

clone()

clone(): Transform

Returns

Transform

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:354 (opens in a new tab)

composeMatrix()

composeMatrix(options): Transform

Parameters

Parameter	Type
`options`	`ITransformState`

Returns

Transform

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:335 (opens in a new tab)

convert2DOMMatrix2D()

convert2DOMMatrix2D(): {
  a: number;
  b: number;
  c: number;
  d: number;
  e: number;
  f: number;
}

Returns

{
  a: number;
  b: number;
  c: number;
  d: number;
  e: number;
  f: number;
}

Name	Type	Defined in
`a`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:396 (opens in a new tab)
`b`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:397 (opens in a new tab)
`c`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:398 (opens in a new tab)
`d`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:399 (opens in a new tab)
`e`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:400 (opens in a new tab)
`f`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:401 (opens in a new tab)

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:393 (opens in a new tab)

copy()

copy(): Transform

Copy universheet.Transform object

Returns

Transform

Method

Name

universheet.Transform#copy

Example

const tr = shape.getTransform().copy()

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:55 (opens in a new tab)

copyInto()

copyInto(tr): void

Parameters

Parameter	Type
`tr`	`Transform`

Returns

void

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:59 (opens in a new tab)

decompose()

decompose(): {
  angle: 0;
  scaleX: 0;
  scaleY: 0;
  skewX: 0;
  skewY: 0;
  x: e;
  y: f;
}

convert transformation matrix back into node's attributes

Returns

{
  angle: 0;
  scaleX: 0;
  scaleY: 0;
  skewX: 0;
  skewY: 0;
  x: e;
  y: f;
}

Name	Type	Default value	Defined in
`angle`	`number`	0	submodules/univer/packages/engine-render/src/basics/transform.ts:279 (opens in a new tab)
`scaleX`	`number`	0	submodules/univer/packages/engine-render/src/basics/transform.ts:280 (opens in a new tab)
`scaleY`	`number`	0	submodules/univer/packages/engine-render/src/basics/transform.ts:281 (opens in a new tab)
`skewX`	`number`	0	submodules/univer/packages/engine-render/src/basics/transform.ts:282 (opens in a new tab)
`skewY`	`number`	0	submodules/univer/packages/engine-render/src/basics/transform.ts:283 (opens in a new tab)
`x`	`number`	e	submodules/univer/packages/engine-render/src/basics/transform.ts:277 (opens in a new tab)
`y`	`number`	f	submodules/univer/packages/engine-render/src/basics/transform.ts:278 (opens in a new tab)

Method

Name

universheet.Transform#decompose

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:266 (opens in a new tab)

getMatrix()

getMatrix(): number[]

return matrix

Returns

number[]

Method

Name

universheet.Transform#getMatrix

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:228 (opens in a new tab)

getMatrixByAccurate()

getMatrixByAccurate(accurate): number[]

return matrix

Parameters

Parameter	Type	Default value
`accurate`	`number`	`3`

Returns

number[]

Method

Name

universheet.Transform#getMatrix

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:237 (opens in a new tab)

getTranslation()

getTranslation(): {
  x: number;
  y: number;
}

Returns the translation

Returns

{
  x: number;
  y: number;
}

2D point(x, y)

Name	Type	Defined in
`x`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:149 (opens in a new tab)
`y`	`number`	submodules/univer/packages/engine-render/src/basics/transform.ts:150 (opens in a new tab)

Method

Name

universheet.Transform#getTranslation

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:147 (opens in a new tab)

invert()

invert(): Transform

Invert the matrix

Returns

Transform

Method

Name

universheet.Transform#invert

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:206 (opens in a new tab)

makeBoundingBoxFromPoints()

makeBoundingBoxFromPoints(points): IRect

Parameters

Parameter	Type
`points`	`Vector2`[]

Returns

IRect

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:310 (opens in a new tab)

multiply()

multiply(matrix): Transform

Transform multiplication

Parameters

Parameter	Type
`matrix`	`Transform`

Returns

Transform

Method

Name

universheet.Transform#multiply

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:181 (opens in a new tab)

reset()

reset(): void

Returns

void

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:38 (opens in a new tab)

rotate()

rotate(deg): Transform

Apply rotation

Parameters

Parameter	Type
`deg`	`number`

Returns

Transform

Method

Name

universheet.Transform#rotate

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:126 (opens in a new tab)

scale()

scale(sx, sy): Transform

Apply scale

Parameters

Parameter	Type
`sx`	`number`
`sy`	`number`

Returns

Transform

Method

Name

universheet.Transform#scale

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:109 (opens in a new tab)

setAbsolutePosition()

setAbsolutePosition(coord): Transform

set to absolute position via translation

Parameters

Parameter	Type
`coord`	`Vector2`

Returns

Transform

Method

Name

universheet.Transform#setAbsolutePosition

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:247 (opens in a new tab)

skew()

skew(sx, sy): Transform

Apply skew

Parameters

Parameter	Type
`sx`	`number`
`sy`	`number`

Returns

Transform

Method

Name

universheet.Transform#skew

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:162 (opens in a new tab)

translate()

translate(x, y): Transform

Apply translation

Parameters

Parameter	Type
`x`	`number`
`y`	`number`

Returns

Transform

Method

Name

universheet.Transform#translate

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:95 (opens in a new tab)

create()

static create(m): Transform

Parameters

Parameter	Type	Default value
`m`	`number`[]	`INITIAL_MATRIX`

Returns

Transform

Defined in

submodules/univer/packages/engine-render/src/basics/transform.ts:34 (opens in a new tab)

Thinscene Univerprintingcontext