API Reference
@univerjs
@univerjs/drawing
classes
Unitdrawingservice

@univerjs/drawing v0.4.2Docs


Class: UnitDrawingService<T>

unitId -> subUnitId -> drawingId -> drawingParam

Extended by

Type Parameters

Type Parameter
T extends IDrawingParam

Implements

Constructors

new UnitDrawingService()

new UnitDrawingService<T>(): UnitDrawingService<T>

Returns

UnitDrawingService<T>

Properties

PropertyModifierTypeDefault valueDefined in
add$readonlyObservable<IDrawingSearch[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:58 (opens in a new tab)
drawingManagerDatapublicIDrawingMap<T>{}packages/drawing/src/services/drawing-manager-impl.service.ts:48 (opens in a new tab)
featurePluginAdd$readonlyObservable<T[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:88 (opens in a new tab)
featurePluginGroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:97 (opens in a new tab)
featurePluginOrderUpdate$readonlyObservable<IDrawingOrderUpdateParam>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:94 (opens in a new tab)
featurePluginRemove$readonlyObservable<IDrawingSearch[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:91 (opens in a new tab)
featurePluginUngroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:100 (opens in a new tab)
featurePluginUpdate$readonlyObservable<T[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:85 (opens in a new tab)
focus$publicObservable<T[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:82 (opens in a new tab)
group$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:67 (opens in a new tab)
order$readonlyObservable<IDrawingOrderMapParam>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:64 (opens in a new tab)
refreshTransform$readonlyObservable<T[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:73 (opens in a new tab)
remove$readonlyObservable<IDrawingSearch[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:55 (opens in a new tab)
ungroup$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:70 (opens in a new tab)
update$readonlyObservable<IDrawingSearch[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:61 (opens in a new tab)
visible$readonlyObservable<IDrawingVisibleParam[]>undefinedpackages/drawing/src/services/drawing-manager-impl.service.ts:76 (opens in a new tab)

Methods

addNotification()

addNotification(insertParams): void

Parameters

ParameterType
insertParamsIDrawingSearch[]

Returns

void

Implementation of

IUnitDrawingService.addNotification

Defined in

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


applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
jsonOpJSONOp

Returns

void

Implementation of

IUnitDrawingService.applyJson1

Defined in

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


dispose()

dispose(): void

Returns

void

Implementation of

IUnitDrawingService.dispose

Defined in

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


featurePluginAddNotification()

featurePluginAddNotification(insertParams): void

Parameters

ParameterType
insertParamsT[]

Returns

void

Defined in

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


featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginGroupUpdateNotification

Defined in

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


featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

ParameterType
drawingOrderUpdateParamIDrawingOrderUpdateParam

Returns

void

Implementation of

IUnitDrawingService.featurePluginOrderUpdateNotification

Defined in

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


featurePluginRemoveNotification()

featurePluginRemoveNotification(removeParams): void

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Defined in

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


featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginUngroupUpdateNotification

Defined in

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


featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

ParameterType
updateParamsT[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginUpdateNotification

Defined in

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


focusDrawing()

focusDrawing(params): void

Parameters

ParameterType
paramsNullable<IDrawingSearch[]>

Returns

void

Implementation of

IUnitDrawingService.focusDrawing

Defined in

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


getBackDrawingsOp()

getBackDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBackDrawingsOp

Defined in

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


getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBackwardDrawingOp

Defined in

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


getBatchAddOp()

getBatchAddOp(insertParams): IDrawingJsonUndo1

Parameters

ParameterType
insertParamsT[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchAddOp

Defined in

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


getBatchRemoveOp()

getBatchRemoveOp(removeParams): IDrawingJsonUndo1

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchRemoveOp

Defined in

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


getBatchUpdateOp()

getBatchUpdateOp(updateParams): IDrawingJsonUndo1

Parameters

ParameterType
updateParamsT[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchUpdateOp

Defined in

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


getDrawingByParam()

getDrawingByParam(param): Nullable<T>

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getDrawingByParam

Defined in

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


getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<T>

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IDrawingMapItemData<T>

Implementation of

IUnitDrawingService.getDrawingData

Defined in

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


getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<T>

Parameters

ParameterType
unitIdstring

Returns

IDrawingSubunitMap<T>

Implementation of

IUnitDrawingService.getDrawingDataForUnit

Defined in

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


getDrawingEditable()

getDrawingEditable(): boolean

Returns

boolean

Implementation of

IUnitDrawingService.getDrawingEditable

Defined in

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


getDrawingOKey()

getDrawingOKey(oKey): Nullable<T>

Parameters

ParameterType
oKeystring

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getDrawingOKey

Defined in

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


getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

string[]

Implementation of

IUnitDrawingService.getDrawingOrder

Defined in

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


getDrawingVisible()

getDrawingVisible(): boolean

Returns

boolean

Implementation of

IUnitDrawingService.getDrawingVisible

Defined in

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


getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

ParameterType
groupParamIDrawingSearch

Returns

IDrawingParam[]

Implementation of

IUnitDrawingService.getDrawingsByGroup

Defined in

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


getFocusDrawings()

getFocusDrawings(): T[]

Returns

T[]

Implementation of

IUnitDrawingService.getFocusDrawings

Defined in

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


getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getForwardDrawingsOp

Defined in

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


getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getFrontDrawingsOp

Defined in

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


getGroupDrawingOp()

getGroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getGroupDrawingOp

Defined in

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


getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<T>

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getOldDrawingByParam

Defined in

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


getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getUngroupDrawingOp

Defined in

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


groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.groupUpdateNotification

Defined in

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


initializeNotification()

initializeNotification(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IUnitDrawingService.initializeNotification

Defined in

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


orderNotification()

orderNotification(orderParams): void

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Implementation of

IUnitDrawingService.orderNotification

Defined in

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


orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Implementation of

IUnitDrawingService.orderUpdateNotification

Defined in

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


refreshTransform()

refreshTransform(updateParams): void

Parameters

ParameterType
updateParamsT[]

Returns

void

Implementation of

IUnitDrawingService.refreshTransform

Defined in

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


refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Parameters

ParameterType
refreshParamsT[]

Returns

void

Implementation of

IUnitDrawingService.refreshTransformNotification

Defined in

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


registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

ParameterType
unitIdstring
dataIDrawingSubunitMap<T>

Returns

void

Implementation of

IUnitDrawingService.registerDrawingData

Defined in

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


removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IUnitDrawingService.removeDrawingDataForUnit

Defined in

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


removeNotification()

removeNotification(removeParams): void

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Implementation of

IUnitDrawingService.removeNotification

Defined in

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


setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
dataIDrawingMapItemData<T>

Returns

void

Implementation of

IUnitDrawingService.setDrawingData

Defined in

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


setDrawingEditable()

setDrawingEditable(editable): void

Parameters

ParameterType
editableboolean

Returns

void

Implementation of

IUnitDrawingService.setDrawingEditable

Defined in

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


setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
orderstring[]

Returns

void

Implementation of

IUnitDrawingService.setDrawingOrder

Defined in

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


setDrawingVisible()

setDrawingVisible(visible): void

Parameters

ParameterType
visibleboolean

Returns

void

Implementation of

IUnitDrawingService.setDrawingVisible

Defined in

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


ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.ungroupUpdateNotification

Defined in

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


updateNotification()

updateNotification(updateParams): void

Parameters

ParameterType
updateParamsIDrawingSearch[]

Returns

void

Implementation of

IUnitDrawingService.updateNotification

Defined in

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


visibleNotification()

visibleNotification(visibleParams): void

Parameters

ParameterType
visibleParamsIDrawingVisibleParam[]

Returns

void

Implementation of

IUnitDrawingService.visibleNotification

Defined in

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


Copyright © 2021-2024 DreamNum Co,Ltd. All Rights Reserved.