@univerjs/sheets v0.1.17 • Docs
Class: RangeProtectionRuleModel
Constructors
new RangeProtectionRuleModel()
new RangeProtectionRuleModel(): RangeProtectionRuleModel
Returns
Properties
Property | Type | Defined 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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
rule | IRangeProtectionRule |
Returns
void
Defined in
packages/sheets/src/model/range-protection-rule.model.ts:71 (opens in a new tab)
changeRuleInitState()
changeRuleInitState(state): void
Parameters
Parameter | Type |
---|---|
state | boolean |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
id | string |
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
Parameter | Type |
---|---|
obj | IObjectModel |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
id | string |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
Returns
Defined in
packages/sheets/src/model/range-protection-rule.model.ts:97 (opens in a new tab)
ruleRefresh()
ruleRefresh(id): void
Parameters
Parameter | Type |
---|---|
id | string |
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
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
id | string |
rule | IRangeProtectionRule |
Returns
void
Defined in
packages/sheets/src/model/range-protection-rule.model.ts:85 (opens in a new tab)
toObject()
toObject(): IObjectModel
Returns
Defined in
packages/sheets/src/model/range-protection-rule.model.ts:117 (opens in a new tab)