Automatically generated docs (#2315)

Co-authored-by: github-actions <[email protected]>

Author: AlexJerabek

docs/docs-ref-autogen/excel/excel/excel.chartdatalabel.yml

@@ -8,6 +8,56 @@ remarks: >-
   \[ [API set: ExcelApi
   1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
 
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Link to full sample:
+  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
+
+
+  // This function styles substrings within data label text using font
+  formatting.
+
+  await Excel.run(async (context) => {
+    const sheet = context.workbook.worksheets.getItem(sheetName);
+    const chart = sheet.charts.getItemAt(0);
+    await context.sync();
+
+    const series = chart.series.getItemAt(0);
+    series.load("points");
+    await context.sync();
+
+    series.points.load("items");
+    await context.sync();
+
+    // Style a substring in the first data label.
+    let searchString = "sports";
+    let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
+    await context.sync();
+    let substringStart = dataLabel.text.indexOf(searchString);
+    let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
+    subLabel.font.size = 13;
+    subLabel.font.bold = true;
+
+    // Style a substring in the second data label.
+    searchString = "'Titanic'";
+    dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
+    await context.sync();
+
+    substringStart = dataLabel.text.indexOf(searchString);
+    subLabel = dataLabel.getSubstring(substringStart, searchString.length);
+    subLabel.font.name = "Calibri";
+    subLabel.font.size = 13;
+    subLabel.font.italic = true;
+    subLabel.font.color = "blue";
+    await context.sync();
+  });
+
+  ```
+
 isPreview: false
 isDeprecated: false
 type: class

docs/docs-ref-autogen/excel/excel/excel.chartpoint.yml

@@ -8,6 +8,55 @@ remarks: >-
   \[ [API set: ExcelApi
   1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
 
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Link to full sample:
+  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
+
+
+  // This function adds data labels to specific chart points 
+
+  // and sets their text and position.
+
+  await Excel.run(async (context) => {
+    const sheet = context.workbook.worksheets.getItem(sheetName);
+    const chart = sheet.charts.getItemAt(0);
+    await context.sync();
+
+    const series = chart.series.getItemAt(0);
+    series.points.load("dataLabel");
+    await context.sync();
+    
+    // Define properties for data label positioning and shape.
+    const labelProperties = [
+      {
+        top: 70,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      },
+      {
+        top: 200,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      }
+    ];
+
+    // Add data labels to specific chart points and set their text and properties.
+    for (let i = 0; i < dataLabelInfo.length; i++) {
+      const point = series.points.getItemAt(dataLabelInfo[i].index);
+      point.hasDataLabel = true;
+
+      const dataLabel = point.dataLabel;
+      dataLabel.text = dataLabelInfo[i].news;
+      dataLabel.set(labelProperties[i]);
+    }
+    await context.sync();
+  });
+
+  ```
+
 isPreview: false
 isDeprecated: false
 type: class

docs/docs-ref-autogen/excel/excel/excel.chartpointscollection.yml

@@ -8,6 +8,55 @@ remarks: >-
   \[ [API set: ExcelApi
   1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
 
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Link to full sample:
+  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
+
+
+  // This function adds data labels to specific chart points 
+
+  // and sets their text and position.
+
+  await Excel.run(async (context) => {
+    const sheet = context.workbook.worksheets.getItem(sheetName);
+    const chart = sheet.charts.getItemAt(0);
+    await context.sync();
+
+    const series = chart.series.getItemAt(0);
+    series.points.load("dataLabel");
+    await context.sync();
+    
+    // Define properties for data label positioning and shape.
+    const labelProperties = [
+      {
+        top: 70,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      },
+      {
+        top: 200,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      }
+    ];
+
+    // Add data labels to specific chart points and set their text and properties.
+    for (let i = 0; i < dataLabelInfo.length; i++) {
+      const point = series.points.getItemAt(dataLabelInfo[i].index);
+      point.hasDataLabel = true;
+
+      const dataLabel = point.dataLabel;
+      dataLabel.text = dataLabelInfo[i].news;
+      dataLabel.set(labelProperties[i]);
+    }
+    await context.sync();
+  });
+
+  ```
+
 isPreview: false
 isDeprecated: false
 type: class

docs/docs-ref-autogen/excel/excel/excel.workbook.yml

@@ -942,6 +942,41 @@ methods:
       1.19](/javascript/api/requirement-sets/excel/excel-api-requirement-sets)
       \]
 
+
+      #### Examples
+
+
+      ```TypeScript
+
+      // Link to full sample:
+      https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/44-shape/shape-get-active.yaml
+
+
+      // This method gets the active shape and displays it as an image in the
+      task pane.
+
+      await Excel.run(async (context) => {
+        // Get the currently active shape, if any.
+        const activeShape = context.workbook.getActiveShapeOrNullObject();
+        
+        if (activeShape) {
+          // Convert the active shape to an image.
+          const shapeImage = activeShape.getAsImage(Excel.PictureFormat.png);
+          await context.sync();
+          
+          // Display the image in the task pane.
+          const imageContainer = document.getElementById("image");
+          imageContainer.innerHTML = ''; // Clear the container before adding a new image.
+          const imageElement = document.createElement("img");
+          imageElement.src = "data:image/png;base64," + shapeImage.value;
+          imageContainer.appendChild(imageElement);              
+        } else {
+          console.log("No active shape");
+        }
+      });
+
+      ```
+
     isPreview: false
     isDeprecated: false
     syntax:

docs/docs-ref-autogen/excel_1_1/excel/excel.chartpoint.yml

@@ -8,6 +8,55 @@ remarks: >-
   \[ [API set: ExcelApi
   1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
 
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Link to full sample:
+  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
+
+
+  // This function adds data labels to specific chart points 
+
+  // and sets their text and position.
+
+  await Excel.run(async (context) => {
+    const sheet = context.workbook.worksheets.getItem(sheetName);
+    const chart = sheet.charts.getItemAt(0);
+    await context.sync();
+
+    const series = chart.series.getItemAt(0);
+    series.points.load("dataLabel");
+    await context.sync();
+    
+    // Define properties for data label positioning and shape.
+    const labelProperties = [
+      {
+        top: 70,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      },
+      {
+        top: 200,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      }
+    ];
+
+    // Add data labels to specific chart points and set their text and properties.
+    for (let i = 0; i < dataLabelInfo.length; i++) {
+      const point = series.points.getItemAt(dataLabelInfo[i].index);
+      point.hasDataLabel = true;
+
+      const dataLabel = point.dataLabel;
+      dataLabel.text = dataLabelInfo[i].news;
+      dataLabel.set(labelProperties[i]);
+    }
+    await context.sync();
+  });
+
+  ```
+
 isPreview: false
 isDeprecated: false
 type: class

docs/docs-ref-autogen/excel_1_1/excel/excel.chartpointscollection.yml

@@ -8,6 +8,55 @@ remarks: >-
   \[ [API set: ExcelApi
   1.1](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
 
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Link to full sample:
+  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
+
+
+  // This function adds data labels to specific chart points 
+
+  // and sets their text and position.
+
+  await Excel.run(async (context) => {
+    const sheet = context.workbook.worksheets.getItem(sheetName);
+    const chart = sheet.charts.getItemAt(0);
+    await context.sync();
+
+    const series = chart.series.getItemAt(0);
+    series.points.load("dataLabel");
+    await context.sync();
+    
+    // Define properties for data label positioning and shape.
+    const labelProperties = [
+      {
+        top: 70,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      },
+      {
+        top: 200,
+        geometricShapeType: Excel.GeometricShapeType.rectangle
+      }
+    ];
+
+    // Add data labels to specific chart points and set their text and properties.
+    for (let i = 0; i < dataLabelInfo.length; i++) {
+      const point = series.points.getItemAt(dataLabelInfo[i].index);
+      point.hasDataLabel = true;
+
+      const dataLabel = point.dataLabel;
+      dataLabel.text = dataLabelInfo[i].news;
+      dataLabel.set(labelProperties[i]);
+    }
+    await context.sync();
+  });
+
+  ```
+
 isPreview: false
 isDeprecated: false
 type: class

docs/docs-ref-autogen/excel_1_10/excel/excel.chartdatalabel.yml

@@ -8,6 +8,56 @@ remarks: >-
   \[ [API set: ExcelApi
   1.7](/javascript/api/requirement-sets/excel/excel-api-requirement-sets) \]
 
+
+  #### Examples
+
+
+  ```TypeScript
+
+  // Link to full sample:
+  https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/10-chart/chart-data-labels.yaml
+
+
+  // This function styles substrings within data label text using font
+  formatting.
+
+  await Excel.run(async (context) => {
+    const sheet = context.workbook.worksheets.getItem(sheetName);
+    const chart = sheet.charts.getItemAt(0);
+    await context.sync();
+
+    const series = chart.series.getItemAt(0);
+    series.load("points");
+    await context.sync();
+
+    series.points.load("items");
+    await context.sync();
+
+    // Style a substring in the first data label.
+    let searchString = "sports";
+    let dataLabel = series.points.getItemAt(dataLabelInfo[0].index).dataLabel.load("text");
+    await context.sync();
+    let substringStart = dataLabel.text.indexOf(searchString);
+    let subLabel = dataLabel.getSubstring(substringStart, searchString.length);
+    subLabel.font.size = 13;
+    subLabel.font.bold = true;
+
+    // Style a substring in the second data label.
+    searchString = "'Titanic'";
+    dataLabel = series.points.getItemAt(dataLabelInfo[1].index).dataLabel.load("text");
+    await context.sync();
+
+    substringStart = dataLabel.text.indexOf(searchString);
+    subLabel = dataLabel.getSubstring(substringStart, searchString.length);
+    subLabel.font.name = "Calibri";
+    subLabel.font.size = 13;
+    subLabel.font.italic = true;
+    subLabel.font.color = "blue";
+    await context.sync();
+  });
+
+  ```
+
 isPreview: false
 isDeprecated: false
 type: class