API Reference
@univerjs
@univerjs/core
classes
Rectangle

@univerjs/core v0.1.17Docs


Class: Rectangle

This class provides a set of methods to calculate IRange.

Constructors

new Rectangle()

new Rectangle(): Rectangle

Returns

Rectangle

Methods

clone()

static clone(src): IRange

Parameters

ParameterType
srcIRange

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:25 (opens in a new tab)


contains()

static contains(src, target): boolean

Parameters

ParameterType
srcIRange
targetIRange

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:172 (opens in a new tab)


equals()

static equals(src, target): boolean

Parameters

ParameterType
srcIRange
targetIRange

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:44 (opens in a new tab)


getIntersectionBetweenTwoRect()

static getIntersectionBetweenTwoRect(rect1, rect2): null | Required<IRectLTRB>

Parameters

ParameterType
rect1IRectLTRB
rect2IRectLTRB

Returns

null | Required<IRectLTRB>

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:330 (opens in a new tab)


getIntersects()

static getIntersects(src, target): Nullable<IRange>

Parameters

ParameterType
srcIRange
targetIRange

Returns

Nullable<IRange>

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:95 (opens in a new tab)


getPositionRange()

static getPositionRange(
   relativeRange, 
   originRange, 
   absoluteRange?): IRange

Parameters

ParameterType
relativeRangeIRange
originRangeIRange
absoluteRange?IRange

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:226 (opens in a new tab)


getRelativeRange()

static getRelativeRange(range, originRange): IRange

Parameters

ParameterType
rangeIRange
originRangeIRange

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:218 (opens in a new tab)


hasIntersectionBetweenTwoRect()

static hasIntersectionBetweenTwoRect(rect1, rect2): boolean

Parameters

ParameterType
rect1IRectLTRB
rect2IRectLTRB

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:317 (opens in a new tab)


intersects()

static intersects(src, target): boolean

Parameters

ParameterType
srcIRange
targetIRange

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:59 (opens in a new tab)


moveHorizontal()

static moveHorizontal(
   range, 
   step, 
   length): IRange

Parameters

ParameterTypeDefault value
rangeIRangeundefined
stepnumber0
lengthnumber0

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:236 (opens in a new tab)


moveOffset()

static moveOffset(
   range, 
   offsetX, 
   offsetY): IRange

Parameters

ParameterType
rangeIRange
offsetXnumber
offsetYnumber

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:248 (opens in a new tab)


moveVertical()

static moveVertical(
   range, 
   step, 
   length): IRange

Parameters

ParameterTypeDefault value
rangeIRangeundefined
stepnumber0
lengthnumber0

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:242 (opens in a new tab)


realContain()

static realContain(src, target): boolean

Parameters

ParameterType
srcIRange
targetIRange

Returns

boolean

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:181 (opens in a new tab)


realUnion()

static realUnion(...ranges): IRange

Parameters

ParameterType
...rangesIRange[]

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:205 (opens in a new tab)


subtract()

static subtract(range1, range2): IRange[]

Parameters

ParameterType
range1IRange
range2IRange

Returns

IRange[]

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:256 (opens in a new tab)


union()

static union(...ranges): IRange

Parameters

ParameterType
...rangesIRange[]

Returns

IRange

Defined in

submodules/univer/packages/core/src/shared/rectangle.ts:191 (opens in a new tab)


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.