Excel chargeable plugin

This plugin can be used to import and export Excel software in .xlsx file format.

Changelog

v1.0.1

1.When exporting a node to Excel with mathematical formulas, only the formula source code is retained;

Charge

Please switch to the Chinese documentation for this plugin to view.

Register

1.Referencing packaged files:

import MindMap from 'simple-mind-map'
import Excel from 'excel.cjs.min.js'
// Or import Excel from 'excel.esm.min.js'
// If you want a package file in iife format, you can add the following in the build command of the package.json plugin: esbuild ./index.js --bundle --minify --external:buffer --format=iife --outfile=./dist/xxx.iife.min.js --global-name=xxx, Then execute npm run build again to generate

MindMap.usePlugin(Excel)

2.Referencing Unpackaged Source Code

You can first enter the plugin directory to execute:

npm link

Then enter your project root directory to execute:

npm link simple-mind-map-plugin-excel

Then you can directly import it for use:

import MindMap from 'simple-mind-map'
import Excel from 'simple-mind-map-plugin-excel'

MindMap.usePlugin(Excel)

Usage

Import .xlsx file

Keep only text, hyperlinks, and comments when importing.

To import .xlsx files, you need to use the plugin's 'excelTo' method, which can be obtained in the following ways.

1.Directly import file

import { excelTo } from 'simple-mind-map-plugin-excel/excelTo.js'

2.Through plugin class

import MindMap from 'simple-mind-map'
import Excel from 'simple-mind-map-plugin-excel'

Excel.excelTo

Usage example:

import Excel from 'simple-mind-map-plugin-excel'

const res = await Excel.excelTo(file)// File object, which is obtained through <input type="file">
const mindMap = new MindMap()
mindMap.setData(res)

Export as .xlsx file

Keep only text, hyperlinks, and notes when exporting. Merge cells for easy viewing.

After registering the plugin, you can directly call the 'export' method of the mind map instance to export:

mindMap.export('xlsx', true, 'Filename')

Of course, it also supports passing some parameters:

mindMap.export('xlsx', true, 'Filename', {
    maxColWidth: 30,// The maximum width of each column in the table is 30 by default, measured in characters
    transformNote: (note) => { return note }, // Convert node note data, as note data does not have any format restrictions, you may use markdown or HTML, so you can perform the conversion here and return the processed note string
    bookType: 'xlsx'// The exported file format defaults to xlsx. For other supported formats, please refer to: https://docs.sheetjs.com/docs/api/write-options#supported-output-formats。
})

In addition to using the mindMap.export method, you can also directly call the toExcel method of the plugin, which are also two methods to obtain:

1.Directly import file

import { toExcel } from 'simple-mind-map-plugin-excel/toExcel.js'

2.Through plugin class

import MindMap from 'simple-mind-map'
import Excel from 'simple-mind-map-plugin-excel'

Excel.toExcel

Usage example:

import MindMap from 'simple-mind-map'
import Excel from 'simple-mind-map-plugin-excel'

const mindMap = new MindMap()
const data = mindMap.getData()// Mind map data
const res = Excel.toExcel('Filename', data, opt)// The returned res is data in the format of an ArrayBuffer