Image about office-scripts-docs

[ElizabethSamuel-MSFT]

@Durgesh1402 Thanks for asking about this.

@sumurthy Can you provide any guidance or example here?

Thanks.

[mscharlock]

Following up @sumurthy :)

[AlexJerabek]

Hi @Durgesh1402,

Here's a sample script to copy an image from one worksheet to another:

/**
 * This script transfers an image from one worksheet to another.
 */
function main(workbook: ExcelScript.Workbook)
{
  // Get the worksheet with the image on it.
  let firstWorksheet = workbook.getWorksheet("FirstSheet");

  // Get the first image from the worksheet.
  // If a script added the image, you could add a name to make it easier to find.
  let image: ExcelScript.Image;
  firstWorksheet.getShapes().forEach((shape, index) => {
    if (shape.getType() === ExcelScript.ShapeType.image) {
      image = shape.getImage();
      return;
    }
  });

  // Copy the image to another worksheet.
  image.getShape().copyTo("SecondSheet");
}

I'll look into the second scenario (insert an image from a folder) as well. In the meantime, you can use the Record Actions button to generate a script based on UI actions. So, you can record yourself inserting the image you want.

[AlexJerabek]

Hi @Durgesh1402,

Here's a sample from @wandyezj on how to add an image from a URL to the current worksheet:

async function main(workbook: ExcelScript.Workbook) {
  const link = "https://pnp.github.io/images/parker-p-500.png"
  const response = await fetch(link);
  const data = await response.arrayBuffer();
  const image = convertToBase64(data);
  workbook.getActiveWorksheet().addImage(image)
}

function convertToBase64(input: ArrayBuffer) {
  const uInt8Array = new Uint8Array(input);
  const count = uInt8Array.length;
  const charCodeArray = new Array(count) // allocate all space up front
  
  // Convert all characters
  let i = count;
  while (i--) { 
    charCodeArray[i] = String.fromCharCode(uInt8Array[i]);
  }
  // convert to base 64
  const base64 = btoa(charCodeArray.join(''));
  return base64;
}

A couple things about that script:

• You can use any publicly accessible link for that image. You can't use anything that requires authentication (like on a company server).
• It uses fetch and there are some things to be aware of there. See External API call support in Office Scripts for details.
• The complexity comes from converting the raw image data to a base64-encoded string, which is the required input for the addImage method. I'd recommend requesting a more streamlined API through UserVoice. We use UserVoice to prioritize community requests based on their upvotes. I imagine that your scenario is common and others will appreciate and support it.

[AlexJerabek]

I've created an internal work item to add this sample to the docs in some capacity.