Custom Model
📊📝📽️ Univer General
Univer allows users to persist/load data from custom plugins along with the snapshot.
Create a CustomerService
In @univerjs/core, there is an instance of ResourceManagerService. You can register the corresponding hooks in your custom plugin and bind the data to snapshot.
import { IResourceManagerService, Inject, OnLifecycle, LifecycleStages } from '@univerjs/core';
import { UniverType } from '@univerjs/protocol';
const YOUR_PLUGIN_NAME = 'YOUR_PLUGIN_NAME';
interface IResource { testResource: string }
@OnLifecycle(LifecycleStages.Starting, CustomerService)
class CustomerService {
private _model:IResource = { testResource: '' };
constructor(
@Inject(IResourceManagerService) private _resourceManagerService: IResourceManagerService
) {
this._resourceManagerService.registerPluginResource<IResource>({
toJson: (unitID) => this._toJson(unitID),
parseJson: (json) => this._parseJson(json),
pluginName: 'SHEET_CustomerService_PLUGIN',
businesses: [UniverType.UNIVER_SHEET, UniverType.UNIVER_DOC, UniverType.UNIVER_SLIDE],
onLoad: (_unitId, resource) => {
this._model = resource;
},
onUnLoad: (_unitId) => {
this._model = { testResource: '' };
},
});
}
private _toJson(_unitID: string) {
const model = this._model;
return JSON.stringify(model);
}
private _parseJson(json: string) {
return JSON.parse(json);
}
}- The type of
IResourcecan be defined freely and supports any type. toJson/parseJsonare a pair of serialization functions forIResource, typically using JSON functions. You can also add specific logic for compression/obfuscation here.- Why does
toJsonfunction have the parameter unitID? This is because an instance ofUnivermay contain multiple instances of unit (such asSheet/Docand subsequentSlider). The same applies toonLoad/onUnLoad. - The
businessesoption is used to determine when to load this resources based on the business being loaded. For example, if you are loading data for aSheetmodule, there is no need to load it whenDocis being loaded
Inject CustomerPlugin
When your data has been connected to ResourceManagerService, inject your CustomerService into your own CustomerPlugin.
import { Plugin, Inject, Injector } from '@univerjs/core';
export class UniverSheetsPlugin extends Plugin {
constructor(
@Inject(Injector) override readonly _injector: Injector
) {
super();
this._injector.add([CustomerService]);
}
}Register the plugin in Univer
const univer = new Univer();
univer.registerPlugin(UniverSheetsPlugin);
// Performs additional initialization logicHow to obtain a snapshot containing the Resources?
There is a ResourceLoaderService instance in @univerjs/core, which you can use to save the latest snapshot information of a workbook or document using saveWorkbook or saveDoc. You can then use univer.createUnit to retrieve and display the data later.
The information of Resource is stored on snapshot.resources and can be obtained based on the corresponding pluginName.
import { IResourceLoaderService, IUniverInstanceService, Inject, LifecycleStages, OnLifecycle } from '@univerjs/core';
import { UniverType } from '@univerjs/protocol';
@OnLifecycle(LifecycleStages.Starting, CustomerService)
class CustomerService {
constructor(
@Inject(IResourceLoaderService) private _resourceLoaderService: IResourceLoaderService,
@Inject(IUniverInstanceService) private _univerInstanceService: IUniverInstanceService
) {
const workbook = this._univerInstanceService.getCurrentUnitForType(UniverType.UNIVER_SHEET)!
const snapshot = this._resourceLoaderService.saveWorkbook(workbook.getUnitId());
}
}