API Reference
@univerjs
@univerjs/drawing
interfaces
Iunitdrawingservice

@univerjs/drawing v0.4.2Docs


Interface: IUnitDrawingService<T>

Extends

  • IUnitNormalDrawingService<T>.IUnitFocusDrawingService.IUnitGroupDrawingService.IUnitOrderDrawingService.IDisposable

Extended by

Type Parameters

Type Parameter
T extends IDrawingParam

Properties

PropertyModifierTypeInherited fromDefined in
add$readonlyObservable<IDrawingSearch[]>IUnitNormalDrawingService.add$packages/drawing/src/services/drawing-manager.service.ts:106 (opens in a new tab)
drawingManagerDatapublicIDrawingMap<T>-packages/drawing/src/services/drawing-manager.service.ts:183 (opens in a new tab)
featurePluginGroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitGroupDrawingService.featurePluginGroupUpdate$packages/drawing/src/services/drawing-manager.service.ts:147 (opens in a new tab)
featurePluginOrderUpdate$readonlyObservable<IDrawingOrderUpdateParam>IUnitOrderDrawingService.featurePluginOrderUpdate$packages/drawing/src/services/drawing-manager.service.ts:167 (opens in a new tab)
featurePluginUngroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitGroupDrawingService.featurePluginUngroupUpdate$packages/drawing/src/services/drawing-manager.service.ts:148 (opens in a new tab)
featurePluginUpdate$readonlyObservable<T[]>IUnitNormalDrawingService.featurePluginUpdate$packages/drawing/src/services/drawing-manager.service.ts:112 (opens in a new tab)
focus$readonlyObservable<IDrawingParam[]>IUnitFocusDrawingService.focus$packages/drawing/src/services/drawing-manager.service.ts:134 (opens in a new tab)
group$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitGroupDrawingService.group$packages/drawing/src/services/drawing-manager.service.ts:144 (opens in a new tab)
order$readonlyObservable<IDrawingOrderMapParam>IUnitOrderDrawingService.order$packages/drawing/src/services/drawing-manager.service.ts:165 (opens in a new tab)
refreshTransform$readonlyObservable<T[]>IUnitNormalDrawingService.refreshTransform$packages/drawing/src/services/drawing-manager.service.ts:109 (opens in a new tab)
remove$readonlyObservable<IDrawingSearch[]>IUnitNormalDrawingService.remove$packages/drawing/src/services/drawing-manager.service.ts:105 (opens in a new tab)
ungroup$readonlyObservable<IDrawingGroupUpdateParam[]>IUnitGroupDrawingService.ungroup$packages/drawing/src/services/drawing-manager.service.ts:145 (opens in a new tab)
update$readonlyObservable<IDrawingSearch[]>IUnitNormalDrawingService.update$packages/drawing/src/services/drawing-manager.service.ts:107 (opens in a new tab)
visible$readonlyObservable<IDrawingVisibleParam[]>IUnitNormalDrawingService.visible$packages/drawing/src/services/drawing-manager.service.ts:110 (opens in a new tab)

Methods

addNotification()

addNotification(insertParams): void

Parameters

ParameterType
insertParamsIDrawingSearch[]

Returns

void

Inherited from

IUnitNormalDrawingService.addNotification

Defined in

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


applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
jsonOpunknown

Returns

void

Defined in

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


dispose()

dispose(): void

Returns

void

Overrides

IDisposable.dispose

Defined in

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


featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitGroupDrawingService.featurePluginGroupUpdateNotification

Defined in

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


featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

ParameterType
drawingOrderUpdateParamIDrawingOrderUpdateParam

Returns

void

Inherited from

IUnitOrderDrawingService.featurePluginOrderUpdateNotification

Defined in

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


featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitGroupDrawingService.featurePluginUngroupUpdateNotification

Defined in

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


featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

ParameterType
updateParamsT[]

Returns

void

Inherited from

IUnitNormalDrawingService.featurePluginUpdateNotification

Defined in

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


focusDrawing()

focusDrawing(params): void

Parameters

ParameterType
paramsNullable<IDrawingSearch[]>

Returns

void

Inherited from

IUnitFocusDrawingService.focusDrawing

Defined in

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


getBackDrawingsOp()

getBackDrawingsOp(orderParams): unknown

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitOrderDrawingService.getBackDrawingsOp

Defined in

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


getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): unknown

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitOrderDrawingService.getBackwardDrawingOp

Defined in

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


