amis2/docs/zh-CN/components/form/formula.md
sansiro 3071cce849
fix: quickEdit只读时,无法将value同步到数据域 (#6486)
* fix: quickEdit只读时,无法将value同步到数据域

* formula 文档错误修改
2023-03-29 12:06:04 +08:00

6.2 KiB
Executable File

title description type group menuName icon order
Formula 公式 0 null Formula 22

可以设置公式,将公式结果设置到指定表单项上。

该表单项是隐藏的

基本用法

{
  "type": "form",
  "body": [
  {
    "type": "input-number",
    "name": "a",
    "label": "A"
  },
  {
    "type": "input-number",
    "name": "b",
    "label": "B"
  },
  {
    "type": "input-number",
    "name": "sum",
    "label": "和",
    "disabled": true,
    "description": "自动计算 A + B"
  },
  {
    "type": "formula",
    "name": "sum",
    "value": 0,
    "formula": "a + b"
  }
]
}

自动应用

{
  "type": "form",
  "body": [
    {
        "type": "input-number",
        "name": "a",
        "label": "A"
    },
    {
        "type": "input-number",
        "name": "b",
        "label": "B"
    },
    {
        "type": "input-number",
        "name": "sum",
        "label": "和",
        "disabled": true,
        "description": "自动计算 A + B"
    },
    {
        "type": "formula",
        "name": "sum",
        "value": 0,
        "formula": "a + b"
    }
]
}

手动应用

配置"autoSet": false,然后按钮上配置target,配置值为formulaid值,就可以实现手动触发公式应用

{
  "type": "form",
  "body": [
    {
        "type": "input-number",
        "name": "a",
        "label": "A"
    },
    {
        "type": "input-number",
        "name": "b",
        "label": "B"
    },
    {
        "type": "group",
        "body": [
            {
                "type": "input-number",
                "name": "sum",
                "label": "和",
                "disabled": true,
                "columnClassName": "col-sm-11"
            },
            {
                "type": "button",
                "label": "计算",
                "columnClassName": "col-sm-1 v-bottom",
                "target": "theFormula"
            }
        ]
    },
    {
        "type": "formula",
        "name": "sum",
        "id": "theFormula",
        "value": 0,
        "formula": "a + b",
        "initSet": false,
        "autoSet": false
    }
]
}

为什么设置id而不是设置name?

因为name值已经用来设置目标变量名了,这个表单项肯定已经存在了,所以不是唯一了,不能够被按钮指定。

条件应用

可以配置condition用来指定作用条件,有两种写法:

  • 用 tpl 语法,把关联的字段写上如: ${xxx} ${yyy} 意思是当 xxx 和 yyy 的取值结果变化了就再应用一次公式结果。
  • 自己写判断如: this.xxx == "a" && this.xxx !== this.__prev.xxx 当 xxx 变化了,且新的值是字符 "a" 时应用,可以写更加复杂的判断。
{
  "type": "form",
  "body": [
    {
      "type": "radios",
      "name": "radios",
      "label": "radios",
      "options": [
        {
          "label": "a",
          "value": "a"
        },
        {
          "label": "b",
          "value": "b"
        }
      ],
      "description": "radios 变化会自动清空 B"
    },
    {
      "type": "input-text",
      "name": "b",
      "label": "B"
    },
    {
      "type": "formula",
      "name": "b",
      "value": "some string",
      "formula": "''",
      "condition": "${radios}",
      "initSet": false
    }
  ]
}

使用新表达式语法

1.5.0 及以上版本

通过新的表达式语法,可以调用其中的函数,比如

{
  "type": "form",
  "debug": true,
  "body": [
    {
      "type": "static",
      "value": "这个表单没有内容,通过上面的 debug 可以看到输出当前日期"
    },
    {
        "type": "formula",
        "name": "date",
        "formula": "${DATETOSTR(NOW(), 'YYYY-MM-DD')}"
    }
  ]
}

这种写法默认会解决浮点数计算问题(需要更新到 amis 1.6.4 及以上版本),比如

{
  "type": "form",
  "body": [
    {
      "type": "input-number",
      "name": "a",
      "value": 0.1,
      "label": "A"
    },
    {
      "type": "input-number",
      "name": "b",
      "value": 0.2,
      "label": "B"
    },
    {
      "type": "input-number",
      "name": "sum",
      "label": "直接相加",
      "disabled": true
    },
    {
      "type": "formula",
      "name": "sum",
      "formula": "a + b"
    },
    {
      "type": "input-number",
      "name": "sum-new",
      "label": "使用新表达式",
      "disabled": true
    },
    {
      "type": "formula",
      "name": "sum-new",
      "formula": "${a + b}"
    }
  ]
}

属性表

属性名 类型 默认值 说明
name string 需要应用的表单项name值,公式结果将作用到此处指定的变量中去。
formula 表达式 应用的公式
condition 表达式 公式作用条件
initSet boolean true 初始化时是否设置
autoSet boolean true 观察公式结果,如果计算结果有变化,则自动应用到变量上
id string 定义个名字,当某个按钮的目标指定为此值后,会触发一次公式应用。这个机制可以在 autoSet 为 false 时用来手动触发