@univerjs/docs-drawing v0.5.4


Class: DocDrawingService

Defined in: submodules/univer/packages/docs-drawing/src/services/doc-drawing.service.ts:33

unitId -> subUnitId -> drawingId -> drawingParam

Extends

Constructors

new DocDrawingService()

new DocDrawingService(): DocDrawingService

Returns

DocDrawingService

Inherited from

UnitDrawingService.constructor

Properties

PropertyModifierTypeDefault valueInherited fromDefined in
add$readonlyObservable<IDrawingSearch[]>undefinedUnitDrawingService.add$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:58
drawingManagerDatapublicIDrawingMap<IDocDrawing>{}UnitDrawingService.drawingManagerDatasubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:48
featurePluginAdd$readonlyObservable<IDocDrawing[]>undefinedUnitDrawingService.featurePluginAdd$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:88
featurePluginGroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedUnitDrawingService.featurePluginGroupUpdate$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:97
featurePluginOrderUpdate$readonlyObservable<IDrawingOrderUpdateParam>undefinedUnitDrawingService.featurePluginOrderUpdate$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:94
featurePluginRemove$readonlyObservable<IDrawingSearch[]>undefinedUnitDrawingService.featurePluginRemove$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:91
featurePluginUngroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedUnitDrawingService.featurePluginUngroupUpdate$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:100
featurePluginUpdate$readonlyObservable<IDocDrawing[]>undefinedUnitDrawingService.featurePluginUpdate$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:85
focus$publicObservable<IDocDrawing[]>undefinedUnitDrawingService.focus$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:82
group$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedUnitDrawingService.group$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:67
order$readonlyObservable<IDrawingOrderMapParam>undefinedUnitDrawingService.order$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:64
refreshTransform$readonlyObservable<IDocDrawing[]>undefinedUnitDrawingService.refreshTransform$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:73
remove$readonlyObservable<IDrawingSearch[]>undefinedUnitDrawingService.remove$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:55
ungroup$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedUnitDrawingService.ungroup$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:70
update$readonlyObservable<IDrawingSearch[]>undefinedUnitDrawingService.update$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:61
visible$readonlyObservable<IDrawingVisibleParam[]>undefinedUnitDrawingService.visible$submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:76

Methods

addNotification()

