Home > SCH_ManufactureData > getExportDocumentFile

SCH_ManufactureData.getExportDocumentFile() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

获取导出文档文件

Signature

getExportDocumentFile(fileName?: string, fileType?: ESCH_ExportDocumentFileType, typeSpecificParams?: {
        theme?: 'Default' | 'White on Black' | 'Black on White';
        lineWidth?: 'Default' | 'Always 1px' | 'Follow the Zoom Change';
        displayAttributesAsMenu?: boolean;
        size?: 'Original Size' | string | {
            width: number;
            height: number;
            unit: ESYS_Unit.INCH | ESYS_Unit.MILLIMETER;
        };
    }, object?: 'All Schematic' | 'Current Schematic' | 'Current Schematic Page' | string, objectSpecificParams?: {
        range?: 'All' | [number, number];
        outputMethod?: 'Merged sheet' | 'Separated sheet';
    }): Promise<File | undefined>;

Parameters

Parameter	Type	Description
fileName	string	(Optional) 文件名
fileType	ESCH_ExportDocumentFileType	(Optional) 文件类型
typeSpecificParams	{ theme?: 'Default' | 'White on Black' | 'Black on White'; lineWidth?: 'Default' | 'Always 1px' | 'Follow the Zoom Change'; displayAttributesAsMenu?: boolean; size?: 'Original Size' | string | { width: number; height: number; unit: ESYS_Unit.INCH | ESYS_Unit.MILLIMETER; }; }	(Optional) 类型特定参数
object	'All Schematic' | 'Current Schematic' | 'Current Schematic Page' | string	(Optional) 对象
objectSpecificParams	{ range?: 'All' | [number, number]; outputMethod?: 'Merged sheet' | 'Separated sheet'; }	(Optional) 对象特定参数

Returns

Promise<File | undefined>

导出文档文件数据（或压缩包）

Remarks

可以使用 SYS_FileSystem.saveFile() 接口将文件导出到本地文件系统