avniproject/avni-client#1256 | Add documentation for ReportCard.getCa…

…rdId()
avniproject · Jan 31, 2024 · c8766ea · c8766ea
1 parent 2df5780
commit c8766ea
Showing 1 changed file with 7 additions and 0 deletions.
diff --git a/src/ReportCard.js b/src/ReportCard.js
@@ -99,6 +99,13 @@ class ReportCard extends BaseEntity {
     return _.isNil(this.standardReportCardType) ? '#ffffff' : this.standardReportCardType.textColor;
   }
 
+  /**
+   * Helper method used to generate unique key value for Nested Report Cards using UUID and Index of the Report Card.
+   * The Nested Report Card's query responses would be mapped to the corresponding Dashboard Report cards using the UUID and Index.
+   *
+   * @param index
+   * @returns {string}
+   */
   getCardId(index = 0) {
     return this.uuid + '#' + index;
   }