CamanJS 技术文档

1. 安装指南

CamanJS 可以通过 npm 在 NodeJS 环境中安装，使用以下命令：

npm install caman

如果你需要在浏览器中使用 CamanJS，你可以从 CamanJS 的官方网站或者 CDN JS 下载最新版本的 CamanJS 文件，并将其包含到你的项目中。

2. 项目使用说明

CamanJS 提供了一个简单易用的接口来实现 HTML5 canvas 和 JavaScript 的图像处理功能。以下是一个简单的使用示例：

在浏览器中使用

首先，在 HTML 文件中包含 CamanJS 的脚本文件：

<script src="path/to/caman.js"></script>

然后，可以使用以下方式对图像进行编辑：

Caman("#image-id", function () {
  this.brightness(10);
  this.contrast(20);
  this.render(function () {
    alert("完成！");
  });
});

你也可以通过 data-caman HTML 属性来修改图像：

<img data-caman="饱和度(-10) 亮度(20) 虚化('10%')" src="path/to/image.jpg">

在 NodeJS 中使用

在 NodeJS 环境中，你可以使用以下方式来加载和处理图像：

const Caman = require('caman').Caman;

Caman("./path/to/file.jpg", function () {
  this.brightness(40);
  this.render(function () {
    this.save("./output.png");
  });
});

确保在 NodeJS 中调用 save() 方法是在 render() 方法完成后。

3. 项目API使用文档

CamanJS API 允许你对图像进行多种操作，如调整亮度、对比度、饱和度等。以下是一些基本的 API 调用示例：

• brightness(value)：调整图像亮度。
• contrast(value)：调整图像对比度。
• saturation(value)：调整图像饱和度。
• render(callback)：应用所有更改并执行回调函数。
• save(path)：在 NodeJS 中保存修改后的图像。

更多 API 文档和示例，请参考 CamanJS 官方网站。

4. 项目安装方式

如前所述，CamanJS 可以通过 npm 在 NodeJS 环境中安装，也可以直接下载脚本文件用于浏览器。以下是具体步骤：

NodeJS 安装

使用 npm 命令：

npm install caman

浏览器安装

从 CamanJS 官方网站或 CDN JS 下载 CamanJS 脚本文件，并将其引入到你的 HTML 文件中。

请遵循以上指南来安装和使用 CamanJS，以便充分利用其图像处理功能。