第1章 概述

SaCa DataViz提供了大量可配置项,让用户界面能够灵活定制,很好的适应复杂多变的场景和需求。

第2章 前端配置项说明

打开dataviz[-web]/common/config.js文件,会看到大量配置项,可通过文件内容搜索定位到特定项。

本章介绍位于setConfig()函数内datavizOption对象中的配置项。

2.1 菜单控制

./configuring_front-end/0

showHeader:是否显示DataViz的页面Header

./configuring_front-end/1

showAside:是否显示DataViz的左侧菜单

./configuring_front-end/2

showCooperation:是否显示公共项目选项

./configuring_front-end/3

showSample:是否显示示例菜单选项

./configuring_front-end/4

showFavorite: 是否显示我的收藏选项,注意只有在分享功能可用时这个选项才生效

./configuring_front-end/13

showSysSetting:是否显示系统设置选项

./configuring_front-end/5

showLicense:是否显示license菜单选项

./configuring_front-end/6

2.2 过滤条件相关

filterPosition:播放页面过滤条件显示位置,可选值:top、right

filterDefaultOpen:播放页面过滤条件区域是否默认展开

showFilterAll:是否显示过滤条件中的“显示全部”的设置选项

./configuring_front-end/14

dateConditionQuickSetting:是否开启时间过滤条件的快捷键设置功能

2.3.1 自定义配置

位于filterCondition属性中。

popWindowsCustom:是否启用自定义弹出窗口,用来自定义过滤条件的匹配值,目前只支持字符型过滤条件。 启用后,用户在定义过滤条件时,可以选择一个自定义弹窗与过滤条件关联,在设置过滤条件的匹配值时,从弹窗中选择。

./configuring_front-end/18

customWindows:自定义弹出窗口列表,供定义过滤条件时选择,每个弹窗又包括以下子属性:

  • name:弹出窗口的名称

  • popWindow:自定义函数,包含窗口弹出过程的实现逻辑。最后要调用程序传入的callback回调函数,完成过滤条件匹配值的设置。

    byCallback:请求数据时是否使用自定义函数

    getDateRange:获取日期类型过滤条件的日期范围的自定义函数

    getNumberRange:获取数值类型过滤条件的数值范围的自定义函数

    getStringValues:获取字符类型过滤条件的Distinct值的自定义函数

    getUTCDateString:返回系统当前时间的自定义函数

2.3 数据集相关

validateFieldFormula:在数据集中添加、编辑自定义字段时,是否校验自定义字段表达式

2.3.1 自定义配置

位于dataset属性中。

byCallback:请求数据时是否使用自定义函数

getDistinct:获取图表中某个字段的distinct值的自定义函数

save:保存数据集回调,保存至DataViz后台的同时,执行此回调函数

2.4 主题相关

位于theme属性中。

byCallback:请求或保存数据时是否使用自定义函数

get:获取主题信息

save:保存主题

delete:删除主题

2.5 菜单隐藏按钮

isShowMenuSetting:是否显示用于显示与隐藏左侧菜单的按钮。不同于菜单上方的折叠、展开按钮(三道杠),此按钮可以让菜单完全隐藏。

./configuring_front-end/7

2.6 图表相关

useLerpColors:当图表使用分类色且颜色数量不足时,是否使用插值取色生成足够颜色

defaultCharId:新建图表时,默认选中的图表类型

autoAxisLabelTilt:启用后,当轴上的标签文本发生重叠时,会自动倾斜显示

2.6.1 图表编辑页面配置

位于chartedit属性中。

categoryColorLimit:图表最大分类颜色数限制

2.6.1.1 数据集

对应dataset子属性。

showDatasetList:是否显示数据集列表页面,用于选择图表使用的数据集。如果此项禁用,则必须启用byCallback。

byCallback:请求数据时是否使用下面的自定义回调函数

get:获取数据集回调函数

update:更新数据集内容。主动调用update函数后,dataviz内部会再次调用上面的get函数。

save:保存数据集回调函数

2.6.1.2 图表数据

对应chartData子属性。

getChartDataByCallback:是否通过getBindData回调方法获取图表数据

getChartDrillDataByCallback:是否通过getDrillData回调方法获取图表钻透数据

getBindData:获取绑定数据,返回包含元数据的二维数组

getDrillData:主动推送绑定数据。若getChartDrillDataByCallback值为true,则通过该回调获取数据。

