图表JS对象弃用optionsUpdate函数,它容易引起API混淆,且已有更方便的processUpdateOptions配置选项替代方案

This commit is contained in:
datagear 2021-08-03 21:49:51 +08:00
parent 9478e632e4
commit efa72797c3
2 changed files with 21 additions and 17 deletions

View File

@ -744,20 +744,6 @@
this._options = options;
};
/**
* 获取/设置图表更新时的图表选项格式为 { ... }
* 当希望根据图表更新数据动态自定义图表选项时可以在图表监听器的onUpdate函数中调用此函数设置更新图表选项
*
* 图表渲染器实现相关
* 图表渲染器应使用此函数获取并应用更新图表选项在其update函数中另参考chart.inflateUpdateOptions()
*
* @param options 可选要设置的图表选项没有则执行获取操作
*/
chartBase.optionsUpdate = function(options)
{
return chartFactory.extValueBuiltin(this, "optionsUpdate", options);
};
/**
* 获取/设置图表主题格式参考org.datagear.analysis.ChartTheme
* 图表初始化时会使用图表元素的"dg-chart-theme"属性值执行设置操作
@ -2686,8 +2672,7 @@
/**
* 填充指定图表更新选项
*
* 此函数先将renderOptions中与updateOptions的同名项高优先级深度合并至updateOptions
* 然后将chart.optionsUpdate()高优先级深度合并至updateOptions然后调用可选的beforeProcessHandler
* 此函数先将renderOptions中与updateOptions的同名项高优先级深度合并至updateOptions然后调用可选的beforeProcessHandler
* 最后如果renderOptions中有定义processUpdateOptions函数格式为function(updateOptions, chart, results){ ... }则调用它
*
* 图表渲染器应该在其update()中使用此函数构建图表更新选项然后使用它执行图表更新逻辑以符合图表API规范
@ -2740,7 +2725,11 @@
for(var uop in updateOptions)
srcRenderOptions[uop] = renderOptions[uop];
// < @deprecated 兼容2.6.0版本的chart.optionsUpdate()
// 待chart.optionsUpdate()移除后应改为:
// $.extend(true, updateOptions, srcRenderOptions);
$.extend(true, updateOptions, srcRenderOptions, this.optionsUpdate());
// > @deprecated 兼容2.6.0版本的chart.optionsUpdate()
if(beforeProcessHandler != null)
beforeProcessHandler(updateOptions, this, results);
@ -2756,6 +2745,22 @@
// < 已弃用函数 start
//-------------
// < @deprecated 兼容2.6.0版本的API将在未来版本移除已被renderOptions.processUpdateOptions取代参考chart.inflateUpdateOptions()函数)
/**
* 获取/设置图表更新时的图表选项格式为 { ... }
* 当希望根据图表更新数据动态自定义图表选项时可以在图表监听器的onUpdate函数中调用此函数设置更新图表选项
*
* 图表渲染器实现相关
* 图表渲染器应使用此函数获取并应用更新图表选项在其update函数中另参考chart.inflateUpdateOptions()
*
* @param options 可选要设置的图表选项没有则执行获取操作
*/
chartBase.optionsUpdate = function(options)
{
return chartFactory.extValueBuiltin(this, "optionsUpdate", options);
};
// > @deprecated 兼容2.6.0版本的API将在未来版本移除已被renderOptions.processUpdateOptions取代参考chart.inflateUpdateOptions()函数)
// < @deprecated 兼容2.4.0版本的API将在未来版本移除已被chartBase.updateResults取代
/**
* 获取用于此次更新图表的结果数据没有则返回null

View File

@ -643,7 +643,6 @@ readonly 是否只读操作允许为null
{name: "chart.onMouseover", value: "onMouseover(", caption: "onMouseover() ", meta: "chart"},
{name: "chart.onMouseup", value: "onMouseup(", caption: "onMouseup() ", meta: "chart"},
{name: "chart.options", value: "options(", caption: "options() ", meta: "chart"},
{name: "chart.optionsUpdate", value: "optionsUpdate(", caption: "optionsUpdate() ", meta: "chart"},
{name: "chart.plugin", value: "plugin", caption: "plugin ", meta: "chart"},
{name: "chart.refreshData", value: "refreshData()", caption: "refreshData() ", meta: "chart"},
{name: "chart.render", value: "render()", caption: "render() ", meta: "chart"},