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

Class: DocDrawingService

unitId -> subUnitId -> drawingId -> drawingParam

Extends

UnitDrawingService<IDocDrawing>

Constructors

new DocDrawingService()

new DocDrawingService(): DocDrawingService

Returns

DocDrawingService

Inherited from

UnitDrawingService.constructor

Properties

Property	Modifier	Type	Default value	Inherited from	Defined in
`add$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`add$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:58
`drawingManagerData`	`public`	`IDrawingMap`<`IDocDrawing`>	`{}`	`UnitDrawingService`.`drawingManagerData`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:48
`featurePluginAdd$`	`readonly`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`featurePluginAdd$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:88
`featurePluginGroupUpdate$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`featurePluginGroupUpdate$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:97
`featurePluginOrderUpdate$`	`readonly`	`Observable`<`IDrawingOrderUpdateParam`>	`undefined`	`UnitDrawingService`.`featurePluginOrderUpdate$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:94
`featurePluginRemove$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`featurePluginRemove$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:91
`featurePluginUngroupUpdate$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`featurePluginUngroupUpdate$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:100
`featurePluginUpdate$`	`readonly`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`featurePluginUpdate$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:85
`focus$`	`public`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`focus$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:82
`group$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`group$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:67
`order$`	`readonly`	`Observable`<`IDrawingOrderMapParam`>	`undefined`	`UnitDrawingService`.`order$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:64
`refreshTransform$`	`readonly`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`refreshTransform$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:73
`remove$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`remove$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:55
`ungroup$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`ungroup$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:70
`update$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`update$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:61
`visible$`	`readonly`	`Observable`<`IDrawingVisibleParam`[]>	`undefined`	`UnitDrawingService`.`visible$`	submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:76

Methods

addNotification()

addNotification(insertParams): void

Parameters

Parameter	Type
`insertParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.addNotification

Defined in

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

applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`jsonOp`	`JSONOp`

Returns

void

Inherited from

UnitDrawingService.applyJson1

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

UnitDrawingService.dispose

Defined in

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

featurePluginAddNotification()

featurePluginAddNotification(insertParams): void

Parameters

Parameter	Type
`insertParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginAddNotification

Defined in

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

featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginGroupUpdateNotification

Defined in

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

featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

Parameter	Type
`drawingOrderUpdateParam`	`IDrawingOrderUpdateParam`

Returns

void

Inherited from

UnitDrawingService.featurePluginOrderUpdateNotification

Defined in

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

featurePluginRemoveNotification()

featurePluginRemoveNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginRemoveNotification

Defined in

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

featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginUngroupUpdateNotification

Defined in

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

featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginUpdateNotification

Defined in

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

focusDrawing()

focusDrawing(params): void

Parameters

Parameter	Type
`params`	`Nullable`<`IDrawingSearch`[]>

Returns

void

Inherited from

UnitDrawingService.focusDrawing

Defined in

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

getBackDrawingsOp()

getBackDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBackDrawingsOp

Defined in

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

getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBackwardDrawingOp

Defined in

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

getBatchAddOp()

getBatchAddOp(insertParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`insertParams`	`IDocDrawing`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchAddOp

Defined in

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

getBatchRemoveOp()

getBatchRemoveOp(removeParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchRemoveOp

Defined in

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

getBatchUpdateOp()

getBatchUpdateOp(updateParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`updateParams`	`IDocDrawing`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchUpdateOp

Defined in

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

getDrawingByParam()

getDrawingByParam(param): Nullable<IDocDrawing>

Parameters

Parameter	Type
`param`	`Nullable`<`IDrawingSearch`>

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingByParam

Defined in

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

getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<IDocDrawing>

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

IDrawingMapItemData<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingData

Defined in

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

getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<IDocDrawing>

Parameters

Parameter	Type
`unitId`	`string`

Returns

IDrawingSubunitMap<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingDataForUnit

Defined in

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

getDrawingEditable()

getDrawingEditable(): boolean

Returns

boolean

Inherited from

UnitDrawingService.getDrawingEditable

Defined in

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

getDrawingOKey()

getDrawingOKey(oKey): Nullable<IDocDrawing>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingOKey

Defined in

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

getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`

Returns

string[]

Inherited from

UnitDrawingService.getDrawingOrder

Defined in

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

getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

Parameter	Type
`groupParam`	`IDrawingSearch`

Defined in

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

getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getFrontDrawingsOp

Defined in

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

getGroupDrawingOp()

getGroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getGroupDrawingOp

Defined in

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

getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<IDocDrawing>

Parameters

Parameter	Type
`param`	`Nullable`<`IDrawingSearch`>

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getOldDrawingByParam

Defined in

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

getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getUngroupDrawingOp

Defined in

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

groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.groupUpdateNotification

Defined in

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

initializeNotification()

initializeNotification(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Inherited from

UnitDrawingService.initializeNotification

Defined in

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

orderNotification()

orderNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Inherited from

UnitDrawingService.orderNotification

Defined in

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

orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Inherited from

UnitDrawingService.orderUpdateNotification

Defined in

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

refreshTransform()

refreshTransform(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.refreshTransform

Defined in

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

refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Parameters

Parameter	Type
`refreshParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.refreshTransformNotification

Defined in

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

registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

Parameter	Type
`unitId`	`string`
`data`	`IDrawingSubunitMap`<`IDocDrawing`>

Returns

void

Inherited from

UnitDrawingService.registerDrawingData

Defined in

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

removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Inherited from

UnitDrawingService.removeDrawingDataForUnit

Defined in

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

removeNotification()

removeNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.removeNotification

Defined in

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

setDrawingData()

setDrawingData(
   unitId, 
   subUnitId, 
   data): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`data`	`IDrawingMapItemData`<`IDocDrawing`>

Returns

void

Inherited from

UnitDrawingService.setDrawingData

Defined in

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

setDrawingEditable()

setDrawingEditable(editable): void

Parameters

Parameter	Type
`editable`	`boolean`

Returns

void

Inherited from

UnitDrawingService.setDrawingEditable

Defined in

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

setDrawingOrder()

setDrawingOrder(
   unitId, 
   subUnitId, 
   order): void

Parameters

Parameter	Type
`unitId`	`string`
`subUnitId`	`string`
`order`	`string`[]

Returns

void

Inherited from

UnitDrawingService.setDrawingOrder

Defined in

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

setDrawingVisible()

setDrawingVisible(visible): void

Parameters

Parameter	Type
`visible`	`boolean`

Returns

void

Inherited from

UnitDrawingService.setDrawingVisible

Defined in

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

ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.ungroupUpdateNotification

Defined in

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

updateNotification()

updateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.updateNotification

Defined in

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

visibleNotification()

visibleNotification(visibleParams): void

Parameters

Parameter	Type
`visibleParams`	`IDrawingVisibleParam`[]

Returns

void

Inherited from

UnitDrawingService.visibleNotification

Defined in

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

Readme Univerdocsdrawingplugin