@univerjs/drawing v0.1.17 • Docs

Class: UnitDrawingService<T>

unitId -> subUnitId -> drawingId -> drawingParam

Extended by

DrawingManagerService

Type Parameters

Type Parameter
`T` extends `IDrawingParam`

Implements

IUnitDrawingService<T>

Constructors

new UnitDrawingService()

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

Returns

UnitDrawingService<T>

Properties

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

Implementation of

IUnitDrawingService.addNotification

Defined in

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

applyJson1()

applyJson1(
   unitId, 
   subUnitId, 
   jsonOp): void

Parameters

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

Returns

void

Implementation of

IUnitDrawingService.applyJson1

Defined in

packages/drawing/src/services/drawing-manager-impl.service.ts:383 (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

Parameter	Type
`insertParams`	`T`[]

Returns

void

Defined in

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

featurePluginGroupUpdateNotification()

featurePluginGroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginGroupUpdateNotification

Defined in

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

featurePluginOrderUpdateNotification()

featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void

Parameters

Parameter	Type
`drawingOrderUpdateParam`	`IDrawingOrderUpdateParam`

Returns

void

Implementation of

IUnitDrawingService.featurePluginOrderUpdateNotification

Defined in

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

featurePluginRemoveNotification()

featurePluginRemoveNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Defined in

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

featurePluginUngroupUpdateNotification()

featurePluginUngroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginUngroupUpdateNotification

Defined in

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

featurePluginUpdateNotification()

featurePluginUpdateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`T`[]

Returns

void

Implementation of

IUnitDrawingService.featurePluginUpdateNotification

Defined in

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

focusDrawing()

focusDrawing(params): void

Parameters

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

Returns

void

Implementation of

IUnitDrawingService.focusDrawing

Defined in

packages/drawing/src/services/drawing-manager-impl.service.ts:449 (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

Implementation of

IUnitDrawingService.getBackwardDrawingOp

Defined in

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

getBatchAddOp()

getBatchAddOp(insertParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`insertParams`	`T`[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchAddOp

Defined in

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

getBatchRemoveOp()

getBatchRemoveOp(removeParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchRemoveOp

Defined in

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

getBatchUpdateOp()

getBatchUpdateOp(updateParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`updateParams`	`T`[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getBatchUpdateOp

Defined in

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

getDrawingByParam()

getDrawingByParam(param): Nullable<T>

Parameters

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

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getDrawingByParam

Defined in

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

getDrawingData()

getDrawingData(unitId, subUnitId): IDrawingMapItemData<T>

Parameters

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

Returns

IDrawingMapItemData<T>

Implementation of

IUnitDrawingService.getDrawingData

Defined in

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

getDrawingDataForUnit()

getDrawingDataForUnit(unitId): IDrawingSubunitMap<T>

Parameters

Parameter	Type
`unitId`	`string`

Returns

IDrawingSubunitMap<T>

Implementation of

IUnitDrawingService.getDrawingDataForUnit

Defined in

packages/drawing/src/services/drawing-manager-impl.service.ts:141 (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:754 (opens in a new tab)

getDrawingOKey()

getDrawingOKey(oKey): Nullable<T>

Parameters

Parameter	Type
`oKey`	`string`

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getDrawingOKey

Defined in

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

getDrawingOrder()

getDrawingOrder(unitId, subUnitId): string[]

Parameters

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

Returns

string[]

Implementation of

IUnitDrawingService.getDrawingOrder

Defined in

packages/drawing/src/services/drawing-manager-impl.service.ts:483 (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:750 (opens in a new tab)

getDrawingsByGroup()

getDrawingsByGroup(groupParam): IDrawingParam[]

Parameters

Parameter	Type
`groupParam`	`IDrawingSearch`

Returns

IDrawingParam[]

Implementation of

IUnitDrawingService.getDrawingsByGroup

Defined in

packages/drawing/src/services/drawing-manager-impl.service.ts:310 (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:471 (opens in a new tab)

getForwardDrawingsOp()

getForwardDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getForwardDrawingsOp

Defined in

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

getFrontDrawingsOp()

getFrontDrawingsOp(orderParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getFrontDrawingsOp

Defined in

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

getGroupDrawingOp()

getGroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getGroupDrawingOp

Defined in

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

getOldDrawingByParam()

getOldDrawingByParam(param): Nullable<T>

Parameters

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

Returns

Nullable<T>

Implementation of

IUnitDrawingService.getOldDrawingByParam

Defined in

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

getUngroupDrawingOp()

getUngroupDrawingOp(groupParams): IDrawingJsonUndo1

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

IDrawingJsonUndo1

Implementation of

IUnitDrawingService.getUngroupDrawingOp

Defined in

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

groupUpdateNotification()

groupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Implementation of

IUnitDrawingService.groupUpdateNotification

Defined in

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

orderNotification()

orderNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Implementation of

IUnitDrawingService.orderNotification

Defined in

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

orderUpdateNotification()

orderUpdateNotification(orderParams): void

Parameters

Parameter	Type
`orderParams`	`IDrawingOrderMapParam`

Returns

void

Implementation of

IUnitDrawingService.orderUpdateNotification

Defined in

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

refreshTransform()

refreshTransform(updateParams): void

Parameters

Parameter	Type
`updateParams`	`T`[]

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

Parameter	Type
`refreshParams`	`T`[]

Returns

void

Implementation of

IUnitDrawingService.refreshTransformNotification

Defined in

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

registerDrawingData()

registerDrawingData(unitId, data): void

Parameters

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

Returns

void

Implementation of

IUnitDrawingService.registerDrawingData

Defined in

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

removeDrawingDataForUnit()

removeDrawingDataForUnit(unitId): void

Parameters

Parameter	Type
`unitId`	`string`

Returns

void

Implementation of

IUnitDrawingService.removeDrawingDataForUnit

Defined in

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

removeNotification()

removeNotification(removeParams): void

Parameters

Parameter	Type
`removeParams`	`IDrawingSearch`[]

Returns

void

Implementation of

IUnitDrawingService.removeNotification

Defined in

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

setDrawingEditable()

setDrawingEditable(editable): void

Parameters

Parameter	Type
`editable`	`boolean`

Returns

void

Implementation of

IUnitDrawingService.setDrawingEditable

Defined in

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

setDrawingVisible()

setDrawingVisible(visible): void

Parameters

Parameter	Type
`visible`	`boolean`

Returns

void

Implementation of

IUnitDrawingService.setDrawingVisible

Defined in

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

ungroupUpdateNotification()

ungroupUpdateNotification(groupParams): void

Parameters

Parameter	Type
`groupParams`	`IDrawingGroupUpdateParam`[]

Returns

void

Implementation of

IUnitDrawingService.ungroupUpdateNotification

Defined in

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

updateNotification()

updateNotification(updateParams): void

Parameters

Parameter	Type
`updateParams`	`IDrawingSearch`[]

Returns

void

Implementation of

IUnitDrawingService.updateNotification

Defined in

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

visibleNotification()

visibleNotification(visibleParams): void

Parameters

Parameter	Type
`visibleParams`	`IDrawingVisibleParam`[]

Returns

void

Implementation of

IUnitDrawingService.visibleNotification

Defined in

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

Imageioservice Univerdrawingplugin