API Reference
@univerjs
@univerjs/sheets
interfaces
Iexclusiverangeservice

@univerjs/sheets v0.4.2Docs


Interface: IExclusiveRangeService

Methods

addExclusiveRange()

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

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

Defined in

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


clearExclusiveRanges()

clearExclusiveRanges(
   unitId, 
   sheetId, 
   feature): void

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

Defined in

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


clearExclusiveRangesByGroupId()

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

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

Defined in

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


getExclusiveRanges()

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

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

Defined in

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


getInterestGroupId()

getInterestGroupId(selections): string[]

Check the interest group id of the giving selection

Parameters

ParameterTypeDescription
selectionsISelectionWithStyle[]The selections to check

Returns

string[]

Defined in

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


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