面粉颜色

添加设置和逻辑, 以方便在模板中添加自定义颜色

安装

npm install @flourish/colors

单位测试

使用测试 :

npm run test

使用 :

npm run test test/name-of-test.test.mjs

基本用途

这个 settings.yml 文件应当导入到模板中 template.yml 文件,像这样 :

  - Colours
  - property: color
    import: "@flourish/colors"

你用得着 overrides 以控制是显示绝对还是数字颜色设置。 例子见下文。 替换 [dataset] 财务报告和审定财务报表 [binding] 附有相关数据集和约束名称的更多了解条件设置) (中文(简体) ).

  - Colours
  - property: color
    import: "@flourish/colors"
    overrides:
      - tag: discrete
        method: extend
        show_if:
          data.[dataset].[binding].type: string
      - tag: numeric
        method: extend
        show_if:
          data.[dataset].[binding].type: number

在模板状态下添加一个颜色对象 :

export var state = {
    color: {},
    ...
}

导入软件包像 import createColors from "@flourish/colors"

var colors = createColors(state.color) 创建新对象 colors。 。 。 .

您只需要在状态下通过, 颜色功能才能工作 .

方法

colors.getColor(value) 找到正确的颜色 value。将只返回倒计时值,除非更新的Color Scale方法在某个时候被调用.

colors.fallback([value]) 如果 value 未定义或(通常)设置为 value 如果定义并返回 colors 对象。 这个 value “ 默认” (重新) 设定倒计时值为无效的默认值 。 每逢 getColor 方法不能解释传入它的值(例如,当该值处于相继或相差模式时是非数字值).

colors.updateColorScale(domain) 基于 domain 阵列。 一般来说,域数组是尺度应该基于的一系列数据值. 对于一个绝对的尺度,这将是一系列的字符串。 对于数值(相继或相差的)比分,这将是一个数组(例如. [10, 50, 30, 20, 50, 10, 30, 60, 100, 90]) (中文(简体) ).