@univerjs/docs-drawing v0.4.2 • 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$`	packages/drawing/src/services/drawing-manager-impl.service.ts:58 (opens in a new tab)
`drawingManagerData`	`public`	`IDrawingMap`<`IDocDrawing`>	`{}`	`UnitDrawingService`.`drawingManagerData`	packages/drawing/src/services/drawing-manager-impl.service.ts:48 (opens in a new tab)
`featurePluginAdd$`	`readonly`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`featurePluginAdd$`	packages/drawing/src/services/drawing-manager-impl.service.ts:88 (opens in a new tab)
`featurePluginGroupUpdate$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`featurePluginGroupUpdate$`	packages/drawing/src/services/drawing-manager-impl.service.ts:97 (opens in a new tab)
`featurePluginOrderUpdate$`	`readonly`	`Observable`<`IDrawingOrderUpdateParam`>	`undefined`	`UnitDrawingService`.`featurePluginOrderUpdate$`	packages/drawing/src/services/drawing-manager-impl.service.ts:94 (opens in a new tab)
`featurePluginRemove$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`featurePluginRemove$`	packages/drawing/src/services/drawing-manager-impl.service.ts:91 (opens in a new tab)
`featurePluginUngroupUpdate$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`featurePluginUngroupUpdate$`	packages/drawing/src/services/drawing-manager-impl.service.ts:100 (opens in a new tab)
`featurePluginUpdate$`	`readonly`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`featurePluginUpdate$`	packages/drawing/src/services/drawing-manager-impl.service.ts:85 (opens in a new tab)
`focus$`	`public`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`focus$`	packages/drawing/src/services/drawing-manager-impl.service.ts:82 (opens in a new tab)
`group$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`group$`	packages/drawing/src/services/drawing-manager-impl.service.ts:67 (opens in a new tab)
`order$`	`readonly`	`Observable`<`IDrawingOrderMapParam`>	`undefined`	`UnitDrawingService`.`order$`	packages/drawing/src/services/drawing-manager-impl.service.ts:64 (opens in a new tab)
`refreshTransform$`	`readonly`	`Observable`<`IDocDrawing`[]>	`undefined`	`UnitDrawingService`.`refreshTransform$`	packages/drawing/src/services/drawing-manager-impl.service.ts:73 (opens in a new tab)
`remove$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`remove$`	packages/drawing/src/services/drawing-manager-impl.service.ts:55 (opens in a new tab)
`ungroup$`	`readonly`	`Observable`<`IDrawingGroupUpdateParam`[]>	`undefined`	`UnitDrawingService`.`ungroup$`	packages/drawing/src/services/drawing-manager-impl.service.ts:70 (opens in a new tab)
`update$`	`readonly`	`Observable`<`IDrawingSearch`[]>	`undefined`	`UnitDrawingService`.`update$`	packages/drawing/src/services/drawing-manager-impl.service.ts:61 (opens in a new tab)
`visible$`	`readonly`	`Observable`<`IDrawingVisibleParam`[]>	`undefined`	`UnitDrawingService`.`visible$`	packages/drawing/src/services/drawing-manager-impl.service.ts:76 (opens in a new tab)

Methods

addNotification()

addNotification(insertParams): void

Parameters

Parameter	Type
`insertParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.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

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

Returns

void

Inherited from

UnitDrawingService.applyJson1

Defined in

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

dispose()

dispose(): void

Returns

void

Inherited from

UnitDrawingService.dispose

Defined in

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

featurePluginAddNotification()

featurePluginAddNotification(insertParams): void

Parameters

Parameter	Type
`insertParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginAddNotification

Defined in

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

featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginGroupUpdateNotification

Defined in

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

featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

Parameter	Type
`drawingOrderUpdateParam`	`IDrawingOrderUpdateParam`

Returns

void

Inherited from

UnitDrawingService.featurePluginOrderUpdateNotification

Defined in

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

featurePluginRemoveNotification()

featurePluginRemoveNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginRemoveNotification

Defined in

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

featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginUngroupUpdateNotification

Defined in

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

featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.featurePluginUpdateNotification

Defined in

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

focusDrawing()

focusDrawing(params): void

Parameters

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

Returns

void

Inherited from

UnitDrawingService.focusDrawing

Defined in

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

getBackDrawingsOp()

getBackDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

getBackwardDrawingOp()

getBackwardDrawingOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBackwardDrawingOp

Defined in

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

getBatchAddOp()

getBatchAddOp(insertParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`insertParams`	`IDocDrawing`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchAddOp

Defined in

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

getBatchRemoveOp()

getBatchRemoveOp(removeParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchRemoveOp

Defined in

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

getBatchUpdateOp()

getBatchUpdateOp(updateParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`updateParams`	`IDocDrawing`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getBatchUpdateOp

Defined in

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

getDrawingByParam()

getDrawingByParam(param): Nullable<IDocDrawing>

Parameters

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

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingByParam

Defined in

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

getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<IDocDrawing>

Parameters

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

Returns

IDrawingMapItemData<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingData

Defined in

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

getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<IDocDrawing>

Parameters

Parameter	Type
`unitId`	`string`

Returns

IDrawingSubunitMap<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingDataForUnit

Defined in

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

getDrawingEditable()

getDrawingEditable(): boolean

Returns

boolean

Inherited from

UnitDrawingService.getDrawingEditable

Defined in

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

getDrawingOKey()

getDrawingOKey(oKey): Nullable<IDocDrawing>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getDrawingOKey

Defined in

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

getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

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

Returns

string[]

Inherited from

UnitDrawingService.getDrawingOrder

Defined in

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

getDrawingVisible()

getDrawingVisible(): boolean

Returns

boolean

Inherited from

UnitDrawingService.getDrawingVisible

Defined in

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

getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

Parameter	Type
`groupParam`	`IDrawingSearch`

Returns

IDrawingParam[]

Inherited from

UnitDrawingService.getDrawingsByGroup

Defined in

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

getFocusDrawings()

getFocusDrawings(): IDocDrawing[]

Returns

IDocDrawing[]

Inherited from

UnitDrawingService.getFocusDrawings

Defined in

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

getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getForwardDrawingsOp

Defined in

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

getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getFrontDrawingsOp

Defined in

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

getGroupDrawingOp()

getGroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getGroupDrawingOp

Defined in

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

getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<IDocDrawing>

Parameters

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

Returns

Nullable<IDocDrawing>

Inherited from

UnitDrawingService.getOldDrawingByParam

Defined in

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

getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

IDrawingJsonUndo1

Inherited from

UnitDrawingService.getUngroupDrawingOp

Defined in

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

groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.groupUpdateNotification

Defined in

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

initializeNotification()

initializeNotification(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Inherited from

UnitDrawingService.initializeNotification

Defined in

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

orderNotification()

orderNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Inherited from

UnitDrawingService.orderNotification

Defined in

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

orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Inherited from

UnitDrawingService.orderUpdateNotification

Defined in

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

refreshTransform()

refreshTransform(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.refreshTransform

Defined in

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

refreshTransformNotification()

refreshTransformNotification(refreshParams): void

Parameters

Parameter	Type
`refreshParams`	`IDocDrawing`[]

Returns

void

Inherited from

UnitDrawingService.refreshTransformNotification

Defined in

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

registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

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

Returns

void

Inherited from

UnitDrawingService.registerDrawingData

Defined in

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

removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Inherited from

UnitDrawingService.removeDrawingDataForUnit

Defined in

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

removeNotification()

removeNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.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

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

Returns

void

Inherited from

UnitDrawingService.setDrawingData

Defined in

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

setDrawingEditable()

setDrawingEditable(editable): void

Parameters

Parameter	Type
`editable`	`boolean`

Returns

void

Inherited from

UnitDrawingService.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

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

Returns

void

Inherited from

UnitDrawingService.setDrawingOrder

Defined in

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

setDrawingVisible()

setDrawingVisible(visible): void

Parameters

Parameter	Type
`visible`	`boolean`

Returns

void

Inherited from

UnitDrawingService.setDrawingVisible

Defined in

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

ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Inherited from

UnitDrawingService.ungroupUpdateNotification

Defined in

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

updateNotification()

updateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDrawingSearch`[]

Returns

void

Inherited from

UnitDrawingService.updateNotification

Defined in

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

visibleNotification()

visibleNotification(visibleParams): void

Parameters

Parameter	Type
`visibleParams`	`IDrawingVisibleParam`[]

Returns

void

Inherited from

UnitDrawingService.visibleNotification

Defined in

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

Readme Univerdocsdrawingplugin