How does the range function getCellProperties in the JavaScript excel API work?

Question

I am specifically trying to call this function on an Array:

https://learn.microsoft.com/en-us/javascript/api/excel/excel.range?view=office-js#getcellproperties-cellpropertiesloadoptions-

It is really not clear from the documentation what is required to make this work. I am definitely missing something here. Below is the current state of my code.

I have also checked that the add-in I am building is running in a version of Excel that is using API v1.9.

I have tried setting various objects that match the interface described by cellPropertiesLoadOptions - but again not sure what the requirement actually is from the docs.

async function getFormatsForCellRange () {
  return await Excel.run(async context => {
    const table = await context.workbook.tables.getItem(observationConst.TABLE_NAME)
    const range = table.getRange()
    const cellProperties = range.getCellProperties()
    console.log(cellProperties)
  })
}

The documentation states that the result of calling getCellProperties should be a 2d array.

Please see the answer on https://stackoverflow.com/a/55466639/678505, which gives an example of the API call. — Michael Zlatkovsky - Microsoft, Jun 25 '19 at 16:19

score 2 · Answer 1 · answered Jun 27 '19 at 07:35

var actualData = rangeSrc.getCellProperties({
 format: {
    font: {
           bold: true,
           color: true,
           fill: true
           italic: true,
           name: true,
           underline: true,
           size: true,
           strikethrough: true,
           subscript: true,
           superscript: true,
           tintAndShade: true
    }
 }

How does the range function getCellProperties in the JavaScript excel API work?

1 Answers1