Excel.DoubleCellValue interface

Package:

excel

Represents the value of a cell containing a double.

Remarks

[ API set: ExcelApi 1.16 ]

Properties

basicType	Represents the value that would be returned by Range.valueTypes for a cell with this value.
basicValue	Represents the value that would be returned by Range.values for a cell with this value.
layouts	Represents layout information for views of this double value.
numberFormat	Returns the number format string that is used to display this value. When accessed through a valuesAsJson property, this number format string is in the en-US locale. When accessed through a valuesAsJsonLocal property, this number format is in the user's display locale. Number format strings must conform to Excel guidelines. To learn more, see Review guidelines for customizing a number format.
properties	Represents additional properties of this double value.
provider	Represents information that describes the service that provided the data in this DoubleCellValue. This information can be used for branding in card view.
referencedValues	Represents the cell values which are referenced within DoubleCellValue.properties.
type	Represents the type of this cell value.

Property Details

basicType

Represents the value that would be returned by Range.valueTypes for a cell with this value.

basicType?: RangeValueType.double | "Double";

Property Value

double | "Double"

Remarks

[ API set: ExcelApi 1.16 ]

basicValue

Represents the value that would be returned by Range.values for a cell with this value.

basicValue: number;

Property Value

number

Remarks

[ API set: ExcelApi 1.16 ]

layouts

Represents layout information for views of this double value.

layouts?: BasicViewLayouts;

Property Value

Excel.BasicViewLayouts

Remarks

[ API set: ExcelApi 1.19 ]

numberFormat

Returns the number format string that is used to display this value. When accessed through a valuesAsJson property, this number format string is in the en-US locale. When accessed through a valuesAsJsonLocal property, this number format is in the user's display locale. Number format strings must conform to Excel guidelines. To learn more, see Review guidelines for customizing a number format.

numberFormat?: string;

Property Value

string

Remarks

[ API set: ExcelApi 1.19 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml

// This function creates a double data type,
// and sets the format of this data type as a currency.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const currencyRange = sheet.getRange("A2");

  // Write a number formatted as currency to cell A2.
  currencyRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.double,
        basicValue: 12.34,
        numberFormat: "$* #,##0.00"
      }
    ]
  ];

  await context.sync();
});

properties

Represents additional properties of this double value.

properties?: {
            [key: string]: EntityPropertyType;
        };

Property Value

{ [key: string]: Excel.EntityPropertyType; }

Remarks

[ API set: ExcelApi 1.19 ]

provider

Represents information that describes the service that provided the data in this DoubleCellValue. This information can be used for branding in card view.

provider?: CellValueProviderAttributes;

Property Value

Excel.CellValueProviderAttributes

Remarks

[ API set: ExcelApi 1.19 ]

referencedValues

Represents the cell values which are referenced within DoubleCellValue.properties.

referencedValues?: ReferencedValue[];

Property Value

Excel.ReferencedValue[]

Remarks

[ API set: ExcelApi 1.19 ]

type

Represents the type of this cell value.

type: CellValueType.double | ReferenceValueType.double | "Double";

Property Value

double | double | "Double"

Remarks

[ API set: ExcelApi 1.16 ]

Examples

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/20-data-types/data-types-formatted-number.yaml

// This function creates a double data type,
// and sets the format of this data type as a date.
await Excel.run(async (context) => {
  // Get the Sample worksheet and a range on that sheet.
  const sheet = context.workbook.worksheets.getItemOrNullObject("Sample");
  const dateRange = sheet.getRange("A1");

  // Write a number formatted as a date to cell A1.
  dateRange.valuesAsJson = [
    [
      {
        type: Excel.CellValueType.double,
        basicValue: 32889.0,
        numberFormat: "m/d/yyyy"
      }
    ]
  ];
  await context.sync();
});