Skip to content

Latest commit

 

History

History
94 lines (53 loc) · 3.39 KB

API.en.md

File metadata and controls

94 lines (53 loc) · 3.39 KB

配置属性

图表容器

markdown:docs/common/chart-options.en.md

数据映射

data 📌

必选, array object

功能描述: 设置图表数据源

默认配置: 无

数据源为对象集合,例如:[{ time: '1991',value: 20 }, { time: '1992',value: 20 }]

wordField

必选, string

功能描述: 单词内容在数据中所对应的字段名

默认配置: 无

weightField

必选, string

功能描述: 单词所占权重在数据中所对应的字段名

默认配置: 无

colorField

可选, string

功能描述: 根据该字段进行颜色映射

默认配置: 无

timeInterval

可选, number

功能描述: 设置绘制程序最大的执行时间,单位毫秒,如果时间设置过短可能会只绘制一部分词语

默认配置:2000

markdown:docs/common/meta.en.md

图形样式

imageMask

可选, HTMLImageElement | string

功能描述: 设置一张图片,然后图表就可以根据该图片的形状进行渲染,可以是图片元素实例或者 url 地址和 base64

注意: 词语只渲染在图片的深色部位,浅色的部位(如白色)不渲染词语。当使用图片的 url 地址时,图片的大小不宜过大,不然图片加载时间过长

默认配置: 无

wordStyle

可选, object

功能描述: 设置每个词语的样式

默认配置: 无

细分配置 类型 默认值 功能描述
fontFamily string | function 'Verdana' 词云的字体
fontWeight string | number | function 'normal' 设置字体的粗细
padding number | function 1 每个单词所占的盒子的内边距,默认为 1。 越大单词之间的间隔越大。
fontSize number[] | function [20, 60] 字体的大小范围,比如 [10, 20] 表示最小字体是 10,最大 20
rotation number[] [0, 90] 旋转的最小角度和最大角度 默认 [0, 90]
rotationSteps number 2 旋转实际的步数,越大可能旋转角度越小, 默认是 2
rotateRatio number 0.5 旋转的比率 [0, 1],默认是 0.5 也就是 50%可能发生旋转

以上,某些属性可以设置为一个函数,其函数的参数是一个object,其属性如下

细分配置 类型 功能描述
text string 文本内容
value number 该文本所占权重

markdown:docs/common/color.en.md

图表组件

markdown:docs/common/component.en.md