Add top/bottom conditional formatting sample (#312)

Author: AlexJerabek

docs/docs-ref-autogen/excel/excelscript/excelscript.conditionaldatabarrule.yml

@@ -11,7 +11,7 @@ remarks: |-
 
   ```TypeScript
   /**
-   * This script creates data bar conditional formatting on the select ranged.
+   * This script creates data bar conditional formatting on the selected range.
    * The scale of the data bar goes from 0 to 1000.
    */
   function main(workbook: ExcelScript.Workbook) {

docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformat.yml

@@ -165,7 +165,7 @@ methods:
 
           ```TypeScript
           /**
-           * This script creates data bar conditional formatting on the select ranged.
+           * This script creates data bar conditional formatting on the selected range.
            * The scale of the data bar goes from 0 to 1000.
            */
           function main(workbook: ExcelScript.Workbook) {
@@ -417,7 +417,31 @@ methods:
       content: 'getTopBottom(): TopBottomConditionalFormat | undefined;'
       return:
         type: '<xref uid="ExcelScript!ExcelScript.TopBottomConditionalFormat:interface" /> | undefined'
-        description: ''
+        description: |-
+
+
+          #### Examples
+
+          ```TypeScript
+          /**
+           * This script applies top/bottom conditional formatting to a range.
+           * The top 2 values in the range will have the cell fill color changed to green.
+           */
+          function main(workbook: ExcelScript.Workbook) {
+            // Get the range to format.
+            const sheet = workbook.getWorksheet("TopBottom");
+            const dataRange = sheet.getRange("B2:D5");
+
+            // Set the fill color to green for the top 2 values in the range.
+            const topBottomFormat = dataRange.addConditionalFormat(
+              ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
+            topBottomFormat.getFormat().getFill().setColor("green");
+            topBottomFormat.setRule({
+              rank: 2, /* The numeric threshold. */
+              type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
+            });
+          }
+          ```
   - name: getType()
     uid: 'ExcelScript!ExcelScript.ConditionalFormat#getType:member(1)'
     package: ExcelScript!

docs/docs-ref-autogen/excel/excelscript/excelscript.conditionalformatruletype.yml

@@ -11,7 +11,7 @@ remarks: |-
 
   ```TypeScript
   /**
-   * This script creates data bar conditional formatting on the select ranged.
+   * This script creates data bar conditional formatting on the selected range.
    * The scale of the data bar goes from 0 to 1000.
    */
   function main(workbook: ExcelScript.Workbook) {

docs/docs-ref-autogen/excel/excelscript/excelscript.databarconditionalformat.yml

@@ -11,7 +11,7 @@ remarks: |-
 
   ```TypeScript
   /**
-   * This script creates data bar conditional formatting on the select ranged.
+   * This script creates data bar conditional formatting on the selected range.
    * The scale of the data bar goes from 0 to 1000.
    */
   function main(workbook: ExcelScript.Workbook) {

docs/sample-scripts/excel-scripts.yaml

@@ -915,7 +915,7 @@
 'ExcelScript.ConditionalDataBarRule:interface':
   - |-
     /**
-     * This script creates data bar conditional formatting on the select ranged.
+     * This script creates data bar conditional formatting on the selected range.
      * The scale of the data bar goes from 0 to 1000.
      */
     function main(workbook: ExcelScript.Workbook) {
@@ -1016,7 +1016,7 @@
 'ExcelScript.ConditionalFormat#getDataBar:member(1)':
   - |-
     /**
-     * This script creates data bar conditional formatting on the select ranged.
+     * This script creates data bar conditional formatting on the selected range.
      * The scale of the data bar goes from 0 to 1000.
      */
     function main(workbook: ExcelScript.Workbook) {
@@ -1122,6 +1122,26 @@
       };
       textConditionFormat.setRule(textRule);
     }
+'ExcelScript.ConditionalFormat#getTopBottom:member(1)':
+  - |-
+    /**
+     * This script applies top/bottom conditional formatting to a range.
+     * The top 2 values in the range will have the cell fill color changed to green.
+     */
+    function main(workbook: ExcelScript.Workbook) {
+      // Get the range to format.
+      const sheet = workbook.getWorksheet("TopBottom");
+      const dataRange = sheet.getRange("B2:D5");
+
+      // Set the fill color to green for the top 2 values in the range.
+      const topBottomFormat = dataRange.addConditionalFormat(
+        ExcelScript.ConditionalFormatType.topBottom).getTopBottom();
+      topBottomFormat.getFormat().getFill().setColor("green");
+      topBottomFormat.setRule({
+        rank: 2, /* The numeric threshold. */
+        type: ExcelScript.ConditionalTopBottomCriterionType.topItems /* The type of the top/bottom condition. */
+      });
+    }
 'ExcelScript.ConditionalFormatColorCriterionType:enum':
   - |-
     /**
@@ -1211,7 +1231,7 @@
 'ExcelScript.ConditionalFormatRuleType:enum':
   - |-
     /**
-     * This script creates data bar conditional formatting on the select ranged.
+     * This script creates data bar conditional formatting on the selected range.
      * The scale of the data bar goes from 0 to 1000.
      */
     function main(workbook: ExcelScript.Workbook) {
@@ -1533,7 +1553,7 @@
 'ExcelScript.DataBarConditionalFormat:interface':
   - |-
     /**
-     * This script creates data bar conditional formatting on the select ranged.
+     * This script creates data bar conditional formatting on the selected range.
      * The scale of the data bar goes from 0 to 1000.
      */
     function main(workbook: ExcelScript.Workbook) {

generate-docs/API Coverage Report.csv

@@ -1164,7 +1164,7 @@ ExcelScript.ConditionalFormat,"getRange()",Method,Poor,false
 ExcelScript.ConditionalFormat,"getRanges()",Method,Poor,false
 ExcelScript.ConditionalFormat,"getStopIfTrue()",Method,Poor,false
 ExcelScript.ConditionalFormat,"getTextComparison()",Method,Fine,true
-ExcelScript.ConditionalFormat,"getTopBottom()",Method,Poor,false
+ExcelScript.ConditionalFormat,"getTopBottom()",Method,Good,true
 ExcelScript.ConditionalFormat,"getType()",Method,Poor,false
 ExcelScript.ConditionalFormat,"setPriority(priority)",Method,Poor,false
 ExcelScript.ConditionalFormat,"setStopIfTrue(stopIfTrue)",Method,Poor,false