@univerjs-pro/exchange-client v0.5.4
Class: ExchangeService
Defined in: packages/exchange-client/src/services/exchange.service.ts:83
Extends
Implements
Constructors
new ExchangeService()
new ExchangeService(_configService, _requestService): ExchangeService
Defined in: packages/exchange-client/src/services/exchange.service.ts:88
Parameters
Parameter | Type |
---|---|
_configService | IConfigService |
_requestService | RequestService |
Returns
Overrides
Properties
Property | Modifier | Type | Default value | Inherited from | Defined in |
---|---|---|---|---|---|
_disposed | protected | boolean | false | Disposable ._disposed | submodules/univer/packages/core/src/shared/lifecycle.ts:96 |
requestState$ | readonly | Observable <IRequestState > | undefined | - | packages/exchange-client/src/services/exchange.service.ts:86 |
Methods
dispose()
dispose(): void
Defined in: packages/exchange-client/src/services/exchange.service.ts:95
Returns
void
Implementation of
Overrides
disposeWithMe()
disposeWithMe(disposable): IDisposable
Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:99
Parameters
Parameter | Type |
---|---|
disposable | DisposableLike |
Returns
Inherited from
ensureNotDisposed()
protected ensureNotDisposed(): void
Defined in: submodules/univer/packages/core/src/shared/lifecycle.ts:103
Returns
void
Inherited from
exportDOCXBySnapshot()
exportDOCXBySnapshot(snapshot): Promise<undefined | File>
Defined in: packages/exchange-client/src/services/exchange.service.ts:116
Export DOCX file by document data
Parameters
Parameter | Type |
---|---|
snapshot | IDocumentData |
Returns
Promise
<undefined
| File
>
Implementation of
IExchangeService
.exportDOCXBySnapshot
exportDOCXByUnitId()
exportDOCXByUnitId(unitId): Promise<undefined | File>
Defined in: packages/exchange-client/src/services/exchange.service.ts:112
Export DOCX file by unit id
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Promise
<undefined
| File
>
Implementation of
IExchangeService
.exportDOCXByUnitId
exportXLSXBySnapshot()
exportXLSXBySnapshot(data): Promise<undefined | File>
Defined in: packages/exchange-client/src/services/exchange.service.ts:147
Export XLSX file by workbook data
Parameters
Parameter | Type |
---|---|
data | IWorkbookData |
Returns
Promise
<undefined
| File
>
Implementation of
IExchangeService
.exportXLSXBySnapshot
exportXLSXByUnitId()
exportXLSXByUnitId(unitId): Promise<undefined | File>
Defined in: packages/exchange-client/src/services/exchange.service.ts:143
Export XLSX file by unit id
Parameters
Parameter | Type |
---|---|
unitId | string |
Returns
Promise
<undefined
| File
>
Implementation of
IExchangeService
.exportXLSXByUnitId
importDOCXToSnapshot()
importDOCXToSnapshot(file): Promise<
| undefined
| IDocumentData>
Defined in: packages/exchange-client/src/services/exchange.service.ts:100
Import DOCX file to document data
Parameters
Parameter | Type |
---|---|
file | string | File |
Returns
Promise
<
| undefined
| IDocumentData
>
Implementation of
IExchangeService
.importDOCXToSnapshot
importFileToUnitId()
importFileToUnitId(file, univerType): Promise<undefined | string>
Defined in: packages/exchange-client/src/services/exchange.service.ts:152
Import file to unit id
Parameters
Parameter | Type |
---|---|
file | string | File |
univerType | UniverType |
Returns
Promise
<undefined
| string
>
Implementation of
IExchangeService
.importFileToUnitId
importXLSXToSnapshot()
importXLSXToSnapshot(file): Promise<
| undefined
| IWorkbookData>
Defined in: packages/exchange-client/src/services/exchange.service.ts:120
Import XLSX file to workbook data
Parameters
Parameter | Type |
---|---|
file | string | File |
Returns
Promise
<
| undefined
| IWorkbookData
>