getMapBindData:获取地图数据

getGisBindData:获取地图数据,根据某一个时间起始点(某一帧)来获取数据

getGisTimelineBindData:获取地图数据,获取地图第一帧数据、经纬度范围、时间范围

getLightUpSegmentData:获取点亮地图数据,分段获取

getGroupData:获取分组中的数据

getGroupCounts:获取分组中每组记录数

getPageData:获取从某一索引开始的若干条记录的数据

getTotal:返回度量的总计

2.6.1.3 图表

对应chart子属性。

byCallback:获取或保存图表时是否使用自定义回调函数

get:获取图表实例

save:保存图表实例

2.6.1.4 数据绑定

maxFieldCount:可拖放到图表绑定区域的最大字段数限制,0表示不限制。可设置总数、维度数、度量数,须满足 维度数 + 度量数 <= 总数

byCallback:是否使用以下自定义回调函数

getAggregations:获取聚合方式列表

getAdvancedCals:获取高级计算列表

getCalculationFormula:返回所有公式及其相关信息

2.6.2 图表右键菜单项

以下配置均位于contextMenu属性中。

rollUp:是否开启上卷

./configuring_front-end/8

drillDown:是否开启下钻

./configuring_front-end/9

drillThrough:是否开启钻透功能

./configuring_front-end/10

支持自定义函数,返回true或false。详见《SaCa DataViz 二次开发说明文档》。

showData: 是否开启图表数据显示功能

./configuring_front-end/11

custom:用户自定义右键菜单项,数组类型,包含name及callback两项,分别为右键菜单的显示名称及单击时的执行函数。

./configuring_front-end/12

2.6.3 自定义鼠标事件

位于customMouseEvent属性中。null表示不启动,请使用数据形式进行自定义,放入当前功能项名称。

leftMouses:点击左键时执行的操作,如有多个,会弹出菜单以供进一步选择。

rightMouses:点击左键时执行的操作,如有多个,会弹出菜单以供进一步选择。

2.6.4 列表

位于list属性中。

paging.requestTotalCount:列表选择分页模式时,是否请求总记录数,禁用后无法预先确定总共有多少页。建议仅在查询请求耗时很长时禁用。

mergeColumnHeader:合并同一类的列头

mergeRowHeader:合并值相同的行头

changeColorEvenRow:是否隔行变色

showCellBorder:是否显示每个单元格的边框

2.6.5 数据透视表

位于pivot属性中。

alwaysShowDataField:只有一个度量时,是否仍然在表格中显示度量名称

2.6.6 gis地图配置

位于gis属性中。SaCa DataViz支持多种gis地图资源,使用前请进行必要的配置。例如很多地图资源需要先申请key才能使用。

2.6.7 自动生成图表

位于autochart属性中。

get:获取图表数据的回调函数。

2.7 图册相关

showExcelInChartBook:是否在图册编辑页、播放页显示导出图表数据的图标、菜单项

./configuring_front-end/17

hyperlinkAttachConditions:点击富文本中的超链接进行页面跳转时,是否附带图册条件

2.7.1 图册编辑页面配置

位于story属性中。

showChartLink:是否在图表属性页显示跳转地址

datasetBindMore:数据集关联字段是否可以设置多个

customPageRootUrl:自定义页面选择相对地址时的根路径

2.7.1.1 图册

对应story属性。

byCallback:是否通过以下回调函数操作图册信息

create:创建新图册

get:获取图册

save:保存图册

getChartList:获取图册中的图表列表

2.7.1.2 图表

对应chart属性。

byCallback:是否调用自定义回调函数

get:获取图表实例

2.7.1.3 数据集

对应dataset属性。

byCallback:是否调用自定义回调函数

get:获取数据集列表

2.7.1.4 仪表舱

对应dashboard属性。

maxWidth:使用固定分辨率时的最大宽度,单位px。

maxHeight:使用固定分辨率时的最大高度,单位px。

2.7.1.5 自由块

对应freeWidget属性。

minWidth:自由块最小宽度,单位px。

minHeight:自由块最小高度,单位px。

showBorder:是否默认显示自由块边框

2.8 播放设置

以下配置均位于play属性中。

showChartToolbar:图册播放页面是否显示图表工具栏(总开关)

./configuring_front-end/15

showSwitchChart:图册播放页面是否显示切换图表类型按钮

