GridJs的自定义下载功能

如何为GridJs实现自定义下载功能

GridJs提供了灵活的下载机制，可以让你自定义文件下载行为。你可以设置一个自定义的下载函数，根据你的需求处理文件下载。

设置自定义下载函数

GridJs 提供 setFileDownloadCallFunction 方法以设置自定义下载功能。当用户点击下载按钮时，将调用此函数并传递特定参数。

基本用法

// Define your custom download function
function customDownloadHandler(toFileName, outputType, saveMode) {
    console.log('File Name:', toFileName);
    console.log('Output Type:', outputType);
    console.log('Save Mode:', saveMode);

    // Implement your custom download logic here
    // For example: upload to cloud storage, save to custom location, etc.
}

// Set the custom download function
xs.setFileDownloadCallFunction(customDownloadHandler);

函数参数

自定义下载函数接收三个参数：

1. toFileName

  • 类型：字符串
  • 描述：要下载的文件名
  • 示例："myfile.xlsx"，"report.pdf"

2. outputType

  • 类型：字符串
  • 描述：输出文件的格式类型
  • 可能的值：
    • Original - 保持原始文件格式
    • XLSX - 以Excel格式导出
    • PDF - 以PDF格式导出
    • HTML - 以HTML格式导出

3. saveMode

  • 类型：字符串
  • 描述：保存目的地模式
  • 可能的值：
    • Device - 下载到本地设备（默认）
    • GoogleDrive - 保存到Google云端硬盘
    • Dropbox - 保存到Dropbox

下载场景

GridJs支持基于不同用户操作的多种下载场景：

1. 以不同格式下载

function customDownloadHandler(toFileName, outputType, saveMode) {
    switch(outputType) {
        case 'Original':
            // Handle original format download
            downloadAsOriginal(toFileName);
            break;
        case 'XLSX':
            // Handle Excel format download
            downloadAsExcel(toFileName);
            break;
        case 'PDF':
            // Handle PDF format download
            downloadAsPDF(toFileName);
            break;
        case 'HTML':
            // Handle HTML format download
            downloadAsHTML(toFileName);
            break;
    }
}

xs.setFileDownloadCallFunction(customDownloadHandler);

2. 保存到云存储

function customDownloadHandler(toFileName, outputType, saveMode) {
    if (saveMode === 'GoogleDrive') {
        // Implement Google Drive upload logic
        uploadToGoogleDrive(toFileName, outputType);
    } else if (saveMode === 'Dropbox') {
        // Implement Dropbox upload logic
        uploadToDropbox(toFileName, outputType);
    } else {
        // Default: download to device
        downloadToDevice(toFileName, outputType);
    }
}

xs.setFileDownloadCallFunction(customDownloadHandler);

备注

  1. 功能注册：确保在用户操作下载功能之前调用setFileDownloadCallFunction。

  2. 错误处理：在自定义下载函数中始终实现适当的错误处理，以向用户提供反馈。

  3. 异步操作：如果你的下载逻辑涉及异步操作（如API调用），确保正确处理Promise。

  4. 文件扩展名：当输出类型非“原始”时，文件扩展名会自动调整以匹配输出类型（例如.xlsx、.pdf、.html）。

  5. 默认行为：如果未设置自定义下载功能，GridJs将采用默认下载行为。

另请参阅

显示GridJs的公式说明