@univerjsdrawingclassesUnitdrawingservice

@univerjs/drawing v0.5.0-beta.1 • Docs


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[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:58
drawingManagerDatapublicIDrawingMap<T>{}submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:48
featurePluginAdd$readonlyObservable<T[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:88
featurePluginGroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:97
featurePluginOrderUpdate$readonlyObservable<IDrawingOrderUpdateParam>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:94
featurePluginRemove$readonlyObservable<IDrawingSearch[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:91
featurePluginUngroupUpdate$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:100
featurePluginUpdate$readonlyObservable<T[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:85
focus$publicObservable<T[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:82
group$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:67
order$readonlyObservable<IDrawingOrderMapParam>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:64
refreshTransform$readonlyObservable<T[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:73
remove$readonlyObservable<IDrawingSearch[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:55
ungroup$readonlyObservable<IDrawingGroupUpdateParam[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:70
update$readonlyObservable<IDrawingSearch[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:61
visible$readonlyObservable<IDrawingVisibleParam[]>undefinedsubmodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:76

Methods

addNotification()

addNotification(insertParams): void

Parameters

ParameterType
insertParamsIDrawingSearch[]

Returns

void

Implementation of

IUnitDrawingService.addNotification

Defined in

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


applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
jsonOpJSONOp

Returns

void

Implementation of

IUnitDrawingService.applyJson1

Defined in

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


dispose()

dispose(): void

Returns

void

Implementation of

IUnitDrawingService.dispose

Defined in

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


featurePluginAddNotification()

featurePluginAddNotification(insertParams): void

Parameters

ParameterType
insertParamsT[]

Returns

void

Defined in

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


featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginGroupUpdateNotification

Defined in

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


featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

ParameterType
drawingOrderUpdateParamIDrawingOrderUpdateParam

Returns

void

Implementation of

IUnitDrawingService.featurePluginOrderUpdateNotification

Defined in

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


featurePluginRemoveNotification()

featurePluginRemoveNotification(removeParams): void

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Defined in

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


featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginUngroupUpdateNotification

Defined in

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


featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

ParameterType
updateParamsT[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginUpdateNotification

Defined in

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


focusDrawing()

focusDrawing(params): void

Parameters

ParameterType
paramsNullable<IDrawingSearch[]>

Returns

void

Implementation of

IUnitDrawingService.focusDrawing

Defined in

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


getBackDrawingsOp()

getBackDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBackDrawingsOp

Defined in

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


getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBackwardDrawingOp

Defined in

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


getBatchAddOp()

getBatchAddOp(insertParams): IDrawingJsonUndo1

Parameters

ParameterType
insertParamsT[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchAddOp

Defined in

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


getBatchRemoveOp()

getBatchRemoveOp(removeParams): IDrawingJsonUndo1

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchRemoveOp

Defined in

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


getBatchUpdateOp()

getBatchUpdateOp(updateParams): IDrawingJsonUndo1

Parameters

ParameterType
updateParamsT[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchUpdateOp

Defined in

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


getDrawingByParam()

getDrawingByParam(param): Nullable<T>

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getDrawingByParam

Defined in

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


getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<T>

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

IDrawingMapItemData<T>

Implementation of

IUnitDrawingService.getDrawingData

Defined in

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


getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<T>

Parameters

ParameterType
unitIdstring

Returns

IDrawingSubunitMap<T>

Implementation of

IUnitDrawingService.getDrawingDataForUnit

Defined in

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


getDrawingEditable()

getDrawingEditable(): boolean

Returns

boolean

Implementation of

IUnitDrawingService.getDrawingEditable

Defined in

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


getDrawingOKey()

getDrawingOKey(oKey): Nullable<T>

Parameters

ParameterType
oKeystring

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getDrawingOKey

Defined in

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


getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

ParameterType
unitIdstring
subUnitIdstring

Returns

string[]

Implementation of

IUnitDrawingService.getDrawingOrder

Defined in

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


getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

ParameterType
groupParamIDrawingSearch

Returns

IDrawingParam[]

Implementation of

IUnitDrawingService.getDrawingsByGroup

Defined in

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


getDrawingVisible()

getDrawingVisible(): boolean

Returns

boolean

Implementation of

IUnitDrawingService.getDrawingVisible

Defined in

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


getFocusDrawings()

getFocusDrawings(): T[]

Returns

T[]

Implementation of

IUnitDrawingService.getFocusDrawings

Defined in

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


getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getForwardDrawingsOp

Defined in

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


getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getFrontDrawingsOp

Defined in

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


getGroupDrawingOp()

getGroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getGroupDrawingOp

Defined in

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


getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<T>

Parameters

ParameterType
paramNullable<IDrawingSearch>

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getOldDrawingByParam

Defined in

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


getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getUngroupDrawingOp

Defined in

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


groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.groupUpdateNotification

Defined in

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


initializeNotification()

initializeNotification(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IUnitDrawingService.initializeNotification

Defined in

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


orderNotification()

orderNotification(orderParams): void

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Implementation of

IUnitDrawingService.orderNotification

Defined in

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


orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

ParameterType
orderParamsIDrawingOrderMapParam

Returns

void

Implementation of

IUnitDrawingService.orderUpdateNotification

Defined in

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


refreshTransform()

refreshTransform(updateParams): void

Parameters

ParameterType
updateParamsT[]

Returns

void

Implementation of

IUnitDrawingService.refreshTransform

Defined in

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


refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Parameters

ParameterType
refreshParamsT[]

Returns

void

Implementation of

IUnitDrawingService.refreshTransformNotification

Defined in

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


registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

ParameterType
unitIdstring
dataIDrawingSubunitMap<T>

Returns

void

Implementation of

IUnitDrawingService.registerDrawingData

Defined in

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


removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

ParameterType
unitIdstring

Returns

void

Implementation of

IUnitDrawingService.removeDrawingDataForUnit

Defined in

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


removeNotification()

removeNotification(removeParams): void

Parameters

ParameterType
removeParamsIDrawingSearch[]

Returns

void

Implementation of

IUnitDrawingService.removeNotification

Defined in

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


setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
dataIDrawingMapItemData<T>

Returns

void

Implementation of

IUnitDrawingService.setDrawingData

Defined in

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


setDrawingEditable()

setDrawingEditable(editable): void

Parameters

ParameterType
editableboolean

Returns

void

Implementation of

IUnitDrawingService.setDrawingEditable

Defined in

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


setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

Parameters

ParameterType
unitIdstring
subUnitIdstring
orderstring[]

Returns

void

Implementation of

IUnitDrawingService.setDrawingOrder

Defined in

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


setDrawingVisible()

setDrawingVisible(visible): void

Parameters

ParameterType
visibleboolean

Returns

void

Implementation of

IUnitDrawingService.setDrawingVisible

Defined in

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


ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

ParameterType
groupParamsIDrawingGroupUpdateParam[]

Returns

void

Implementation of

IUnitDrawingService.ungroupUpdateNotification

Defined in

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


updateNotification()

updateNotification(updateParams): void

Parameters

ParameterType
updateParamsIDrawingSearch[]

Returns

void

Implementation of

IUnitDrawingService.updateNotification

Defined in

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


visibleNotification()

visibleNotification(visibleParams): void

Parameters

ParameterType
visibleParamsIDrawingVisibleParam[]

Returns

void

Implementation of

IUnitDrawingService.visibleNotification

Defined in

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