@univerjs/docs-drawing v0.1.17 • Docs
Class: DocDrawingService
unitId -> subUnitId -> drawingId -> drawingParam
Extends
Constructors
new DocDrawingService()
new DocDrawingService(): DocDrawingService
Returns
Inherited from
UnitDrawingService
.constructor
Properties
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:258 (opens in a new tab)
applyJson1()
applyJson1(
unitId,
subUnitId,
jsonOp): void
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
jsonOp | JSONOp |
Returns
void
Inherited from
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:383 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Inherited from
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:420 (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:428 (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:416 (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:424 (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:432 (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:412 (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:449 (opens in a new tab)
getBackDrawingsOp()
getBackDrawingsOp(orderParams): IDrawingJsonUndo1
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
Inherited from
UnitDrawingService
.getBackDrawingsOp
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:567 (opens in a new tab)
getBackwardDrawingOp()
getBackwardDrawingOp(orderParams): IDrawingJsonUndo1
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
Inherited from
UnitDrawingService
.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 | IDocDrawing [] |
Returns
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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 | IDocDrawing [] |
Returns
Inherited from
UnitDrawingService
.getBatchUpdateOp
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:233 (opens in a new tab)
getDrawingByParam()
getDrawingByParam(param): Nullable<IDocDrawing>
Parameters
Parameter | Type |
---|---|
param | Nullable <IDrawingSearch > |
Returns
Inherited from
UnitDrawingService
.getDrawingByParam
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:436 (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:189 (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:141 (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:754 (opens in a new tab)
getDrawingOKey()
getDrawingOKey(oKey): Nullable<IDocDrawing>
Parameters
Parameter | Type |
---|---|
oKey | string |
Returns
Inherited from
UnitDrawingService
.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
[]
Inherited from
UnitDrawingService
.getDrawingOrder
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:483 (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:750 (opens in a new tab)
getDrawingsByGroup()
getDrawingsByGroup(groupParam): IDrawingParam[]
Parameters
Parameter | Type |
---|---|
groupParam | IDrawingSearch |
Returns
Inherited from
UnitDrawingService
.getDrawingsByGroup
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:310 (opens in a new tab)
getFocusDrawings()
getFocusDrawings(): IDocDrawing[]
Returns
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.getGroupDrawingOp
Defined in
packages/drawing/src/services/drawing-manager-impl.service.ts:282 (opens in a new tab)
getOldDrawingByParam()
getOldDrawingByParam(param): Nullable<IDocDrawing>
Parameters
Parameter | Type |
---|---|
param | Nullable <IDrawingSearch > |
Returns
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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
Inherited from
UnitDrawingService
.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 | 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:278 (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:170 (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:145 (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:254 (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:762 (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:758 (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:274 (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:262 (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)