docs: Update all files JSDoc.

This commit is contained in:
chiayin
2024-03-29 15:49:05 +08:00
parent 4ba71d1193
commit e391c9a237
55 changed files with 260 additions and 219 deletions

View File

@@ -176,7 +176,7 @@ export default {
methods: {
/**
* switch map type
* @param {string} type processMap | bpmn
* @param {string} type 'processMap' | 'bpmn',可傳入以上任一。
*/
switchMapType(type) {
this.mapType = type;
@@ -184,7 +184,7 @@ export default {
},
/**
* switch curve style
* @param {string} style 直角 unbundled-bezier | taxi
* @param {string} style 直角 'unbundled-bezier' | 'taxi',可傳入以上任一。
*/
switchCurveStyles(style) {
this.curveStyle = style;
@@ -192,7 +192,7 @@ export default {
},
/**
* switch rank
* @param {string} rank 直向 TB | 橫向 LR
* @param {string} rank 直向 'TB' | 橫向 'LR',可傳入以上任一。
*/
switchRank(rank) {
this.rank = rank;
@@ -200,8 +200,8 @@ export default {
},
/**
* switch Data Layoer Type or Option.
* @param {string} e
* @param {string} type freq | duration
* @param {string} option 下拉選單中的選項
*/
switchDataLayerType(type, option){
this.dataLayerType = type;
@@ -210,7 +210,7 @@ export default {
},
/**
* switch trace id and data
* @param {string} id
* @param {event} e input 傳入的事件
*/
async switchTraceId(e) {
if(e.id == this.traceId) return;
@@ -223,7 +223,7 @@ export default {
},
/**
* 將 element nodes 資料彙整
* @param {object} type processMapData | bpmnData
* @param {object} type 'processMapData' | 'bpmnData',可傳入以上任一。
*/
setNodesData(mapData) {
let mapType = this.mapType;
@@ -315,7 +315,7 @@ export default {
},
/**
* 將 element edges 資料彙整
* @param {object} type processMapData | bpmnData
* @param {object} type 'processMapData' | 'bpmnData',可傳入以上任一。
*/
setEdgesData(mapData) {
let mapType = this.mapType;
@@ -346,7 +346,7 @@ export default {
},
/**
* create cytoscape's map
* @param {string} type this.mapType processMap | bpmn
* @param {string} type this.mapType 'processMap' | 'bpmn',可傳入以上任一。
*/
createCy(type) {
let graphId = document.getElementById('cy');

View File

@@ -213,8 +213,8 @@ export default {
/**
* 建立折線圖
* @param { object } chartData chart data
* @param { object } content titels
* @param { string } yUnit y 軸單位 date | count
* @param { object } content titels 標題文字
* @param { string } yUnit y 軸單位 'date' | 'count'
*/
getLineChart(chartData, content, yUnit) {
let datasets;
@@ -357,7 +357,7 @@ export default {
/**
* 建立長條圖
* @param { object } chartData chart data
* @param { object } content titels
* @param { object } content titels 標題文字
*/
getBarChart(chartData, content) {
const maxX = chartData.x_axis.max;
@@ -471,9 +471,9 @@ export default {
/**
* 建立水平長條圖
* @param { object } chartData chart data
* @param { object } content titels
* @param { object } content titels 標題文字
* @param { boolean } isSingle 單個或雙數 activity
* @param { string } xUnit x 軸單位 date | count
* @param { string } xUnit x 軸單位 'date' | 'count',可傳入以上任一。
*/
getHorizontalBarChart(chartData, content, isSingle, xUnit) {
const maxY = chartData.y_axis.max;