@univerjs/drawing v0.4.2 • Docs
Interface: IUnitDrawingService<T>
Extends
IUnitNormalDrawingService
<T
>.IUnitFocusDrawingService
.IUnitGroupDrawingService
.IUnitOrderDrawingService
.IDisposable
Extended by
Type Parameters
Type Parameter |
---|
T extends IDrawingParam |
Properties
Methods
addNotification()
addNotification(insertParams): void
Parameters
Parameter | Type |
---|---|
insertParams | IDrawingSearch [] |
Returns
void
Inherited from
IUnitNormalDrawingService.addNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:117 (opens in a new tab)
applyJson1()
applyJson1(
unitId,
subUnitId,
jsonOp): void
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
jsonOp | unknown |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:198 (opens in a new tab)
dispose()
dispose(): void
Returns
void
Overrides
Defined in
packages/drawing/src/services/drawing-manager.service.ts:185 (opens in a new tab)
featurePluginGroupUpdateNotification()
featurePluginGroupUpdateNotification(groupParams): void
Parameters
Parameter | Type |
---|---|
groupParams | IDrawingGroupUpdateParam [] |
Returns
void
Inherited from
IUnitGroupDrawingService.featurePluginGroupUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:156 (opens in a new tab)
featurePluginOrderUpdateNotification()
featurePluginOrderUpdateNotification(drawingOrderUpdateParam): void
Parameters
Parameter | Type |
---|---|
drawingOrderUpdateParam | IDrawingOrderUpdateParam |
Returns
void
Inherited from
IUnitOrderDrawingService.featurePluginOrderUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:179 (opens in a new tab)
featurePluginUngroupUpdateNotification()
featurePluginUngroupUpdateNotification(groupParams): void
Parameters
Parameter | Type |
---|---|
groupParams | IDrawingGroupUpdateParam [] |
Returns
void
Inherited from
IUnitGroupDrawingService.featurePluginUngroupUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:157 (opens in a new tab)
featurePluginUpdateNotification()
featurePluginUpdateNotification(updateParams): void
Parameters
Parameter | Type |
---|---|
updateParams | T [] |
Returns
void
Inherited from
IUnitNormalDrawingService.featurePluginUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:127 (opens in a new tab)
focusDrawing()
focusDrawing(params): void
Parameters
Parameter | Type |
---|---|
params | Nullable <IDrawingSearch []> |
Returns
void
Inherited from
IUnitFocusDrawingService.focusDrawing
Defined in
packages/drawing/src/services/drawing-manager.service.ts:136 (opens in a new tab)
getBackDrawingsOp()
getBackDrawingsOp(orderParams): unknown
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
unknown
Inherited from
IUnitOrderDrawingService.getBackDrawingsOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:174 (opens in a new tab)
getBackwardDrawingOp()
getBackwardDrawingOp(orderParams): unknown
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
unknown
Inherited from
IUnitOrderDrawingService.getBackwardDrawingOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:172 (opens in a new tab)
getBatchAddOp()
getBatchAddOp(insertParams): unknown
Parameters
Parameter | Type |
---|---|
insertParams | T [] |
Returns
unknown
Inherited from
IUnitNormalDrawingService.getBatchAddOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:123 (opens in a new tab)
getBatchRemoveOp()
getBatchRemoveOp(removeParams): unknown
Parameters
Parameter | Type |
---|---|
removeParams | IDrawingSearch [] |
Returns
unknown
Inherited from
IUnitNormalDrawingService.getBatchRemoveOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:124 (opens in a new tab)
getBatchUpdateOp()
getBatchUpdateOp(updateParams): unknown
Parameters
Parameter | Type |
---|---|
updateParams | T [] |
Returns
unknown
Inherited from
IUnitNormalDrawingService.getBatchUpdateOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:125 (opens in a new tab)
getDrawingByParam()
getDrawingByParam(param): Nullable<T>
Parameters
Parameter | Type |
---|---|
param | Nullable <IDrawingSearch > |
Returns
Nullable
<T
>
Defined in
packages/drawing/src/services/drawing-manager.service.ts:195 (opens in a new tab)
getDrawingData()
getDrawingData(unitId, subUnitId): IDrawingMapItemData<T>
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
Returns
Defined in
packages/drawing/src/services/drawing-manager.service.ts:193 (opens in a new tab)
getDrawingDataForUnit()
getDrawingDataForUnit(unitId): IDrawingSubunitMap<T>
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Defined in
packages/drawing/src/services/drawing-manager.service.ts:187 (opens in a new tab)
getDrawingEditable()
getDrawingEditable(): boolean
Returns
boolean
Defined in
packages/drawing/src/services/drawing-manager.service.ts:199 (opens in a new tab)
getDrawingOKey()
getDrawingOKey(oKey): Nullable<T>
Parameters
Parameter | Type |
---|---|
oKey | string |
Returns
Nullable
<T
>
Defined in
packages/drawing/src/services/drawing-manager.service.ts:197 (opens in a new tab)
getDrawingOrder()
getDrawingOrder(unitId, subUnitId): string[]
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
Returns
string
[]
Inherited from
IUnitOrderDrawingService.getDrawingOrder
Defined in
packages/drawing/src/services/drawing-manager.service.ts:176 (opens in a new tab)
getDrawingVisible()
getDrawingVisible(): boolean
Returns
boolean
Defined in
packages/drawing/src/services/drawing-manager.service.ts:200 (opens in a new tab)
getDrawingsByGroup()
getDrawingsByGroup(groupParam): IDrawingParam[]
Parameters
Parameter | Type |
---|---|
groupParam | IDrawingSearch |
Returns
Inherited from
IUnitGroupDrawingService.getDrawingsByGroup
Defined in
packages/drawing/src/services/drawing-manager.service.ts:154 (opens in a new tab)
getFocusDrawings()
getFocusDrawings(): IDrawingParam[]
Returns
Inherited from
IUnitFocusDrawingService.getFocusDrawings
Defined in
packages/drawing/src/services/drawing-manager.service.ts:137 (opens in a new tab)
getForwardDrawingsOp()
getForwardDrawingsOp(orderParams): unknown
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
unknown
Inherited from
IUnitOrderDrawingService.getForwardDrawingsOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:171 (opens in a new tab)
getFrontDrawingsOp()
getFrontDrawingsOp(orderParams): unknown
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
unknown
Inherited from
IUnitOrderDrawingService.getFrontDrawingsOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:173 (opens in a new tab)
getGroupDrawingOp()
getGroupDrawingOp(groupParams): unknown
Parameters
Parameter | Type |
---|---|
groupParams | IDrawingGroupUpdateParam [] |
Returns
unknown
Inherited from
IUnitGroupDrawingService.getGroupDrawingOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:150 (opens in a new tab)
getOldDrawingByParam()
getOldDrawingByParam(param): Nullable<T>
Parameters
Parameter | Type |
---|---|
param | Nullable <IDrawingSearch > |
Returns
Nullable
<T
>
Defined in
packages/drawing/src/services/drawing-manager.service.ts:196 (opens in a new tab)
getUngroupDrawingOp()
getUngroupDrawingOp(groupParams): unknown
Parameters
Parameter | Type |
---|---|
groupParams | IDrawingGroupUpdateParam [] |
Returns
unknown
Inherited from
IUnitGroupDrawingService.getUngroupDrawingOp
Defined in
packages/drawing/src/services/drawing-manager.service.ts:151 (opens in a new tab)
groupUpdateNotification()
groupUpdateNotification(groupParams): void
Parameters
Parameter | Type |
---|---|
groupParams | IDrawingGroupUpdateParam [] |
Returns
void
Inherited from
IUnitGroupDrawingService.groupUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:152 (opens in a new tab)
initializeNotification()
initializeNotification(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:191 (opens in a new tab)
orderNotification()
orderNotification(orderParams): void
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
void
Inherited from
IUnitOrderDrawingService.orderNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:169 (opens in a new tab)
orderUpdateNotification()
orderUpdateNotification(orderParams): void
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
void
Inherited from
IUnitOrderDrawingService.orderUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:178 (opens in a new tab)
refreshTransform()
refreshTransform(updateParams): void
Parameters
Parameter | Type |
---|---|
updateParams | T [] |
Returns
void
Inherited from
IUnitNormalDrawingService.refreshTransform
Defined in
packages/drawing/src/services/drawing-manager.service.ts:114 (opens in a new tab)
refreshTransformNotification()
refreshTransformNotification(refreshParams): void
Parameters
Parameter | Type |
---|---|
refreshParams | T [] |
Returns
void
Inherited from
IUnitNormalDrawingService.refreshTransformNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:120 (opens in a new tab)
registerDrawingData()
registerDrawingData(unitId, data): void
Parameters
Parameter | Type |
---|---|
unitId | string |
data | IDrawingSubunitMap <T > |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:189 (opens in a new tab)
removeDrawingDataForUnit()
removeDrawingDataForUnit(unitId): void
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:188 (opens in a new tab)
removeNotification()
removeNotification(removeParams): void
Parameters
Parameter | Type |
---|---|
removeParams | IDrawingSearch [] |
Returns
void
Inherited from
IUnitNormalDrawingService.removeNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:116 (opens in a new tab)
setDrawingData()
setDrawingData(
unitId,
subUnitId,
data): void
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
data | IDrawingMapItemData <T > |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:194 (opens in a new tab)
setDrawingEditable()
setDrawingEditable(editable): void
Parameters
Parameter | Type |
---|---|
editable | boolean |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:202 (opens in a new tab)
setDrawingOrder()
setDrawingOrder(
unitId,
subUnitId,
order): void
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
order | string [] |
Returns
void
Inherited from
IUnitOrderDrawingService.setDrawingOrder
Defined in
packages/drawing/src/services/drawing-manager.service.ts:177 (opens in a new tab)
setDrawingVisible()
setDrawingVisible(visible): void
Parameters
Parameter | Type |
---|---|
visible | boolean |
Returns
void
Defined in
packages/drawing/src/services/drawing-manager.service.ts:201 (opens in a new tab)
ungroupUpdateNotification()
ungroupUpdateNotification(groupParams): void
Parameters
Parameter | Type |
---|---|
groupParams | IDrawingGroupUpdateParam [] |
Returns
void
Inherited from
IUnitGroupDrawingService.ungroupUpdateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:153 (opens in a new tab)
updateNotification()
updateNotification(updateParams): void
Parameters
Parameter | Type |
---|---|
updateParams | IDrawingSearch [] |
Returns
void
Inherited from
IUnitNormalDrawingService.updateNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:118 (opens in a new tab)
visibleNotification()
visibleNotification(visibleParams): void
Parameters
Parameter | Type |
---|---|
visibleParams | IDrawingVisibleParam [] |
Returns
void
Inherited from
IUnitNormalDrawingService.visibleNotification
Defined in
packages/drawing/src/services/drawing-manager.service.ts:121 (opens in a new tab)