addNotification(insertParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:281

Parameters

ParameterType
insertParamsIDrawingSearch[]

Returns

void

Inherited from

UnitDrawingService.addNotification


applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:406

Parameters

ParameterType
unitIdstring
subUnitIdstring
jsonOpJSONOp

Returns

void

Inherited from

UnitDrawingService.applyJson1


dispose()

dispose(): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:105

Returns

void

Inherited from

UnitDrawingService.dispose


featurePluginAddNotification()

featurePluginAddNotification(insertParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:443

Parameters

ParameterType
insertParamsIDocDrawing[]

Returns

void

Inherited from

UnitDrawingService.featurePluginAddNotification


featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:451

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

UnitDrawingService.featurePluginGroupUpdateNotification


featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:439

Parameters

ParameterType
drawingOrderUpdateParamIDrawingOrderUpdateParam

Returns

void

Inherited from

UnitDrawingService.featurePluginOrderUpdateNotification


featurePluginRemoveNotification()

featurePluginRemoveNotification(removeParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:447

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Inherited from

UnitDrawingService.featurePluginRemoveNotification


featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:455

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

UnitDrawingService.featurePluginUngroupUpdateNotification


featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:435

Parameters

ParameterType
updateParamsIDocDrawing[]

Returns

void

Inherited from

UnitDrawingService.featurePluginUpdateNotification


focusDrawing()

focusDrawing(params): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:472

Parameters

ParameterType
paramsNullable<IDrawingSearch[]>

Returns

void

Inherited from

UnitDrawingService.focusDrawing


getBackDrawingsOp()

getBackDrawingsOp(orderParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:595

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBackDrawingsOp


getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:545

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBackwardDrawingOp


getBatchAddOp()

getBatchAddOp(insertParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:207

Parameters

ParameterType
insertParamsIDocDrawing[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchAddOp


getBatchRemoveOp()

getBatchRemoveOp(removeParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:228

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchRemoveOp


getBatchUpdateOp()

getBatchUpdateOp(updateParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:256

Parameters

ParameterType
updateParamsIDocDrawing[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchUpdateOp


getDrawingByParam()

getDrawingByParam(param): Nullable<IDocDrawing>

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:459

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingByParam


getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<IDocDrawing>

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:198

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IDrawingMapItemData<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingData


getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<IDocDrawing>

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:139

Parameters

ParameterType
unitIdstring

Returns

IDrawingSubunitMap<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingDataForUnit


getDrawingEditable()

getDrawingEditable(): boolean

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:782

Returns

boolean

Inherited from

UnitDrawingService.getDrawingEditable


getDrawingOKey()

getDrawingOKey(oKey): Nullable<IDocDrawing>

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:467

Parameters

ParameterType
oKeystring

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingOKey


getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:506

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

string[]

Inherited from

UnitDrawingService.getDrawingOrder


getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:333

Parameters

ParameterType
groupParamIDrawingSearch

Returns

IDrawingParam[]

Inherited from

UnitDrawingService.getDrawingsByGroup


getDrawingVisible()

getDrawingVisible(): boolean

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:778

Returns

boolean

Inherited from

UnitDrawingService.getDrawingVisible


getFocusDrawings()

getFocusDrawings(): IDocDrawing[]

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:494

Returns

IDocDrawing[]

Inherited from

UnitDrawingService.getFocusDrawings


getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:519

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getForwardDrawingsOp


getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:571

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getFrontDrawingsOp


getGroupDrawingOp()

getGroupDrawingOp(groupParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:305

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getGroupDrawingOp


getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<IDocDrawing>

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:463

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getOldDrawingByParam


getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): IDrawingJsonUndo1

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:319

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getUngroupDrawingOp


groupUpdateNotification()

groupUpdateNotification(groupParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:293

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

UnitDrawingService.groupUpdateNotification


initializeNotification()

initializeNotification(unitId): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:172

Parameters

ParameterType
unitIdstring

Returns

void

Inherited from

UnitDrawingService.initializeNotification


orderNotification()

orderNotification(orderParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:289

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Inherited from

UnitDrawingService.orderNotification


orderUpdateNotification()

orderUpdateNotification(orderParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:515

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Inherited from

UnitDrawingService.orderUpdateNotification


refreshTransform()

refreshTransform(updateParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:124

Parameters

ParameterType
updateParamsIDocDrawing[]

Returns

void

Inherited from

UnitDrawingService.refreshTransform


refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:301

Parameters

ParameterType
refreshParamsIDocDrawing[]

Returns

void

Inherited from

UnitDrawingService.refreshTransformNotification


registerDrawingData()

registerDrawingData(unitId, data): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:168

Parameters

ParameterType
unitIdstring
dataIDrawingSubunitMap<IDocDrawing>

Returns

void

Inherited from

UnitDrawingService.registerDrawingData


removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:143

Parameters

ParameterType
unitIdstring

Returns

void

Inherited from

UnitDrawingService.removeDrawingDataForUnit


removeNotification()

removeNotification(removeParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:277

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Inherited from

UnitDrawingService.removeNotification


setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:203

Parameters

ParameterType
unitIdstring
subUnitIdstring
dataIDrawingMapItemData<IDocDrawing>

Returns

void

Inherited from

UnitDrawingService.setDrawingData


setDrawingEditable()

setDrawingEditable(editable): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:790

Parameters

ParameterType
editableboolean

Returns

void

Inherited from

UnitDrawingService.setDrawingEditable


setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:511

Parameters

ParameterType
unitIdstring
subUnitIdstring
orderstring[]

Returns

void

Inherited from

UnitDrawingService.setDrawingOrder


setDrawingVisible()

setDrawingVisible(visible): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:786

Parameters

ParameterType
visibleboolean

Returns

void

Inherited from

UnitDrawingService.setDrawingVisible


ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:297

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

UnitDrawingService.ungroupUpdateNotification


updateNotification()

updateNotification(updateParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:285

Parameters

ParameterType
updateParamsIDrawingSearch[]

Returns

void

Inherited from

UnitDrawingService.updateNotification


visibleNotification()

visibleNotification(visibleParams): void

Defined in: submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:120

Parameters

ParameterType
visibleParamsIDrawingVisibleParam[]

Returns

void

Inherited from

UnitDrawingService.visibleNotification