getBatchAddOp()

getBatchAddOp(insertParams): unknown

Parameters

ParameterType
insertParamsT[]

Returns

unknown

Inherited from

IUnitNormalDrawingService.getBatchAddOp

Defined in

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


getBatchRemoveOp()

getBatchRemoveOp(removeParams): unknown

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

unknown

Inherited from

IUnitNormalDrawingService.getBatchRemoveOp

Defined in

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


getBatchUpdateOp()

getBatchUpdateOp(updateParams): unknown

Parameters

ParameterType
updateParamsT[]

Returns

unknown

Inherited from

IUnitNormalDrawingService.getBatchUpdateOp

Defined in

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


getDrawingByParam()

getDrawingByParam(param): Nullable<T>

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<T>

Defined in

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


getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<T>

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IDrawingMapItemData<T>

Defined in

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


getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<T>

Parameters

ParameterType
unitIdstring

Returns

IDrawingSubunitMap<T>

Defined in

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


getDrawingEditable()

getDrawingEditable(): boolean

Returns

boolean

Defined in

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


getDrawingOKey()

getDrawingOKey(oKey): Nullable<T>

Parameters

ParameterType
oKeystring

Returns

Nullable<T>

Defined in

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


getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

string[]

Inherited from

IUnitOrderDrawingService.getDrawingOrder

Defined in

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


getDrawingVisible()

getDrawingVisible(): boolean

Returns

boolean

Defined in

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


getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

ParameterType
groupParamIDrawingSearch

Returns

IDrawingParam[]

Inherited from

IUnitGroupDrawingService.getDrawingsByGroup

Defined in

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


getFocusDrawings()

getFocusDrawings(): IDrawingParam[]

Returns

IDrawingParam[]

Inherited from

IUnitFocusDrawingService.getFocusDrawings

Defined in

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


getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): unknown

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitOrderDrawingService.getForwardDrawingsOp

Defined in

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


getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): unknown

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

unknown

Inherited from

IUnitOrderDrawingService.getFrontDrawingsOp

Defined in

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


getGroupDrawingOp()

getGroupDrawingOp(groupParams): unknown

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

unknown

Inherited from

IUnitGroupDrawingService.getGroupDrawingOp

Defined in

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


getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<T>

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<T>

Defined in

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


getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): unknown

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

unknown

Inherited from

IUnitGroupDrawingService.getUngroupDrawingOp

Defined in

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


groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitGroupDrawingService.groupUpdateNotification

Defined in

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


initializeNotification()

initializeNotification(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

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


orderNotification()

orderNotification(orderParams): void

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Inherited from

IUnitOrderDrawingService.orderNotification

Defined in

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


orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Inherited from

IUnitOrderDrawingService.orderUpdateNotification

Defined in

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


refreshTransform()

refreshTransform(updateParams): void

Parameters

ParameterType
updateParamsT[]

Returns

void

Inherited from

IUnitNormalDrawingService.refreshTransform

Defined in

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


refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Parameters

ParameterType
refreshParamsT[]

Returns

void

Inherited from

IUnitNormalDrawingService.refreshTransformNotification

Defined in

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


registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

ParameterType
unitIdstring
dataIDrawingSubunitMap<T>

Returns

void

Defined in

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


removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Defined in

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


removeNotification()

removeNotification(removeParams): void

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Inherited from

IUnitNormalDrawingService.removeNotification

Defined in

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


setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
dataIDrawingMapItemData<T>

Returns

void

Defined in

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


setDrawingEditable()

setDrawingEditable(editable): void

Parameters

ParameterType
editableboolean

Returns

void

Defined in

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


setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
orderstring[]

Returns

void

Inherited from

IUnitOrderDrawingService.setDrawingOrder

Defined in

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


setDrawingVisible()

setDrawingVisible(visible): void

Parameters

ParameterType
visibleboolean

Returns

void

Defined in

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


ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Inherited from

IUnitGroupDrawingService.ungroupUpdateNotification

Defined in

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


updateNotification()

updateNotification(updateParams): void

Parameters

ParameterType
updateParamsIDrawingSearch[]

Returns

void

Inherited from

IUnitNormalDrawingService.updateNotification

Defined in

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


visibleNotification()

visibleNotification(visibleParams): void

Parameters

ParameterType
visibleParamsIDrawingVisibleParam[]

Returns

void

Inherited from

IUnitNormalDrawingService.visibleNotification

Defined in

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


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