@univerjs/docs-drawing v0.5.4


Interface: IDocDrawingService

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

Extends

Properties

PropertyModifierTypeInherited fromDefined in
add$readonlyObservable<IDrawingSearch[]>IUnitDrawingService.add$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:62
drawingManagerDatapublicIDrawingMap<IDocDrawing>IUnitDrawingService.drawingManagerDatasubmodules/univer/packages/drawing/src/services/drawing-manager.service.ts:139
featurePluginGroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitDrawingService.featurePluginGroupUpdate$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:103
featurePluginOrderUpdate$readonlyObservable<IDrawingOrderUpdateParam>IUnitDrawingService.featurePluginOrderUpdate$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:123
featurePluginUngroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitDrawingService.featurePluginUngroupUpdate$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:104
featurePluginUpdate$readonlyObservable<IDocDrawing[]>IUnitDrawingService.featurePluginUpdate$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:68
focus$readonlyObservable<IDrawingParam[]>IUnitDrawingService.focus$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:90
group$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitDrawingService.group$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:100
order$readonlyObservable<IDrawingOrderMapParam>IUnitDrawingService.order$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:121
refreshTransform$readonlyObservable<IDocDrawing[]>IUnitDrawingService.refreshTransform$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:65
remove$readonlyObservable<IDrawingSearch[]>IUnitDrawingService.remove$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:61
ungroup$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitDrawingService.ungroup$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:101
update$readonlyObservable<IDrawingSearch[]>IUnitDrawingService.update$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:63
visible$readonlyObservable<IDrawingVisibleParam[]>IUnitDrawingService.visible$submodules/univer/packages/drawing/src/services/drawing-manager.service.ts:66

Methods

addNotification()

addNotification(insertParams): void

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

Parameters

ParameterType
insertParamsIDrawingSearch[]

Returns

void

Inherited from

IUnitDrawingService.addNotification


applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
jsonOpunknown

Returns

void

Inherited from

IUnitDrawingService.applyJson1


dispose()

dispose(): void

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

Returns

void

Inherited from

IUnitDrawingService.dispose


featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

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

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitDrawingService.featurePluginGroupUpdateNotification


featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

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

Parameters

ParameterType
drawingOrderUpdateParamIDrawingOrderUpdateParam

Returns

void

Inherited from

IUnitDrawingService.featurePluginOrderUpdateNotification


featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

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

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitDrawingService.featurePluginUngroupUpdateNotification


featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

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

Parameters

ParameterType
updateParamsIDocDrawing[]

Returns

void

Inherited from

IUnitDrawingService.featurePluginUpdateNotification


focusDrawing()

focusDrawing(params): void

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

Parameters

ParameterType
paramsNullable<IDrawingSearch[]>

Returns

void

Inherited from

IUnitDrawingService.focusDrawing


getBackDrawingsOp()

getBackDrawingsOp(orderParams): unknown

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

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitDrawingService.getBackDrawingsOp


getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): unknown

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

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitDrawingService.getBackwardDrawingOp


getBatchAddOp()

getBatchAddOp(insertParams): unknown

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

Parameters

ParameterType
insertParamsIDocDrawing[]

Returns

unknown

Inherited from

IUnitDrawingService.getBatchAddOp


getBatchRemoveOp()

getBatchRemoveOp(removeParams): unknown

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

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

unknown

Inherited from

IUnitDrawingService.getBatchRemoveOp


getBatchUpdateOp()

getBatchUpdateOp(updateParams): unknown

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

Parameters

ParameterType
updateParamsIDocDrawing[]

Returns

unknown

Inherited from

IUnitDrawingService.getBatchUpdateOp


getDrawingByParam()

getDrawingByParam(param): Nullable<IDocDrawing>

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

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<IDocDrawing>

Inherited from

IUnitDrawingService.getDrawingByParam


getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<IDocDrawing>

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

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IDrawingMapItemData<IDocDrawing>

Inherited from

IUnitDrawingService.getDrawingData


getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<IDocDrawing>

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

Parameters

ParameterType
unitIdstring

Returns

IDrawingSubunitMap<IDocDrawing>

Inherited from

IUnitDrawingService.getDrawingDataForUnit


