@univerjs/sheets v0.5.4

Class: FPermission

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:22

FBase is a base class for all facade classes. It provides a way to extend classes with static and instance methods. The _initialize as a special method that will be called after the constructor. You should never call it directly.

Extends

• FBase

Extended by

• FPermissionSheetsUIMixin

Constructors

new FPermission()

new FPermission(
   _injector, 
   _commandService, 
   _permissionService, 
   _worksheetProtectionRuleModel, 
   _rangeProtectionRuleModel, 
   _worksheetProtectionPointRuleModel, 
   _authzIoService): FPermission

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:27

Parameters

Returns

FPermission

Overrides

FBase.constructor

Properties

Methods

addRangeBaseProtection()

addRangeBaseProtection(
   unitId, 
   subUnitId, 
   ranges): Promise<
  | undefined
  | {
  permissionId: string;
  ruleId: string;
}>

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:180

Adds a range protection to the worksheet.

Parameters

Returns

Promise< | undefined | { permissionId: string; ruleId: string; }>

• Returns an object containing the permissionId and ruleId if the range protection is successfully added. If the operation fails or no result is returned, it resolves to undefined. permissionId is used to stitch permission point ID，ruleId is used to store permission rules

addWorksheetBasePermission()

addWorksheetBasePermission(unitId, subUnitId): Promise<undefined | string>

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:74

This function is used to add a base permission for a worksheet.

Parameters

Returns

Promise<undefined | string>

• Returns the permissionId if the permission is successfully added. If the operation fails or no result is returned, it resolves to undefined.

dispose()

dispose(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:109

Returns

void

Inherited from

FBase.dispose

disposeWithMe()

disposeWithMe(disposable): IDisposable

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99

Parameters

Returns

IDisposable

Inherited from

FBase.disposeWithMe

ensureNotDisposed()

protected ensureNotDisposed(): void

Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103

Returns

void

Inherited from

FBase.ensureNotDisposed

removeRangeProtection()

removeRangeProtection(
   unitId, 
   subUnitId, 
   ruleIds): void

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:235

Removes the range protection from the worksheet.

Parameters

Returns

void

removeWorksheetPermission()

removeWorksheetPermission(unitId, subUnitId): void

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:108

Delete the entire table protection set for the worksheet and reset the point permissions of the worksheet to true

Parameters

Returns

void

setRangeProtectionPermissionPoint()

setRangeProtectionPermissionPoint(
   unitId, 
   subUnitId, 
   permissionId, 
   FPointClass, 
   value): void

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:263

Modify the permission points of a custom area

Parameters

Returns

void

setRangeProtectionRanges()

setRangeProtectionRanges(
   unitId, 
   subUnitId, 
   ruleId, 
   ranges): void

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:283

Sets the ranges for range protection in a worksheet.

This method finds the rule by unitId, subUnitId, and ruleId, and updates the rule with the provided ranges. It checks for overlaps with existing ranges in the same subunit and shows an error message if any overlap is detected. If no overlap is found, it executes the command to update the range protection with the new ranges.

Parameters

Returns

void

setWorkbookEditPermission()

setWorkbookEditPermission(unitId, value): void

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:64

This function is used to set whether the workbook can be edited

Parameters

Returns

void

setWorkbookPermissionPoint()

setWorkbookPermissionPoint(
   unitId, 
   FPointClass, 
   value): void

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:50

Configures a specific permission point for a workbook.

This function sets or updates a permission point for a workbook identified by unitId. It creates a new permission point if it does not already exist, and updates the point with the provided value.

Parameters

Returns

void

setWorksheetPermissionPoint()

setWorksheetPermissionPoint(
   unitId, 
   subUnitId, 
   FPointClass, 
value): Promise<undefined | string>

Defined in: submodules/univer/packages/sheets/src/facade/f-permission.ts:131

Sets the worksheet permission point by updating or adding the permission point for the worksheet. If the worksheet doesn’t have a base permission, it creates one to used render

Parameters

Returns

Promise<undefined | string>

• Returns the permissionId if the permission point is successfully set or created. If no permission is set, it resolves to undefined.

extend()

static extend(source): void

Defined in: submodules/univer/packages/core/src/facade/f-base.ts:26

Parameters

Returns

void

Inherited from

FBase.extend