imacat/lucia-frontend
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

docs: Update all files JSDoc.

Browse Source
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
Download Patch File Download Diff File Expand all files Collapse all files

12
src/components/Discover/Conformance/ConformanceResults.vue
View File

@@ -284,7 +284,7 @@ export default {
methods: {
/**
* set progress bar width
* @param {number} value
* @param {number} value 百分比數字
* @returns {string} 樣式的寬度設定
*/
progressWidth(value){
@@ -292,7 +292,7 @@ export default {
},
/**
* Number to percentage
* @param {number} val
* @param {number} val 原始數字
* @returns {string} 轉換完成的百分比字串
*/
getPercentLabel(val){
@@ -301,7 +301,7 @@ export default {
},
/**
* Convert seconds to days
* @param {number} sec
* @param {number} sec 秒數
* @returns {number} day
*/
convertSecToDay(sec) {
@@ -309,7 +309,7 @@ export default {
},
/**
* Open Issues Modal.
* @param {number} no trace no
* @param {number} no trace 編號
*/
async openMore(no) {
// async await 解決非同步資料延遲傳遞導致未讀取到而出錯的問題
@@ -321,7 +321,7 @@ export default {
},
/**
* Open Loop Modal.
* @param {number} no trace no
* @param {number} no trace 編號
*/
async openLoopMore(no) {
// async await 解決非同步資料延遲傳遞導致未讀取到而出錯的問題
@@ -333,7 +333,7 @@ export default {
},
/**
* set conformance report data
* @param {object} data new watch's value
* @param {object} data new watch's value 監聽到後端傳來的報告 data
*/
setConformanceTempReportData(data){
let total = getNumberLabel(Object.values(data.counts).reduce((acc, val) => acc + val, 0));

7
src/components/Discover/Conformance/ConformanceSidebar.vue
View File

@@ -691,14 +691,14 @@ export default {
methods: {
/**
* get min total seconds
* @param {Number} e
* @param {Number} e 最小值總秒數
*/
minTotalSeconds(e) {
this.selectTimeRangeMin = e;
},
/**
* get min total seconds
* @param {Number} e
* @param {Number} e 最大值總秒數
*/
maxTotalSeconds(e) {
this.selectTimeRangeMax = e;
@@ -784,7 +784,7 @@ export default {
this.isSubmitTimeCfmCtEteSE = { base: {}, rule: {}};
},
/**
* @param {boolean} massage true | false 清空選單選項, 選擇的結果
* 清空選單的行為
*/
reset() {
// Results page Cover Plate(遮罩為 ture)
@@ -825,7 +825,6 @@ export default {
isEndSelected: true
};
}
},
/**
* Apply button 發送選項，取得 Check Id.

3
src/components/Discover/Conformance/ConformanceSidebar/ActList.vue
View File

@@ -32,6 +32,9 @@ export default {
}
},
methods: {
/**
* 將選取的 Activities 傳出去
*/
actListData() {
this.$emitter.emit('actListData', this.actList);
}

3
src/components/Discover/Conformance/ConformanceSidebar/ActRadio.vue
View File

@@ -33,6 +33,9 @@ export default {
},
},
methods: {
/**
* 將選取的 Activity 傳出去
*/
actRadioData() {
this.localSelect = null;
this.$emitter.emit('actRadioData', {

1
src/components/Discover/Conformance/ConformanceSidebar/ActSeqDrag.vue
View File

@@ -40,7 +40,6 @@
</div>
</div>
</div>
</template>
<script>
import { sortNumEngZhtw } from '@/module/sortNumEngZhtw.js';

15
src/components/Discover/Conformance/ConformanceSidebar/ConformanceRadioGroup.vue
View File

@@ -99,6 +99,9 @@ export default {
}
},
methods: {
/**
* 切換 Rule Type 的選項時的行為
*/
changeRadio() {
this.selectedActivitySequence = 'Start & End';
this.selectedMode = 'Directly follows';
@@ -107,15 +110,27 @@ export default {
this.selectedActSeqFromTo = 'From';
this.$emitter.emit('isRadioChange', true); // Radio 切換時，資料要清空
},
/**
* 切換 Activity sequence 的選項時的行為
*/
changeRadioSeq() {
this.$emitter.emit('isRadioSeqChange',true);
},
/**
* 切換 Processing time 的選項時的行為
*/
changeRadioProcessScope() {
this.$emitter.emit('isRadioProcessScopeChange', true);
},
/**
* 切換 Process Scope 的選項時的行為
*/
changeRadioActSeqMore() {
this.$emitter.emit('isRadioActSeqMoreChange', true);
},
/**
* 切換 Activity Sequence 的選項時的行為
*/
changeRadioActSeqFromTo() {
this.$emitter.emit('isRadioActSeqFromToChange', true);
},

22
src/components/Discover/Conformance/ConformanceSidebar/ConformanceSelectResult.vue
View File

@@ -143,28 +143,6 @@ export default {
},
},
methods: {
/**
* set Time Result Data
* @param {array} data
* @returns {array}
* timeResultData: [
* {
* id: 1,
* category: 'start', start|end|from|to
* task: '到院'
* },
* ]
*/
setTimeResultData(data) {
let result = data.map((item, index) => {
return {
id: index + 1,
category: item.category.replace(/^./, item.category[0].toUpperCase()),
task: item.task
}
});
return result;
},
/**
* All reset
*/

22
src/components/Discover/Conformance/ConformanceSidebar/ConformanceShowBar.vue
View File

@@ -202,8 +202,8 @@ export default {
methods: {
/**
* 設定 start and end 的 Radio Data
* @param {object} data cfmSeqStart | cfmSeqEnd | cfmPtEteSE | cfmPtPSE | cfmWtEteSE | cfmWtPSE | cfmCtEteSE
* @param {string} category start | end
* @param {object} data cfmSeqStart | cfmSeqEnd | cfmPtEteSE | cfmPtPSE | cfmWtEteSE | cfmWtPSE | cfmCtEteSE，傳入以上任一後端接到的 Activities 列表 Data。
* @param {string} category 'start' | 'end'，傳入 'start' 或 'end'。
* @returns {array}
*/
setTaskData(data, category) {
@@ -213,9 +213,9 @@ export default {
},
/**
* 重新設定連動的 start and end 的 Radio Data
* @param {object} data cfmPtEteSE | cfmPtPSE | cfmWtEteSE | cfmWtPSE | cfmCtEteSE
* @param {string} category start | end
* @param {string} task task
* @param {object} data cfmPtEteSE | cfmPtPSE | cfmWtEteSE | cfmWtPSE | cfmCtEteSE，傳入以上任一後端接到的 Activities 列表 Data。
* @param {string} category 'start' | 'end'，傳入 'start' 或 'end'。
* @param {string} task 已選擇的 Activity task
* @returns {array}
*/
setStartAndEndData(data, category, task) {
@@ -227,9 +227,9 @@ export default {
},
/**
* 重新設定 Activity sequence 連動的 start and end 的 Radio Data
* @param {object} data cfmSeqStart | cfmSeqEnd
* @param {string} category sources | sinks
* @param {string} task task
* @param {object} data cfmSeqStart | cfmSeqEnd，傳入以上任一後端接到的 Activities 列表 Data。
* @param {string} category 'sources' | 'sinks'，傳入 'sources' 或 'sinks'。
* @param {string} task 已選擇的 Activity task
* @returns {array}
*/
setSeqStartAndEndData(data, category, task) {
@@ -239,7 +239,7 @@ export default {
},
/**
* select start list's task
* @param {event} e
* @param {event} e 觸發 input 的詳細事件
*/
selectStart(e) {
this.taskStart = e;
@@ -256,7 +256,7 @@ export default {
},
/**
* select End list's task
* @param {event} e
* @param {event} e 觸發 input 的詳細事件
*/
selectEnd(e) {
this.taskEnd = e;
@@ -283,7 +283,7 @@ export default {
},
/**
* Radio 切換時，Start & End Data 連動改變
* @param {boolean} data true | false
* @param {boolean} data true | false，傳入 true 或 false
*/
setResetData(data) {
if(data) {

8
src/components/Discover/Conformance/ConformanceSidebar/ConformanceTimeRange.vue
View File

@@ -84,22 +84,22 @@ export default {
methods: {
/**
* get min total seconds
* @param {Number} e
* @param {Number} e 最小值總秒數
*/
minTotalSeconds(e) {
this.$emit('min-total-seconds', e);
},
/**
* get min total seconds
* @param {Number} e
* @param {Number} e 最大值總秒數
*/
maxTotalSeconds(e) {
this.$emit('max-total-seconds', e);
},
/**
* get Time Range(duration)
* @param {array} data API data
* @param {string} category act | single | double
* @param {array} data API data，Activity 列表
* @param {string} category 'act' | 'single' | 'double'，傳入以上任一值。
* @param {string} task select Radio task or start
* @param {string} taskTwo end
* @returns {object} {min:12, max:345}

13
src/components/Discover/Conformance/ConformanceSidebar/ResultArrow.vue
View File

@@ -12,18 +12,5 @@
export default {
name: 'ResultArrow',
props:['data', 'select'],
// data() {
// return {
// datadata: []
// }
// },
// watch: {
// data: function(newValue) {
// this.datadata = newValue;
// },
// select: function(newValue) {
// this.datadata = newValue;
// }
// }
}
</script>

6
src/components/Discover/Conformance/ConformanceSidebar/TimeRangeDuration.vue
View File

@@ -68,16 +68,16 @@ export default {
},
/**
* get min total seconds
* @param {Number} e
* @param {Number} e 元件傳來的最小值總秒數
*/
minTotalSeconds(e) {
minTotalSeconds(e) {
this.timeRangeMin = e;
this.updateMin = e;
this.$emit('min-total-seconds', e);
},
/**
* get min total seconds
* @param {Number} e
* @param {Number} e 元件傳來的最大值總秒數
*/
maxTotalSeconds(e) {
this.timeRangeMax = e;

8
src/components/Discover/Conformance/MoreModal.vue
View File

@@ -160,7 +160,7 @@ export default {
methods: {
/**
* Number to percentage
* @param {number} val
* @param {number} val 原始數字
* @returns {string} 轉換完成的百分比字串
*/
getPercentLabel(val){
@@ -169,7 +169,7 @@ export default {
},
/**
* set progress bar width
* @param {number} value
* @param {number} value 百分比數字
* @returns {string} 樣式的寬度設定
*/
progressWidth(value){
@@ -177,7 +177,7 @@ export default {
},
/**
* switch case data
* @param {number} id
* @param {number} id case id
*/
async switchCaseData(id) {
if(id == this.showTraceId) return;
@@ -262,7 +262,7 @@ export default {
},
/**
* 無限滾動: 監聽 scroll 有沒有滾到底部
* @param {element} event
* @param {element} event 監聽時回傳的事件
*/
handleScroll(event) {
if(this.maxItems || this.infiniteData.length < 20 || this.infiniteFinish === false) return;