找回密码
 立即注册

QQ登录

只需一步,快速开始

Mr.Hu

金牌服务用户

33

主题

148

帖子

379

积分

金牌服务用户

积分
379

[已处理] 关于API文档

Mr.Hu
金牌服务用户   /  发表于:2024-9-19 08:24  /   查看:130  /  回复:3
   活字格平台的开放性特点,对我印象是比较深刻的,虽然说我们的方向是低代码趋势,尽量避免自己写代码,利用平台现有的功能进行开发和设计。但事物总是变化的,所谓计划赶不上变化就是这个道理,有时一些特殊场景,当平台现有功能满足不了需求的时候,就得自己动脑筋实现。这种场合就需要代码开发了。
    最近几天我仔细阅读了API文档里的javascript部分,里面有不少接口有具体使用示例的,这些比较容易理解,但不少API是没有示例的,这就给刚接触活字格API的开发人员造成了困惑,不知道如何调用这些资源。比如说,JavaScript API中的枚举部分enums章节(如下图所示),文档里写的,实在看不明白是如何调用的,也没有写跟哪些方法配合使用的。其他还有不少这样的情形。
    这里想问一下,我们活字格有没有关于API系统的带示例的API开发文档。以帮助我们刚接触活字格的人员快速熟悉活字格API开发。


本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x

3 个回复

倒序浏览
Simon.hu讲师达人认证 悬赏达人认证 活字格认证
超级版主   /  发表于:2024-9-19 16:16:51
沙发
这个问题问的比较高级,我给您详细讲解一下~


概念和定义解释
首先,这个API文档确实不咋地,先承认错误。
(我回去问问我们同事能不能修改,这个东西是一个工具生成出来的,因为这部分用的次数太少了所以一直没详细解释,如果好弄,我尽快给咱修整了)

先看这个说明

看了还不如不看,我直接教你终极方案吧
直接搞一个表格,运行起来,在浏览器的控制台输入手册中写的枚举

通过英文对上了,
0表示行头
1表示选择列
2表示真实的数据列
再从这个枚举的名字ListviewColumnType,经典的驼峰法命令,翻译过来指的是表格列类型;
仔细想想表格一共也就这3个类型的列,行头,选择列,数据列。他们分别对应0,1,2没毛病了

使用场景
知道了上面的内容,能干啥呢?
>>大部分情况下啥也没用,所以我们很多的人都不知道这个东西,看到了以后,就知道这个是一个枚举,返回给我的是0就是列头,返回的是1那就是选择列,返回给2那就是真实的数据。可是啥时候返回呢?或者我们在哪里能看到呢?
我给大家举个典型的例子,比如你要做一个表格选择项容器插件,你希望用户勾选了某一行了以后能按照用户设置的列的值给显示出来,这里的1,2其实指的是数据的第几列,比如下图中值索引是1,显示列索引是2,那就说,用户选择以后,在网页中显示的是第2个数据列【名称】,但是真正的值是第1个数据列【编码】

以上的需求看着很简单,但是写代码的时候,我们肯定需要把行头和选择列这2列去掉以后计算,怎么去掉呢?
获取表格中所有的列信息,然后逐一判断
获取表格中所有列信息就是这个接口:点击查看
还是直接在浏览器F12中查看

你会发现这个表格一共5列,(仔细看截图的右侧的最后一个属性值)
第1列:列类型 ColumnType: 0
第2列:列类型 ColumnType: 1
第3列:列类型 ColumnType: 2
第4列:列类型 ColumnType: 2
第5列:列类型 ColumnType: 2
此时我们就需要使用前面的枚举判断了

0表示行头
1表示选择列
2表示真实的数据列

所以,用户的值索引是第3列(第1个ColumnType=2的列),显示列索引是第4列(第2个ColumnType=2的列)

这个例子给你讲完以后,你应该理解这个是干啥的吧?好了,我要去给给我们同事说一下怎么优化这个说明文档去了

本帖子中包含更多资源

您需要 登录 才可以下载或查看,没有帐号?立即注册

x

评分

参与人数 2满意度 +10 收起 理由
妄想社成员 + 5
Mr.Hu + 5

查看全部评分

回复 使用道具 举报
Mr.Hu
金牌服务用户   /  发表于:2024-9-19 16:43:21
板凳
好的,胡总,非常感谢解答,思路理解了,一会我动手做一下。高手就是高手,风趣幽默中轻松把问题解决了。碰到细节问题有不懂的再请教。
回复 使用道具 举报
Simon.hu讲师达人认证 悬赏达人认证 活字格认证
超级版主   /  发表于:2024-9-19 16:48:48
地板
感谢支持~
回复 使用道具 举报
您需要登录后才可以回帖 登录 | 立即注册
返回顶部