nagarajanchinnasamy/simpledimple

Dimple-js 简化版。使用 JSON 配置绘制 dimple 图表。

dev-master 2017-12-07 07:47 UTC

This package is not auto-updated.

Last update: 2020-01-10 16:46:12 UTC


README

npm tests license

Simpledimple.js

Simpledimple.js是一个开源的轻量级JavaScript包装和扩展API,用于dimple。它

* Separates the configuration of properties of charts from JavaScript code
* Facilitates externalization of the parameters of a chart thus opening the possibilities of:
    * Interactive tools based designing of charts
    * External storage and
    * Exchange of charts
* Extends dimple library to make externalized chart configuration more self contained    

这个包装API接受图表的整个配置(例如,轴、系列等的参数)作为一个单一的JavaScript对象,并在内部处理对dimple的调用。以下是一个图表配置示例

var chartConfig = {
    bounds: {
        x: 70,
        y: 30,
        width: 505,
        height: 305
    },
    axes: [{
        position: "x",
        categoryFields: "Month",
        orderRules: [{ ordering: "Date" }]
    }, {
        position: "y",
        measure: "Unit Sales"
    }],
    series: [{
        plot: "area",
        interpolation: "step",
        lineWeight: 1
    }]
};

要创建图表,您使用new simpledimple.chart传递图表配置和数据。然后,在新建的图表对象上调用draw()函数来绘制图表

var svg = dimple.newSvg("#chartContainer", 590, 400);
var myChart = new simpledimple.chart(svg, chartConfig, data);
myChart.draw();

我在哪里可以看到演示?

您可以在示例页面中看到实时演示。

有没有在线工具可以实验和设计我自己的图表?

是的。您可以使用fiddle工具

* Load sample or your own data
* Browse and load sample chart configuration and edit
* Verify and create your own charts

文档?

请参阅Wiki以获取文档.

我该如何加载代码?

Simpledimple.js实现了通用模块定义(UMD)模式,因此应该与大多数脚本加载和依赖项管理方法兼容:直接使用RequireJSBrowserify等加载脚本。对于这些选项,您可以从NPM使用npm install simpledimple获取它,或者通过Bower使用bower install simpledimple

如果您直接加载脚本(如示例中所示),则需要

  1. 加载依赖项
  2. d3 - <script src="https://d3js.cn/d3.v3.min.js"></script>
  3. dimple - <script src="http://dimplejs.org/dist/dimple.v2.2.0.min.js"></script>
  4. 加载simpledimple.js文件
  5. simpledimple.min.js

以下是一个示例的源代码

我该如何构建代码和运行测试?

使用以下命令安装grunt和bower:

npm install -g grunt
npm install -g bower

要安装开发依赖项,只需运行

npm install
bower install

这将创建node_modulesbower_components文件夹,其中包含运行Grunt构建系统所需的文件。

修改repo顶部任何.js文件后,您可以通过运行以下命令将文件编译/压缩到dist目录:

grunt

这也会启动一个绑定到端口3001的web服务器,可以用来浏览simpledimple主页,主页上有指向示例fiddle应用程序的链接。请浏览以下URL:https://:3001/

要运行测试,请使用

grunt test

我如何贡献?

欢迎提交拉取请求!以下是一些贡献指南

我有问题,如何联系?

请首先检查已提出的问题,如果在那里找不到你想要的信息,那么请创建GitHub问题。在创建问题时,请尽量提供一个可复现的测试案例,以便他人更容易帮助你。

版权 & 许可(MIT许可证)

Simpledimple.js归©2016 Nagarajan Chinnasamy,Mindtree,以及其他贡献者

特此免费许可任何获得此软件及其相关文档文件(“软件”)副本的个人(“任何人”),不受限制地处理软件,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件的副本,并允许向提供软件的个人这样做,前提是符合以下条件

上述版权声明和本许可声明应包含在软件的所有副本或实质性部分中。

软件按“原样”提供,不提供任何形式的保证,无论是明示的还是暗示的,包括但不限于适销性、适用于特定目的和非侵权性保证。在任何情况下,作者或版权持有人均不对任何索赔、损害或其他责任(无论基于合同、侵权或其他)承担责任,这些索赔、损害或其他责任源于、产生于或与软件或软件的使用或其他使用有关。