getDrawingEditable()

getDrawingEditable(): boolean

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

Returns

boolean

Inherited from

IUnitDrawingService.getDrawingEditable


getDrawingOKey()

getDrawingOKey(oKey): Nullable<IDocDrawing>

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

Parameters

ParameterType
oKeystring

Returns

Nullable<IDocDrawing>

Inherited from

IUnitDrawingService.getDrawingOKey


getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

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

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

string[]

Inherited from

IUnitDrawingService.getDrawingOrder


getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

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

Parameters

ParameterType
groupParamIDrawingSearch

Returns

IDrawingParam[]

Inherited from

IUnitDrawingService.getDrawingsByGroup


getDrawingVisible()

getDrawingVisible(): boolean

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

Returns

boolean

Inherited from

IUnitDrawingService.getDrawingVisible


getFocusDrawings()

getFocusDrawings(): IDrawingParam[]

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

Returns

IDrawingParam[]

Inherited from

IUnitDrawingService.getFocusDrawings


getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): unknown

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

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitDrawingService.getForwardDrawingsOp


getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): unknown

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

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitDrawingService.getFrontDrawingsOp


getGroupDrawingOp()

getGroupDrawingOp(groupParams): unknown

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

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

unknown

Inherited from

IUnitDrawingService.getGroupDrawingOp


getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<IDocDrawing>

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

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<IDocDrawing>

Inherited from

IUnitDrawingService.getOldDrawingByParam


getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): unknown

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

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

unknown

Inherited from

IUnitDrawingService.getUngroupDrawingOp


groupUpdateNotification()

groupUpdateNotification(groupParams): void

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

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitDrawingService.groupUpdateNotification


initializeNotification()

initializeNotification(unitId): void

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

Parameters

ParameterType
unitIdstring

Returns

void

Inherited from

IUnitDrawingService.initializeNotification


orderNotification()

orderNotification(orderParams): void

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

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Inherited from

IUnitDrawingService.orderNotification


orderUpdateNotification()

orderUpdateNotification(orderParams): void

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

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Inherited from

IUnitDrawingService.orderUpdateNotification


refreshTransform()

refreshTransform(updateParams): void

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

Parameters

ParameterType
updateParamsIDocDrawing[]

Returns

void

Inherited from

IUnitDrawingService.refreshTransform


refreshTransformNotification()

refreshTransformNotification(refreshParams): void

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

Parameters

ParameterType
refreshParamsIDocDrawing[]

Returns

void

Inherited from

IUnitDrawingService.refreshTransformNotification


registerDrawingData()

registerDrawingData(unitId, data): void

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

Parameters

ParameterType
unitIdstring
dataIDrawingSubunitMap<IDocDrawing>

Returns

void

Inherited from

IUnitDrawingService.registerDrawingData


removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

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

Parameters

ParameterType
unitIdstring

Returns

void

Inherited from

IUnitDrawingService.removeDrawingDataForUnit


removeNotification()

removeNotification(removeParams): void

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

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Inherited from

IUnitDrawingService.removeNotification


setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
dataIDrawingMapItemData<IDocDrawing>

Returns

void

Inherited from

IUnitDrawingService.setDrawingData


setDrawingEditable()

setDrawingEditable(editable): void

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

Parameters

ParameterType
editableboolean

Returns

void

Inherited from

IUnitDrawingService.setDrawingEditable


setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

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

Parameters

ParameterType
unitIdstring
subUnitIdstring
orderstring[]

Returns

void

Inherited from

IUnitDrawingService.setDrawingOrder


setDrawingVisible()

setDrawingVisible(visible): void

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

Parameters

ParameterType
visibleboolean

Returns

void

Inherited from

IUnitDrawingService.setDrawingVisible


ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

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

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitDrawingService.ungroupUpdateNotification


updateNotification()

updateNotification(updateParams): void

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

Parameters

ParameterType
updateParamsIDrawingSearch[]

Returns

void

Inherited from

IUnitDrawingService.updateNotification


visibleNotification()

visibleNotification(visibleParams): void

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

Parameters

ParameterType
visibleParamsIDrawingVisibleParam[]

Returns

void

Inherited from

IUnitDrawingService.visibleNotification