echarts-tools Basic Guide

🚀 Quick Start

Environment Setup

1. Install Node.js 14.18+
   • Official Download
   • Verify installation:

     node -v  # Should display v14.18 or higher
     npm -v   # Should display 6.x+

Clone Project

git clone https://github.com/Geoffwo/echarts-tools.git
Or use China mirror:
git clone https://gitee.com/Geoffwo/echarts-tools.git
cd echarts-tools

Install Dependencies

npm install

Build Project

npm run build

After building, you'll get:

dist/
├── cjs/    # For Vue2 projects
└── iife/   # For direct HTML usage

📂 Directory Structure

echarts-tools/
├── dist/           # Build output (DO NOT modify manually)
├── src/            # Source code (unobfuscated)
├── page/           # Code examples
├── config/         # Build configurations
│   ├── esbuild.mjs          # ESBuild config
│   └── obfuscator.config.js # Obfuscation config
├── package.json    # Project config
├── README.md       # Documentation (English)
└── README-zh.md    # Documentation (Chinese)

🛠️ Usage

For Vue2 Projects

1. Install dependencies

   npm install echarts-tools echarts@5 --save

2. Component usage example:
   vue2Demo.vue

For HTML Direct Usage

Example:
htmlDemo.html

🔧 Common Commands

| Command | Description | |----------------------|----------------------------------| | npm install | Install development dependencies | | npm run build | Build production version (with obfuscation) | | npm run es5build | Build without obfuscation (for debugging) |

⚠️ Important Notes

1. echarts Peer Dependency
   This library requires echarts 5+:

   npm install echarts@5 --save

2. Code Protection
   Files in dist/ are obfuscated:

   • Use npm run es5build for unobfuscated debug builds
   • Obfuscation config: config/obfuscator.config.js

3. Browser Compatibility
   IIFE version requirements:

   <!-- Load echarts first -->
   <script src="echarts.min.js"></script>
   <!-- Then load this library -->
   <script src="echarts-tools.js"></script>

📜 View Documentation

Access API docs programmatically:

import { printDoc } from 'echarts-tools';
printDoc(); // Prints all available methods and configs

💖 Project Support

If this project helps you, consider supporting maintenance:

• 🚀 Any amount - General support

• ☕ 5 CNY - Buy me a coffee

• 📚 10 CNY - Documentation improvements

| Alipay | WeChat Pay | |----------------------------------|-------------------------------------| | | |

Donation Terms

1. All donations are voluntary gifts
2. No services or obligations are implied
3. No contractual relationship established
4. Minors must obtain guardian consent

Technical Support

Contact: [email protected]