圖表儀

圖表儀

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"}