图表仪

图表仪

Charticulator 是一种新的图表工具，允许您通过交互式指定约束来设计图表。

项目团队

• 任东浩
• 李奉信
• 马修·布雷默
• 内森埃文斯
• 凯特·利特维涅茨
• 大卫·蒂茨沃斯
• 克里斯·特维诺

建造

按照以下步骤准备开发环境：

• 安装nodejs 8.0+：https://nodejs.org/
• 安装yarnjs 1.7+：https://yarnpkg.com/

安装节点模块：

yarn

复制模板配置文件并编辑其内容：

cp config.template.yml config.yml
# (on windows, use copy instead of cp)

运行以下命令来构建 Charticulator，这将在dist文件夹中创建一个独立的包：

yarn build

运行本地 Web 服务器来测试 Charticulator：

 # Serve Charticulator at http://localhost:4000
yarn server

# Serve Charticulator publicly at http://0.0.0.0:4000
# Use this if you want to enable access from another computer
yarn public_server

发展

对于实时开发环境，请保持以下命令运行：

yarn start

此命令监视src/和sass/中的任何更改，并自动重新编译 Charticulator。一旦完成，打开 http://localhost:4000/ 以启动 Charticulator。现在，当您更改源代码时，只需刷新浏览器页面即可更新应用程序（您可能需要禁用浏览器缓存）。

在开发模式下，有一个UI组件的测试应用程序，可以通过http://localhost:4000/test.html访问。

当您更改以下内容时，手表模式不会更新：

• 配置.yml
• THIRD_PARTY.yml
• webpack.config.js

当您更新这些时，请再次执行yarn build 。

样本数据集

您可以添加可与 Charticulator 一起使用的自定义示例数据集。为此，请在存储库的根目录创建一个datasets文件夹（如果不存在），将.csv （或.tsv ）添加到该文件夹​​，最后使用以下内容在该文件夹中创建一个files.json文件内容：

", "description": "", "tables": [ { "name": "", "type": "", "url": "" } ] } ]">

 [
    {
        "name": "",
        "description": "",
        "tables": [
            {
                "name": "",
                "type": "",
                "url": ""
            }
        ]
    }
]

测试

图表器当前包含一个基本的测试代码：

yarn test

需要更多的测试用例。

贡献

该项目欢迎贡献和建议。大多数贡献都要求您同意贡献者许可协议 (CLA)，声明您有权并且实际上授予我们使用您的贡献的权利。有关详细信息，请访问 https://cla.microsoft.com。

当您提交拉取请求时，CLA-bot 将自动确定您是否需要提供 CLA 并适当地装饰 PR（例如标签、评论）。只需按照机器人提供的说明进行操作即可。您只需使用我们的 CLA 在所有存储库中执行一次此操作。

该项目采用了微软开源行为准则。有关详细信息，请参阅行为准则常见问题解答或联系 [email protected] 提出任何其他问题或意见。

文档

运行yarn typedoc来生成文档页面。该页面将在./docs/charticulator中提供

文档的起点是索引页 {@link "index"}