@univerjs/sheets-drawing v0.4.2 • Docs

Interface: ISheetDrawingService

Extends

IUnitDrawingService<ISheetDrawing>

Properties

Property	Modifier	Type	Inherited from	Defined in
`add$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`IUnitDrawingService`.`add$`	packages/drawing/src/services/drawing-manager.service.ts:106 (opens in a new tab)
`drawingManagerData`	`public`	`IDrawingMap`<`ISheetDrawing`>	`IUnitDrawingService`.`drawingManagerData`	packages/drawing/src/services/drawing-manager.service.ts:183 (opens in a new tab)
`featurePluginGroupUpdate$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`IUnitDrawingService`.`featurePluginGroupUpdate$`	packages/drawing/src/services/drawing-manager.service.ts:147 (opens in a new tab)
`featurePluginOrderUpdate$`	`readonly`	`Observable`<`IDrawingOrderUpdateParam`>	`IUnitDrawingService`.`featurePluginOrderUpdate$`	packages/drawing/src/services/drawing-manager.service.ts:167 (opens in a new tab)
`featurePluginUngroupUpdate$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`IUnitDrawingService`.`featurePluginUngroupUpdate$`	packages/drawing/src/services/drawing-manager.service.ts:148 (opens in a new tab)
`featurePluginUpdate$`	`readonly`	`Observable`<`ISheetDrawing`[]>	`IUnitDrawingService`.`featurePluginUpdate$`	packages/drawing/src/services/drawing-manager.service.ts:112 (opens in a new tab)
`focus$`	`readonly`	`Observable`<`IDrawingParam`[]>	`IUnitDrawingService`.`focus$`	packages/drawing/src/services/drawing-manager.service.ts:134 (opens in a new tab)
`group$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`IUnitDrawingService`.`group$`	packages/drawing/src/services/drawing-manager.service.ts:144 (opens in a new tab)
`order$`	`readonly`	`Observable`<`IDrawingOrderMapParam`>	`IUnitDrawingService`.`order$`	packages/drawing/src/services/drawing-manager.service.ts:165 (opens in a new tab)
`refreshTransform$`	`readonly`	`Observable`<`ISheetDrawing`[]>	`IUnitDrawingService`.`refreshTransform$`	packages/drawing/src/services/drawing-manager.service.ts:109 (opens in a new tab)
`remove$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`IUnitDrawingService`.`remove$`	packages/drawing/src/services/drawing-manager.service.ts:105 (opens in a new tab)
`ungroup$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`IUnitDrawingService`.`ungroup$`	packages/drawing/src/services/drawing-manager.service.ts:145 (opens in a new tab)
`update$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`IUnitDrawingService`.`update$`	packages/drawing/src/services/drawing-manager.service.ts:107 (opens in a new tab)
`visible$`	`readonly`	`Observable`<`IDrawingVisibleParam`[]>	`IUnitDrawingService`.`visible$`	packages/drawing/src/services/drawing-manager.service.ts:110 (opens in a new tab)

Methods

addNotification()

addNotification(insertParams): void

Parameters

Parameter	Type
`insertParams`	`IDrawingSearch`[]

Returns

void

Inherited from

IUnitDrawingService.addNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:117 (opens in a new tab)

applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`jsonOp`	`unknown`

Returns

void

Inherited from

IUnitDrawingService.applyJson1

Defined in

packages/drawing/src/services/drawing-manager.service.ts:198 (opens in a new tab)

dispose()

dispose(): void

Returns

void

Inherited from

IUnitDrawingService.dispose

Defined in

packages/drawing/src/services/drawing-manager.service.ts:185 (opens in a new tab)

featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

IUnitDrawingService.featurePluginGroupUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:156 (opens in a new tab)

featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

Parameter	Type
`drawingOrderUpdateParam`	`IDrawingOrderUpdateParam`

Returns

void

Inherited from

IUnitDrawingService.featurePluginOrderUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:179 (opens in a new tab)

featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

IUnitDrawingService.featurePluginUngroupUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:157 (opens in a new tab)

featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`ISheetDrawing`[]

Returns

void

Inherited from

IUnitDrawingService.featurePluginUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:127 (opens in a new tab)

focusDrawing()

focusDrawing(params): void

Parameters

Parameter	Type
`params`	`Nullable`<`IDrawingSearch`[]>

Returns

void

Inherited from

IUnitDrawingService.focusDrawing

Defined in

packages/drawing/src/services/drawing-manager.service.ts:136 (opens in a new tab)

getBackDrawingsOp()

getBackDrawingsOp(orderParams): unknown

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

unknown

Inherited from

IUnitDrawingService.getBackDrawingsOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:174 (opens in a new tab)

getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): unknown

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

unknown

Inherited from

IUnitDrawingService.getBackwardDrawingOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:172 (opens in a new tab)

getBatchAddOp()

getBatchAddOp(insertParams): unknown

Parameters

Parameter	Type
`insertParams`	`ISheetDrawing`[]

Returns

unknown

Inherited from

IUnitDrawingService.getBatchAddOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:123 (opens in a new tab)

getBatchRemoveOp()

getBatchRemoveOp(removeParams): unknown

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

unknown

Inherited from

IUnitDrawingService.getBatchRemoveOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:124 (opens in a new tab)

getBatchUpdateOp()

getBatchUpdateOp(updateParams): unknown

Parameters

Parameter	Type
`updateParams`	`ISheetDrawing`[]

Returns

unknown

Inherited from

IUnitDrawingService.getBatchUpdateOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:125 (opens in a new tab)

getDrawingByParam()

getDrawingByParam(param): Nullable<ISheetDrawing>

Parameters

Parameter	Type
`param`	`Nullable`<`IDrawingSearch`>

getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<ISheetDrawing>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

IDrawingMapItemData<ISheetDrawing>

Inherited from

IUnitDrawingService.getDrawingData

Defined in

packages/drawing/src/services/drawing-manager.service.ts:193 (opens in a new tab)

getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<ISheetDrawing>

Parameters

Parameter	Type
`unitId`	`string`

Returns

IDrawingSubunitMap<ISheetDrawing>

Inherited from

IUnitDrawingService.getDrawingDataForUnit

Defined in

packages/drawing/src/services/drawing-manager.service.ts:187 (opens in a new tab)

getDrawingEditable()

getDrawingEditable(): boolean

Returns

boolean

Inherited from

IUnitDrawingService.getDrawingEditable

Defined in

packages/drawing/src/services/drawing-manager.service.ts:199 (opens in a new tab)

getDrawingOKey()

getDrawingOKey(oKey): Nullable<ISheetDrawing>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<ISheetDrawing>

Inherited from

IUnitDrawingService.getDrawingOKey

Defined in

packages/drawing/src/services/drawing-manager.service.ts:197 (opens in a new tab)

getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

string[]

Inherited from

IUnitDrawingService.getDrawingOrder

Defined in

packages/drawing/src/services/drawing-manager.service.ts:176 (opens in a new tab)

getDrawingVisible()

getDrawingVisible(): boolean

Returns

boolean

Inherited from

IUnitDrawingService.getDrawingVisible

Defined in

packages/drawing/src/services/drawing-manager.service.ts:200 (opens in a new tab)

getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

Parameter	Type
`groupParam`	`IDrawingSearch`

Returns

IDrawingParam[]

Inherited from

IUnitDrawingService.getDrawingsByGroup

Defined in

packages/drawing/src/services/drawing-manager.service.ts:154 (opens in a new tab)

getFocusDrawings()

getFocusDrawings(): IDrawingParam[]

Returns

IDrawingParam[]

Inherited from

IUnitDrawingService.getFocusDrawings

Defined in

packages/drawing/src/services/drawing-manager.service.ts:137 (opens in a new tab)

getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): unknown

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

unknown

Inherited from

IUnitDrawingService.getForwardDrawingsOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:171 (opens in a new tab)

getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): unknown

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

unknown

Inherited from

IUnitDrawingService.getFrontDrawingsOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:173 (opens in a new tab)

getGroupDrawingOp()

getGroupDrawingOp(groupParams): unknown

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

unknown

Inherited from

IUnitDrawingService.getGroupDrawingOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:150 (opens in a new tab)

getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<ISheetDrawing>

Parameters

Parameter	Type
`param`	`Nullable`<`IDrawingSearch`>

Returns

Nullable<ISheetDrawing>

Inherited from

IUnitDrawingService.getOldDrawingByParam

Defined in

packages/drawing/src/services/drawing-manager.service.ts:196 (opens in a new tab)

getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): unknown

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

unknown

Inherited from

IUnitDrawingService.getUngroupDrawingOp

Defined in

packages/drawing/src/services/drawing-manager.service.ts:151 (opens in a new tab)

groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

IUnitDrawingService.groupUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:152 (opens in a new tab)

initializeNotification()

initializeNotification(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Inherited from

IUnitDrawingService.initializeNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:191 (opens in a new tab)

orderNotification()

orderNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Inherited from

IUnitDrawingService.orderNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:169 (opens in a new tab)

orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Inherited from

IUnitDrawingService.orderUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:178 (opens in a new tab)

refreshTransform()

refreshTransform(updateParams): void

Parameters

Parameter	Type
`updateParams`	`ISheetDrawing`[]

Returns

void

Inherited from

IUnitDrawingService.refreshTransform

Defined in

packages/drawing/src/services/drawing-manager.service.ts:114 (opens in a new tab)

refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Parameters

Parameter	Type
`refreshParams`	`ISheetDrawing`[]

Returns

void

Inherited from

IUnitDrawingService.refreshTransformNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:120 (opens in a new tab)

registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

Parameter	Type
`unitId`	`string`
`data`	`IDrawingSubunitMap`<`ISheetDrawing`>

Returns

void

Inherited from

IUnitDrawingService.registerDrawingData

Defined in

packages/drawing/src/services/drawing-manager.service.ts:189 (opens in a new tab)

removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Inherited from

IUnitDrawingService.removeDrawingDataForUnit

Defined in

packages/drawing/src/services/drawing-manager.service.ts:188 (opens in a new tab)

removeNotification()

removeNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Inherited from

IUnitDrawingService.removeNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:116 (opens in a new tab)

setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`data`	`IDrawingMapItemData`<`ISheetDrawing`>

Returns

void

Inherited from

IUnitDrawingService.setDrawingData

Defined in

packages/drawing/src/services/drawing-manager.service.ts:194 (opens in a new tab)

setDrawingEditable()

setDrawingEditable(editable): void

Parameters

Parameter	Type
`editable`	`boolean`

Returns

void

Inherited from

IUnitDrawingService.setDrawingEditable

Defined in

packages/drawing/src/services/drawing-manager.service.ts:202 (opens in a new tab)

setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`order`	`string`[]

Returns

void

Inherited from

IUnitDrawingService.setDrawingOrder

Defined in

packages/drawing/src/services/drawing-manager.service.ts:177 (opens in a new tab)

setDrawingVisible()

setDrawingVisible(visible): void

Parameters

Parameter	Type
`visible`	`boolean`

Returns

void

Inherited from

IUnitDrawingService.setDrawingVisible

Defined in

packages/drawing/src/services/drawing-manager.service.ts:201 (opens in a new tab)

ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

IUnitDrawingService.ungroupUpdateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:153 (opens in a new tab)

updateNotification()

updateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDrawingSearch`[]

Returns

void

Inherited from

IUnitDrawingService.updateNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:118 (opens in a new tab)

visibleNotification()

visibleNotification(visibleParams): void

Parameters

Parameter	Type
`visibleParams`	`IDrawingVisibleParam`[]

Returns

void

Inherited from

IUnitDrawingService.visibleNotification

Defined in

packages/drawing/src/services/drawing-manager.service.ts:121 (opens in a new tab)

Isheetdrawingposition Isheetfloatdom