@univerjssheetsindexclassesExclusiverangeservice

@univerjs/sheets v0.5.4


Class: ExclusiveRangeService

Defined in: submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:71

Extends

Implements

Constructors

new ExclusiveRangeService()

new ExclusiveRangeService(): ExclusiveRangeService

Returns

ExclusiveRangeService

Inherited from

Disposable.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
_disposedprotectedbooleanfalseDisposable._disposedsubmodules/univer/packages/core/src/shared/lifecycle.ts:96
exclusiveRangesChange$publicObservable<{ ranges: IRange[]; subUnitId: string; unitId: string; }>undefined-submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:78

Methods

addExclusiveRange()

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

Defined in: submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:103

Parameters

ParameterTypeDescription
unitIdstringThe unitId of the exclusive range
sheetIdstringThe sheetId of the exclusive range
featurestringThe feature of the exclusive range
rangesIFeatureRange[]-

Returns

void

Description

Add an exclusive range to the service

Implementation of

IExclusiveRangeService.addExclusiveRange


clearExclusiveRanges()

clearExclusiveRanges(
   unitId, 
   sheetId, 
   feature): void

Defined in: submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:113

Parameters

ParameterTypeDescription
unitIdstringThe unitId of the exclusive range
sheetIdstringThe sheetId of the exclusive range
featurestringThe feature of the exclusive range

Returns

void

Description

Clear the exclusive ranges

Implementation of

IExclusiveRangeService.clearExclusiveRanges


clearExclusiveRangesByGroupId()

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

Defined in: submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:121

Parameters

ParameterTypeDescription
unitIdstringThe unitId of the exclusive range
sheetIdstringThe sheetId of the exclusive range
featurestringThe feature of the exclusive range
groupIdstringThe groupId of the exclusive range

Returns

void

Description

Clear the exclusive ranges by groupId

Implementation of

IExclusiveRangeService.clearExclusiveRangesByGroupId


dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

Disposable.dispose


disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

ParameterType
disposableDisposableLike

Returns

IDisposable

Inherited from

Disposable.disposeWithMe


ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

Disposable.ensureNotDisposed


getExclusiveRanges()

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

Defined in: submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:109

Parameters

ParameterTypeDescription
unitIdstringThe unitId of the exclusive range
sheetIdstringThe sheetId of the exclusive range
featurestringThe feature of the exclusive range

Returns

undefined | IFeatureRange[]

The exclusive ranges

Description

Get the exclusive ranges

Implementation of

IExclusiveRangeService.getExclusiveRanges


getInterestGroupId()

getInterestGroupId(selections): string[]

Defined in: submodules/univer/packages/sheets/src/services/exclusive-range/exclusive-range-service.ts:131

Check the interest group id of the giving selection

Parameters

ParameterTypeDescription
selectionsISelectionWithStyle[]The selections to check

Returns

string[]

Implementation of

IExclusiveRangeService.getInterestGroupId