color-data-picker

1.1.4 • Public • Published

Abstract

A JavaScript Lib which can get color data of one picture in certain area.

todo

  • get certain rectangle area data of picture
  • supportES6syntax
  • add test case
  • supporttypescript
  • get any kind of area data

how to use

This is how we use this lib now.

const cdp = require('color-data-picker').getImageData;
 
cdp.getImageData(url, {
    success(data){
        //process(data);
    },
});

API

getImageData function need two key param:urlandconfig.

  • url: string;

  • config: Object;

This is typescript definition.

interface ConfigType{
    success: (data: number[]) => void;
    fail: (msg: string) => void;
    x?: number;
    y?: number;
    spanX?: numbr;
    spanY?: numbr;
    scale?: numbr | (realWidth?: number, realHeight?: number) => number;
}
name meaning type default
x x spot of beginning number 0
y y spot of beginning number 0
spanX horizonal span number realWidth * scale or realWidth * scale()
spanY vertiacl span number realHeight * scale or realHeight * scale()
scale scale function hook number 或者 (realWidth: number) => number 1
success success callback (msg: string) => {} () => {}
fail fail callback (msg: string) => {} () => {}

Certificate

ISC

概述

用来实现获取图片特定区域的颜色数据。

要做

  • 获取选择矩形区域的颜色值。
  • 支持ES6语法
  • 增加测试用例
  • 增加类型定义或者迁移TypeScript
  • 获取任意选择的不规则区域颜色值

使用

当前使用方法:

const cdp = require('color-data-picker').getImageData;
 
cdp.getImageData(url, {
    success(data){
        //process(data);
    },
});

API

getImageData 接受两个参数urlconfig

  • url: string;

  • config: Object;

interface ConfigType{
    success: (data: number[]) => void;
    fail: (msg: string) => void;
    x?: number;
    y?: number;
    spanX?: numbr;
    spanY?: numbr;
    scale?: numbr | (realWidth?: number, realHeight?: number) => number;
}
name meaning type default
x 起始点横坐标 number 0
y 起始点纵坐标 number 0
spanX 横向跨度 number realWidth * scale 或者 realWidth * scale()
spanY 纵向跨度 number realHeight * scale 或者 realHeight * scale()
scale scale设置钩子 number 或者 (realWidth: number) => number 1
success 成功回调 (msg: string) => {} () => {}
fail 失败回调 (msg: string) => {} () => {}

证书

ISC

Readme

Keywords

Package Sidebar

Install

npm i color-data-picker

Weekly Downloads

1

Version

1.1.4

License

ISC

Unpacked Size

6.5 kB

Total Files

4

Last publish

Collaborators

  • zskixx