showExportData:图册播放页面是否显示单个图表导出数据按钮

showDataFieldBind:图册播放页面是否显示图表数据动态切换绑定的设置按钮

showFullScreen:图册播放页面是否显示单个图表的放大按钮

chartSwitchXYLegend:图册播放页面是否显示切换图表的分类轴和图例的按钮

showFunctionButton:是否显示右下角功能按钮(总开关),点击展开功能菜单

./configuring_front-end/16

showFavorite:是否显示收藏菜单项。注意:只有在分享功能可用,且在播放分享链接时才会显示此图标

showExportPdf:是否显示导出Pdf和导出图片菜单项

showToggleMode:是否显示切换显示模式菜单项

showNavigatorButtons: 是否显示图册页导航按钮

mobileLandscapePage:移动端横屏播放时是否一页一页滑动

2.9 登录相关

urlLogin:是否开启URL传参登录功能

sharePlayUrlLogin:是否开启播放分享链接的传参登录功能

keepalive:是否保持会话不超时。启用后会定时向后台服务发送心跳请求,以保持会话。

2.10 看板相关

keepOneBoardResourceInPage:[展示看板]页面只显示看板资源,不显示左侧资源树和导航栏。在当前用户有且仅有一个看板资源时生效。

2.10.1 Metro看板设置

位于showboardMetro属性中。

nav:导航按钮,可以用于在无鼠标的触屏设置上进行滚屏操作,一般情况下不需要使用。

2.11 项目相关

showSamplesInPrivates:是否在我的项目页面显示示例

2.11.1 项目资源页面配置

位于projectItems属性中。

showCreateDataButton:是否显示新建数据集按钮

showCreateChartButton:是否显示新建图表按钮

showCreateStoryButton:是否显示新建图册按钮

showThirdPartyResourceButton:是否显示导入第三方资源按钮

2.11.2 公共项目配置

位于publicProjects属性中。

showPrivateInPublic:是否显示不公开图表资源的设置属性

2.12 数据源相关

2.12.1 数据源页面配置

位于datasource属性中。

showAdd:是否显示新建数据源按钮

2.12.2 码表功能配置

bindCategoryNum:码值内容显示的最大条数。指的是数据集字段在绑定码表时,绑定类别列表的最大条数限制。

codeTableRest:图表码表值获取的默认开关。

2.13 分享相关

showInstationShare:是否显示站内分享(查看时需要登录)

2.14 扩展相关

addChartLists:图表扩展,comp_id不可重复,为避免重复,请从10000~20000号间选择添加

addCategoryLists:图表分类 分类id不可重复,为避免重复,请从100~200号间选择添加

geoCoordMap:扩展的地点经纬度坐标值,如 '北京': [116.4551, 40.2539]

regionCode:扩展的区域编码,如 "中国":"1", "北京":"11"

customCounty:是否开启自定义区县地图。启用后可以在地理地图中选择区县。

2.15 其他

title:应用名称,显示到浏览器标签页上的名称

isZeppelinDataRequest:是否开启zepplin数据请求

customSortForEdu:教育定制手动排序开关

closeShareFunction:是否隐藏资源分享按钮。注意:分享功能是否可用是由许可文件控制的,只有在分享功能可用时,这个配置才有意义。

userHelpDocument:是否显示用户帮助按钮

defaultHelpUrl:默认的用户帮助手册首页

usersPageCount:授权页面用户列表每页显示条数

datatablesPageCount:数据集页面左侧数据表列表每页显示条数

dataVizOrReportScheduler:调度功能在DataViz或Report中

showAds:是否显示左下角广告

第3章 其他属性说明

本章介绍config.js中定义的全局属性,和前一章中介绍的配置项不同,这些属性的值和服务部署相关,部署完成后一般不需要再更改。

charts_server:DataViz后台服务地址

report_server:报表后台服务地址

action_suffix:报表服务action路径后缀

zeppelin_server:Zeppelin后台服务地址

isCasLogin:是否显示为cas登录

cas_server:cas登陆地址

cas_callback_server:cas服务回调地址

casDefaultUrl:cas集成默认页面

isSaas:是否为线上云分析版本

showReport:是否为报表集成版本

isMultiTenant:是否为多租户环境

loginFreeMode:后台服务是否启用了免登录模式

results matching ""

    No results matching ""