Excel.FormattedNumberCellValue interface

  • Referência
Pacote:
excel

Representa o valor de uma célula que contém um número com uma cadeia de caracteres de formato. As cadeias de caracteres de formato de número devem estar em conformidade com as diretrizes do Excel. Para saber mais, confira Revisar diretrizes para personalizar um formato de número. Nesse cenário, o formato é aplicado ao valor e não à célula, portanto, o valor mantém sua cadeia de caracteres de formato durante todo o cálculo.

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Propriedades

basicType

Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.
basicValue

Representa o valor que seria retornado por Range.values para uma célula com esse valor.
numberFormat

Retorna a cadeia de caracteres de formato de número usada para exibir esse valor. Quando acessado por meio de uma valuesAsJson propriedade, essa cadeia de caracteres de formato de número está na localidade en-US. Quando acessado por meio de uma valuesAsJsonLocal propriedade, esse formato de número está na localidade de exibição do usuário. As cadeias de caracteres de formato de número devem estar em conformidade com as diretrizes do Excel. Para saber mais, confira Revisar diretrizes para personalizar um formato de número.
type

Representa o tipo desse valor de célula.

Detalhes da propriedade

basicType

Representa o valor que seria retornado por Range.valueTypes para uma célula com esse valor.

basicType?: RangeValueType.double | "Double";

Valor da propriedade

double | "Double"

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

basicValue

Representa o valor que seria retornado por Range.values para uma célula com esse valor.

basicValue: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

numberFormat

Retorna a cadeia de caracteres de formato de número usada para exibir esse valor. Quando acessado por meio de uma valuesAsJson propriedade, essa cadeia de caracteres de formato de número está na localidade en-US. Quando acessado por meio de uma valuesAsJsonLocal propriedade, esse formato de número está na localidade de exibição do usuário. As cadeias de caracteres de formato de número devem estar em conformidade com as diretrizes do Excel. Para saber mais, confira Revisar diretrizes para personalizar um formato de número.

numberFormat: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Exemplos

// 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 formatted number 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.formattedNumber,
        basicValue: 12.34,
        numberFormat: "$* #,##0.00"
      }
    ]
  ];

  await context.sync();
});

type

Representa o tipo desse valor de célula.

type: CellValueType.formattedNumber | "FormattedNumber";

Valor da propriedade

formattedNumber | "FormattedNumber"

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

Exemplos

// 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 formatted number 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.formattedNumber,
        basicValue: 32889.0,
        numberFormat: "m/d/yyyy"
      }
    ]
  ];
  await context.sync();
});