0.0.8 • Published 8 months ago

@gingkoo/pandora-metrics v0.0.8

Weekly downloads
-
License
ISC
Repository
-
Last release
8 months ago

Metrics 组件

Metrics 组件是一个功能强大的 React 组件,用于管理指标、公式及相关数据。它提供了一个结构化的接口,用于处理加载状态、树形结构、公式操作以及用户交互。

Props

Metrics 组件支持以下属性:

属性名类型描述
loadingboolean(可选)表示组件是否处于加载状态。
saveLoadingboolean (可选)表示保存操作是否正在进行中。
valueFormulaItem[]公式项的默认值。
treeTitlestring (可选)指标树左侧标题。
resultStatusResultStatus (可选)结果状态,由 ResultStatus 枚举定义。
treeStatusTreeStatus (可选)指标树的状态,由 TreeStatus 枚举定义。
formulaDataFormulaGroup[] (可选)可供选择或操作的公式列表。
calcDataany[] (可选)试运算结果数据。
treeDataobject[] (可选)表示指标树结构的数据。
showCalcboolean (可选)是否显示试运算部分。
onReloadTreeData() => void (可选)刷新指标树数据的回调函数。
onSave(data?: any) => void (可选)保存数据时触发的回调函数。
onCalc(data?: any) => void (可选)执行试运算时触发的回调函数。
onChange(data?: FormulaItem[]) => void (可选)公式项变化时触发的回调函数。
toolbarArray<'save' \| 'del' \| 'formula'>\|false (可选)工具栏配置,支持传入一个数组,定义需要显示的操作按钮(如 ['save', 'del', 'formula'])。
expandedAllboolean (可选)是否展开全部
expandedKeysstring[] (可选)展开对应树id

枚举

ResultStatus

ResultStatus 枚举定义了结果的可能状态:

描述
FIRST_OPEN表示组件首次打开。
LOADING表示结果正在加载中。
NO_DATA表示没有可用数据。
SUCCESS表示操作成功。
ERROR表示发生错误。

TreeStatus

TreeStatus 枚举定义了指标树的可能状态:

描述
LOADING表示树数据正在加载中。
NO_DATA表示没有树数据可用。
NO_SEARCH表示未找到搜索结果。
SUCCESS表示树数据加载成功。

接口

FormulaItem

FormulaItem 接口表示单个公式项:

属性名类型描述
typeFormulaItemType公式项的类型。
textstring公式项的文本内容。
idstring (可选)id
placeholderstring (可选)占位符文本(仅当 type = FormulaItemType.INDEX 时存在)。

FormulaGroup

{
	type:string,//公式类型
	data:[]	//公式数据
}

FormulaGroup.data 公式数据

属性名类型描述
typeFormulaItemType公式项的类型。
labelstring公式项的文本内容。
formulastring[] (可选)公式数组,公式由多个符号组成
descstring (可选)公式描述
placeholderstring[] (可选)公式占位符对应formula中Input

通过以上文档,您可以快速了解 Metrics 组件的功能及其使用方法。