API Reference
@univerjs
@univerjs/sheets
classes
Worksheetprotectionrulemodel

@univerjs/sheets v0.1.17Docs


Class: WorksheetProtectionRuleModel

Constructors

new WorksheetProtectionRuleModel()

new WorksheetProtectionRuleModel(): WorksheetProtectionRuleModel

Returns

WorksheetProtectionRuleModel

Properties

PropertyTypeDefined in
resetOrder$Observable<unknown>packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:46 (opens in a new tab)
ruleChange$Observable<{ oldRule: IWorksheetProtectionRule; rule: IWorksheetProtectionRule; subUnitId: string; type: IRuleChangeType; unitId: string; }>packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:42 (opens in a new tab)
ruleRefresh$Observable<unknown>packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:44 (opens in a new tab)
worksheetRuleInitStateChange$Observable<boolean>packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:49 (opens in a new tab)

Methods

addRule()

addRule(unitId, rule): void

Parameters

ParameterType
unitIdstring
ruleIWorksheetProtectionRule

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:55 (opens in a new tab)


changeRuleInitState()

changeRuleInitState(state): void

Parameters

ParameterType
stateboolean

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:51 (opens in a new tab)


deleteRule()

deleteRule(unitId, subUnitId): void

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:61 (opens in a new tab)


deleteUnitModel()

deleteUnitModel(): void

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:115 (opens in a new tab)


fromObject()

fromObject(obj): void

Parameters

ParameterType
objIObjectModel

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:100 (opens in a new tab)


getRule()

getRule(unitId, subUnitId): undefined | IWorksheetProtectionRule

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

undefined | IWorksheetProtectionRule

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:77 (opens in a new tab)


resetOrder()

resetOrder(): void

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:132 (opens in a new tab)


ruleRefresh()

ruleRefresh(permissionId): void

Parameters

ParameterType
permissionIdstring

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:128 (opens in a new tab)


setRule()

setRule(
   unitId, 
   subUnitId, 
   rule): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
ruleIWorksheetProtectionRule

Returns

void

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:69 (opens in a new tab)


toObject()

toObject(): IObjectModel

Returns

IObjectModel

Defined in

packages/sheets/src/services/permission/worksheet-permission/worksheet-permission-rule.model.ts:81 (opens in a new tab)


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