Class: ExclusiveRangeService

Extends

Disposable

Implements

IExclusiveRangeService

Constructors

new ExclusiveRangeService()

new ExclusiveRangeService(): ExclusiveRangeService

Returns

ExclusiveRangeService

Inherited from

Disposable.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`_disposed`	`protected`	`boolean`	`false`	`Disposable`.`_disposed`	packages/core/src/shared/lifecycle.ts:93 (opens in a new tab)

Methods

addExclusiveRange()

addExclusiveRange(
   unitId, 
   sheetId, 
   feature, 
   ranges): void

Parameters

Parameter	Type	Description
`unitId`	`string`	The unitId of the exclusive range
`sheetId`	`string`	The sheetId of the exclusive range
`feature`	`string`	The feature of the exclusive range
`ranges`	`IFeatureRange`[]	-

Returns

void

Description

Add an exclusive range to the service

Implementation of

IExclusiveRangeService.addExclusiveRange

Defined in

packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:96 (opens in a new tab)

clearExclusiveRanges()

clearExclusiveRanges(
   unitId, 
   sheetId, 
   feature): void

Parameters

Parameter	Type	Description
`unitId`	`string`	The unitId of the exclusive range
`sheetId`	`string`	The sheetId of the exclusive range
`feature`	`string`	The feature of the exclusive range

Returns

void

Description

Clear the exclusive ranges

Implementation of

IExclusiveRangeService.clearExclusiveRanges

Defined in

packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:105 (opens in a new tab)

clearExclusiveRangesByGroupId()

clearExclusiveRangesByGroupId(
   unitId, 
   sheetId, 
   feature, 
   groupId): void

Parameters

Parameter	Type	Description
`unitId`	`string`	The unitId of the exclusive range
`sheetId`	`string`	The sheetId of the exclusive range
`feature`	`string`	The feature of the exclusive range
`groupId`	`string`	The groupId of the exclusive range

Returns

void

Description

Clear the exclusive ranges by groupId

Implementation of

IExclusiveRangeService.clearExclusiveRangesByGroupId

Defined in

packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:110 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Inherited from

Disposable.dispose

Defined in

packages/core/src/shared/lifecycle.ts:106 (opens in a new tab)

disposeWithMe()

disposeWithMe(disposable): IDisposable

Parameters

Parameter	Type
`disposable`	`DisposableLike`

ensureNotDisposed()

protected ensureNotDisposed(): void

Returns

void

Inherited from

Disposable.ensureNotDisposed

Defined in

packages/core/src/shared/lifecycle.ts:100 (opens in a new tab)

getExclusiveRanges()

getExclusiveRanges(
   unitId, 
   sheetId, 
   feature): undefined | IFeatureRange[]

Parameters

Parameter	Type	Description
`unitId`	`string`	The unitId of the exclusive range
`sheetId`	`string`	The sheetId of the exclusive range
`feature`	`string`	The feature of the exclusive range

Returns

undefined | IFeatureRange[]

The exclusive ranges

Description

Get the exclusive ranges

Implementation of

IExclusiveRangeService.getExclusiveRanges

Defined in

packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:101 (opens in a new tab)

getInterestGroupId()

getInterestGroupId(selections): string[]

Check the interest group id of the giving selection

Parameters

Parameter	Type	Description
`selections`	`ISelectionWithStyle`[]	The selections to check

Returns

string[]

Implementation of

IExclusiveRangeService.getInterestGroupId

Defined in

packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:118 (opens in a new tab)

Definednamedatacontroller Mergecellcontroller