API Reference
@univerjs
@univerjs/sheets
classes
Rangeprotectionrulemodel

@univerjs/sheets v0.1.17Docs


Class: RangeProtectionRuleModel

Constructors

new RangeProtectionRuleModel()

new RangeProtectionRuleModel(): RangeProtectionRuleModel

Returns

RangeProtectionRuleModel

Properties

PropertyTypeDefined in
rangeRuleInitStateChange$Observable<boolean>packages/sheets/src/model/range-protection-rule.model.ts:65 (opens in a new tab)
ruleChange$Observable<{ oldRule: IRangeProtectionRule; rule: IRangeProtectionRule; subUnitId: string; type: IRuleChangeType; unitId: string; }>packages/sheets/src/model/range-protection-rule.model.ts:55 (opens in a new tab)
ruleRefresh$Observable<unknown>packages/sheets/src/model/range-protection-rule.model.ts:58 (opens in a new tab)

Methods

addRule()

addRule(
   unitId, 
   subUnitId, 
   rule): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIRangeProtectionRule

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:71 (opens in a new tab)


changeRuleInitState()

changeRuleInitState(state): void

Parameters

ParameterType
stateboolean

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:67 (opens in a new tab)


createRuleId()

createRuleId(unitId, subUnitId): string

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

string

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:153 (opens in a new tab)


deleteRule()

deleteRule(
   unitId, 
   subUnitId, 
   id): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
idstring

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:77 (opens in a new tab)


deleteUnitModel()

deleteUnitModel(): void

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:149 (opens in a new tab)


fromObject()

fromObject(obj): void

Parameters

ParameterType
objIObjectModel

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:132 (opens in a new tab)


getRule()

getRule(
   unitId, 
   subUnitId, 
   id): undefined | IRangeProtectionRule

Parameters

ParameterType
unitIdstring
subUnitIdstring
idstring

Returns

undefined | IRangeProtectionRule

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:93 (opens in a new tab)


getSubunitRuleList()

getSubunitRuleList(unitId, subUnitId): IRangeProtectionRule[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IRangeProtectionRule[]

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:97 (opens in a new tab)


ruleRefresh()

ruleRefresh(id): void

Parameters

ParameterType
idstring

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:60 (opens in a new tab)


setRule()

setRule(
   unitId, 
   subUnitId, 
   id, 
   rule): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
idstring
ruleIRangeProtectionRule

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:85 (opens in a new tab)


toObject()

toObject(): IObjectModel

Returns

IObjectModel

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:117 (opens in a new tab)


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