@univerjs/drawing v0.5.0-beta.1 • Docs
Class: UnitDrawingService<T>
unitId -> subUnitId -> drawingId -> drawingParam
Extended by
Type Parameters
Type Parameter |
---|
T extends IDrawingParam |
Implements
Constructors
new UnitDrawingService()
new UnitDrawingService<T>(): UnitDrawingService<T>
Returns
Properties
Property | Modifier | Type | Default value | Defined in |
---|---|---|---|---|
add$ | readonly | Observable <IDrawingSearch []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:58 |
drawingManagerData | public | IDrawingMap <T > | {} | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:48 |
featurePluginAdd$ | readonly | Observable <T []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:88 |
featurePluginGroupUpdate$ | readonly | Observable <IDrawingGroupUpdateParam []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:97 |
featurePluginOrderUpdate$ | readonly | Observable <IDrawingOrderUpdateParam > | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:94 |
featurePluginRemove$ | readonly | Observable <IDrawingSearch []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:91 |
featurePluginUngroupUpdate$ | readonly | Observable <IDrawingGroupUpdateParam []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:100 |
featurePluginUpdate$ | readonly | Observable <T []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:85 |
focus$ | public | Observable <T []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:82 |
group$ | readonly | Observable <IDrawingGroupUpdateParam []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:67 |
order$ | readonly | Observable <IDrawingOrderMapParam > | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:64 |
refreshTransform$ | readonly | Observable <T []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:73 |
remove$ | readonly | Observable <IDrawingSearch []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:55 |
ungroup$ | readonly | Observable <IDrawingGroupUpdateParam []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:70 |
update$ | readonly | Observable <IDrawingSearch []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:61 |
visible$ | readonly | Observable <IDrawingVisibleParam []> | undefined | submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:76 |
Methods
addNotification()
addNotification(insertParams): void
Parameters
Parameter | Type |
---|---|
insertParams | IDrawingSearch [] |
Returns
void
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.applyJson1
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:406
dispose()
dispose(): void
Returns
void
Implementation of
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:105
featurePluginAddNotification()
featurePluginAddNotification(insertParams): void
Parameters
Parameter | Type |
---|---|
insertParams | T [] |
Returns
void
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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
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
Implementation of
IUnitDrawingService
.featurePluginUngroupUpdateNotification
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:455
featurePluginUpdateNotification()
featurePluginUpdateNotification(updateParams): void
Parameters
Parameter | Type |
---|---|
updateParams | T [] |
Returns
void
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.getBackwardDrawingOp
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:545
getBatchAddOp()
getBatchAddOp(insertParams): IDrawingJsonUndo1
Parameters
Parameter | Type |
---|---|
insertParams | T [] |
Returns
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.getBatchRemoveOp
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:228
getBatchUpdateOp()
getBatchUpdateOp(updateParams): IDrawingJsonUndo1
Parameters
Parameter | Type |
---|---|
updateParams | T [] |
Returns
Implementation of
IUnitDrawingService
.getBatchUpdateOp
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:256
getDrawingByParam()
getDrawingByParam(param): Nullable<T>
Parameters
Parameter | Type |
---|---|
param | Nullable <IDrawingSearch > |
Returns
Nullable
<T
>
Implementation of
IUnitDrawingService
.getDrawingByParam
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:459
getDrawingData()
getDrawingData(unitId, subUnitId): IDrawingMapItemData<T>
Parameters
Parameter | Type |
---|---|
unitId | string |
subUnitId | string |
Returns
Implementation of
IUnitDrawingService
.getDrawingData
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:198
getDrawingDataForUnit()
getDrawingDataForUnit(unitId): IDrawingSubunitMap<T>
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Implementation of
IUnitDrawingService
.getDrawingDataForUnit
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:139
getDrawingEditable()
getDrawingEditable(): boolean
Returns
boolean
Implementation of
IUnitDrawingService
.getDrawingEditable
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:782
getDrawingOKey()
getDrawingOKey(oKey): Nullable<T>
Parameters
Parameter | Type |
---|---|
oKey | string |
Returns
Nullable
<T
>
Implementation of
IUnitDrawingService
.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
[]
Implementation of
IUnitDrawingService
.getDrawingOrder
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:506
getDrawingsByGroup()
getDrawingsByGroup(groupParam): IDrawingParam[]
Parameters
Parameter | Type |
---|---|
groupParam | IDrawingSearch |
Returns
Implementation of
IUnitDrawingService
.getDrawingsByGroup
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:333
getDrawingVisible()
getDrawingVisible(): boolean
Returns
boolean
Implementation of
IUnitDrawingService
.getDrawingVisible
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:778
getFocusDrawings()
getFocusDrawings(): T[]
Returns
T
[]
Implementation of
IUnitDrawingService
.getFocusDrawings
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:494
getForwardDrawingsOp()
getForwardDrawingsOp(orderParams): IDrawingJsonUndo1
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
Implementation of
IUnitDrawingService
.getForwardDrawingsOp
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:519
getFrontDrawingsOp()
getFrontDrawingsOp(orderParams): IDrawingJsonUndo1
Parameters
Parameter | Type |
---|---|
orderParams | IDrawingOrderMapParam |
Returns
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.getGroupDrawingOp
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:305
getOldDrawingByParam()
getOldDrawingByParam(param): Nullable<T>
Parameters
Parameter | Type |
---|---|
param | Nullable <IDrawingSearch > |
Returns
Nullable
<T
>
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.orderUpdateNotification
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:515
refreshTransform()
refreshTransform(updateParams): void
Parameters
Parameter | Type |
---|---|
updateParams | T [] |
Returns
void
Implementation of
IUnitDrawingService
.refreshTransform
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:124
refreshTransformNotification()
refreshTransformNotification(refreshParams): void
Parameters
Parameter | Type |
---|---|
refreshParams | T [] |
Returns
void
Implementation of
IUnitDrawingService
.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 <T > |
Returns
void
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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 <T > |
Returns
void
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.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
Implementation of
IUnitDrawingService
.visibleNotification
Defined in
submodules/univer/packages/drawing/src/services/drawing-manager-impl.service.ts:120