Excel.Interfaces.RangeData interface

Uma interface que descreve os dados retornados chamando range.toJSON().

Comentários

Usada por

Propriedades

address

Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência de planilha (por exemplo, "Planilha1! A1:B4").

addressLocal

Representa a referência de intervalo para o intervalo especificado no idioma do usuário.

cellCount

Especifica o número de células no intervalo. Essa API retornará -1 se a contagem de células exceder 2^31-1 (2.147.483.647).

columnCount

Especifica o número total de colunas no intervalo.

columnHidden

Representa se todas as colunas no intervalo atual estão ocultas. Valor é true quando todas as colunas em um intervalo estão ocultas. Valor é false quando nenhuma coluna no intervalo está oculta. Valor é null quando algumas colunas em um intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.

columnIndex

Especifica o número da coluna da primeira célula do intervalo. Indexados com zero.

format

Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

formulas

Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulasLocal

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulasR1C1

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

hidden

Representa se todas as células no intervalo atual estão ocultas. Valor é true quando todas as células em um intervalo estão ocultas. Valor é false quando nenhuma célula do intervalo está oculta. O valor é null quando algumas células de um intervalo estão ocultas e outras células do mesmo intervalo não estão ocultas.

numberFormat

Representa o código de formato de número do Excel para determinado intervalo. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número.

rowCount

Retorna o número total de linhas no intervalo.

rowHidden

Representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas em um intervalo estão ocultas. O valor é false quando nenhuma linha no intervalo está oculta. O valor é null quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.

rowIndex

Representa o número de linhas da primeira célula no intervalo. Indexados com zero.

text

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal de número (#) que ocorre na interface do usuário do Excel não afetará o valor de texto retornado pela API.

values

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, um número ou um booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com um sinal de mais ("+"), sinal de subtração ("-") ou sinal de igual ("="), o Excel interpretará esse valor como uma fórmula. Cadeias de caracteres em forma de localidade (como a data "19-8-2025" em nl-NL ou fr-FR, formato DD-MM-AAAA) são armazenadas como texto em vez de datas. Para garantir que as datas sejam armazenadas como datas, use uma API com reconhecimento de localidade como formulasLocal ou use um formato neutro de localidade como ISO (AAAA-MM-DD) ou uma data numérica serial.

valueTypes

Especifica o tipo de dados em cada célula.

Detalhes da propriedade

address

Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência de planilha (por exemplo, "Planilha1! A1:B4").

address?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.1

addressLocal

Representa a referência de intervalo para o intervalo especificado no idioma do usuário.

addressLocal?: string;

Valor da propriedade

string

Comentários

Conjunto de APIs: ExcelApi 1.1

cellCount

Especifica o número de células no intervalo. Essa API retornará -1 se a contagem de células exceder 2^31-1 (2.147.483.647).

cellCount?: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: ExcelApi 1.1

columnCount

Especifica o número total de colunas no intervalo.

columnCount?: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: ExcelApi 1.1

columnHidden

Representa se todas as colunas no intervalo atual estão ocultas. Valor é true quando todas as colunas em um intervalo estão ocultas. Valor é false quando nenhuma coluna no intervalo está oculta. Valor é null quando algumas colunas em um intervalo estão ocultas e outras colunas no mesmo intervalo não estão ocultas.

columnHidden?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.2

columnIndex

Especifica o número da coluna da primeira célula do intervalo. Indexados com zero.

columnIndex?: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: ExcelApi 1.1

format

Retorna um objeto de formato que encapsula a fonte, o preenchimento, as bordas, o alinhamento e outras propriedades do intervalo.

format?: Excel.Interfaces.RangeFormatData;

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1

formulas

Representa a fórmula em notação A1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulas?: any[][];

Valor da propriedade

any[][]

Comentários

Conjunto de APIs: ExcelApi 1.1

formulasLocal

Representa a fórmula em notação A1, na formatação de número da localidade e no idioma do usuário. Por exemplo, a fórmula "=SUM(A1, 1.5)" em inglês seria "=SOMA(A1; 1,5)" em português. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulasLocal?: any[][];

Valor da propriedade

any[][]

Comentários

Conjunto de APIs: ExcelApi 1.1

formulasR1C1

Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado em vez disso.

formulasR1C1?: any[][];

Valor da propriedade

any[][]

Comentários

Conjunto de APIs: ExcelApi 1.2

hidden

Representa se todas as células no intervalo atual estão ocultas. Valor é true quando todas as células em um intervalo estão ocultas. Valor é false quando nenhuma célula do intervalo está oculta. O valor é null quando algumas células de um intervalo estão ocultas e outras células do mesmo intervalo não estão ocultas.

hidden?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.2

numberFormat

Representa o código de formato de número do Excel para determinado intervalo. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número.

numberFormat?: any[][];

Valor da propriedade

any[][]

Comentários

Conjunto de APIs: ExcelApi 1.1

rowCount

Retorna o número total de linhas no intervalo.

rowCount?: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: ExcelApi 1.1

rowHidden

Representa se todas as linhas no intervalo atual estão ocultas. O valor é true quando todas as linhas em um intervalo estão ocultas. O valor é false quando nenhuma linha no intervalo está oculta. O valor é null quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não estão ocultas.

rowHidden?: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: ExcelApi 1.2

rowIndex

Representa o número de linhas da primeira célula no intervalo. Indexados com zero.

rowIndex?: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: ExcelApi 1.1

text

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição do sinal de número (#) que ocorre na interface do usuário do Excel não afetará o valor de texto retornado pela API.

text?: string[][];

Valor da propriedade

string[][]

Comentários

Conjunto de APIs: ExcelApi 1.1

values

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, um número ou um booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com um sinal de mais ("+"), sinal de subtração ("-") ou sinal de igual ("="), o Excel interpretará esse valor como uma fórmula. Cadeias de caracteres em forma de localidade (como a data "19-8-2025" em nl-NL ou fr-FR, formato DD-MM-AAAA) são armazenadas como texto em vez de datas. Para garantir que as datas sejam armazenadas como datas, use uma API com reconhecimento de localidade como formulasLocal ou use um formato neutro de localidade como ISO (AAAA-MM-DD) ou uma data numérica serial.

values?: any[][];

Valor da propriedade

any[][]

Comentários

Conjunto de APIs: ExcelApi 1.1

valueTypes

Especifica o tipo de dados em cada célula.

valueTypes?: Excel.RangeValueType[][];

Valor da propriedade

Comentários

Conjunto de APIs: ExcelApi 1.1