API Reference
@univerjs
@univerjs/sheets
classes
Rangeprotectionrulemodel

@univerjs/sheets v0.3.0Docs


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:67 (opens in a new tab)
ruleChange$Observable<IRuleChange>packages/sheets/src/model/range-protection-rule.model.ts:57 (opens in a new tab)
ruleRefresh$Observable<unknown>packages/sheets/src/model/range-protection-rule.model.ts:60 (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:77 (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:73 (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:164 (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:83 (opens in a new tab)


deleteUnitModel()

deleteUnitModel(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:160 (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:143 (opens in a new tab)


getRangeRuleInitState()

getRangeRuleInitState(): boolean

Returns

boolean

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:69 (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:99 (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:103 (opens in a new tab)


getSubunitRuleListLength()

getSubunitRuleListLength(unitId, subUnitId): number

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

number

Defined in

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


getTargetByPermissionId()

getTargetByPermissionId(unitId, permissionId): null | string[]

Parameters

ParameterType
unitIdstring
permissionIdstring

Returns

null | string[]

Defined in

packages/sheets/src/model/range-protection-rule.model.ts:173 (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:62 (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:91 (opens in a new tab)


toObject()

toObject(): IObjectModel

Returns

IObjectModel

Defined in

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


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