Excel.Interfaces.RangeData interface

Pacote:

excel

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

Propriedades

address	Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência da planilha (por exemplo, "Sheet1! 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 estiverem ocultas. O valor é true quando todas as colunas em um intervalo são ocultas. O valor é false quando nenhuma coluna no intervalo está oculta. O valor é null quando algumas colunas em um intervalo são ocultas e outras colunas no mesmo intervalo não são ocultas.
columnIndex	Especifica o número de coluna da primeira célula no intervalo. Indexados com zero.
conditionalFormats	A coleção do ConditionalFormats que cruza o intervalo.
dataValidation	Retorna um objeto de validação de dados.
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.
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.
formulasR1C1	Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver fórmula, seu valor será retornado.
hasSpill	Representa se todas as células têm uma borda de despejo. Retorna true se todas as células tiverem uma borda de derramamento ou false se todas as células não tiverem uma borda de derramamento. Retornará null se houver células com e sem bordas de derramamento dentro do intervalo.
height	Retorna a distância em pontos, para 100% de zoom, da borda superior do intervalo até a borda inferior do intervalo.
hidden	Representa se todas as células do intervalo atual estiverem ocultas. O valor é true quando todas as células em um intervalo são ocultas. O valor é false quando nenhuma célula no intervalo está oculta. O valor é null quando algumas células em um intervalo estão ocultas e outras células no mesmo intervalo não estão ocultas.
hyperlink	Representa o hiperlink para o intervalo atual.
isEntireColumn	Representa se o intervalo atual está em uma coluna inteira.
isEntireRow	Representa se o intervalo atual está em uma linha inteira.
left	Retorna a distância em pontos, para 100% de zoom, da borda esquerda da planilha até a borda esquerda do intervalo.
linkedDataTypeState	Representa o estado do tipo de dados de cada célula.
numberFormat	Representa o código de formato de número do Excel para o intervalo determinado. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número.
numberFormatCategories	Representa a categoria de formato de número de cada célula.
numberFormatLocal	Representa o código de formato de número do Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de linguagem ou formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.
rowCount	Retorna o número total de linhas no intervalo.
rowHidden	Representa se todas as linhas no intervalo atual estiverem ocultas. O valor é true quando todas as linhas em um intervalo são ocultas. O valor é false quando nenhuma linha no intervalo é oculta. O valor é null quando algumas linhas em um intervalo estão ocultas e outras linhas no mesmo intervalo não são ocultas.
rowIndex	Representa o número de linhas da primeira célula no intervalo. Indexados com zero.
savedAsArray	Representa se todas as células seriam salvas como uma fórmula de matriz. Retorna true se todas as células fossem salvas como uma fórmula de matriz ou false se todas as células não fossem salvas como uma fórmula de matriz. Retorna null se algumas células forem salvas como uma fórmula de matriz e algumas não forem.
style	Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, null serão retornados. Para estilos personalizados, o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que representa um valor no BuiltInStyle enum será retornada.
text	Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição de sinal de número (#) que acontece na interface do usuário do Excel não afetará o valor de texto retornado pela API.
top	Retorna a distância em pontos, para 100% de zoom, da borda superior da planilha até a borda superior do intervalo.
values	Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com uma adição ("+"), menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor como uma fórmula.
valuesAsJson	Uma representação JSON dos valores nas células nesse intervalo. Ao contrário Range.valuesde , Range.valuesAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use Range.valuesAsJsonLocal.
valuesAsJsonLocal	Uma representação JSON dos valores nas células nesse intervalo. Ao contrário Range.valuesde , Range.valuesAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use Range.valuesAsJson.
valueTypes	Especifica o tipo de dados em cada célula.
width	Retorna a distância em pontos, para 100% de zoom, da borda esquerda do intervalo até a borda direita do intervalo.

Detalhes da propriedade

address

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

address?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: 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 API: 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 API: ExcelApi 1.1 ]

columnCount

Especifica o número total de colunas no intervalo.

columnCount?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

columnHidden

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

columnHidden?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

columnIndex

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

columnIndex?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

conditionalFormats

A coleção do ConditionalFormats que cruza o intervalo.

conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];

Valor da propriedade

Excel.Interfaces.ConditionalFormatData[]

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

dataValidation

Retorna um objeto de validação de dados.

dataValidation?: Excel.Interfaces.DataValidationData;

Valor da propriedade

Excel.Interfaces.DataValidationData

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

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

Excel.Interfaces.RangeFormatData

Comentários

[ Conjunto de API: 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.

formulas?: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: 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.

formulasLocal?: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: 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.

formulasR1C1?: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

hasSpill

Representa se todas as células têm uma borda de despejo. Retorna true se todas as células tiverem uma borda de derramamento ou false se todas as células não tiverem uma borda de derramamento. Retornará null se houver células com e sem bordas de derramamento dentro do intervalo.

hasSpill?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

height

Retorna a distância em pontos, para 100% de zoom, da borda superior do intervalo até a borda inferior do intervalo.

height?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

hidden

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

hidden?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

hyperlink

Representa o hiperlink para o intervalo atual.

hyperlink?: Excel.RangeHyperlink;

Valor da propriedade

Excel.RangeHyperlink

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

isEntireColumn

Representa se o intervalo atual está em uma coluna inteira.

isEntireColumn?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

isEntireRow

Representa se o intervalo atual está em uma linha inteira.

isEntireRow?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

left

Retorna a distância em pontos, para 100% de zoom, da borda esquerda da planilha até a borda esquerda do intervalo.

left?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

linkedDataTypeState

Representa o estado do tipo de dados de cada célula.

linkedDataTypeState?: Excel.LinkedDataTypeState[][];

Valor da propriedade

Excel.LinkedDataTypeState[][]

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

numberFormat

Representa o código de formato de número do Excel para o intervalo determinado. 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 API: ExcelApi 1.1 ]

numberFormatCategories

Representa a categoria de formato de número de cada célula.

numberFormatCategories?: Excel.NumberFormatCategory[][];

Valor da propriedade

Excel.NumberFormatCategory[][]

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

numberFormatLocal

Representa o código de formato de número do Excel para o intervalo determinado, com base nas configurações de idioma do usuário. O Excel não executa nenhuma coerção de linguagem ou formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto retornado usa as cadeias de caracteres formatadas localmente com base no idioma especificado nas configurações do sistema.

numberFormatLocal?: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

rowCount

Retorna o número total de linhas no intervalo.

rowCount?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

rowHidden

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

rowHidden?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: 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 API: ExcelApi 1.1 ]

savedAsArray

Representa se todas as células seriam salvas como uma fórmula de matriz. Retorna true se todas as células fossem salvas como uma fórmula de matriz ou false se todas as células não fossem salvas como uma fórmula de matriz. Retorna null se algumas células forem salvas como uma fórmula de matriz e algumas não forem.

savedAsArray?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

style

Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, null serão retornados. Para estilos personalizados, o nome do estilo será retornado. Para estilos internos, uma cadeia de caracteres que representa um valor no BuiltInStyle enum será retornada.

style?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

text

Valores de texto do intervalo especificado. O valor de texto não depende da largura da célula. A substituição de sinal de número (#) que acontece 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 API: ExcelApi 1.1 ]

top

Retorna a distância em pontos, para 100% de zoom, da borda superior da planilha até a borda superior do intervalo.

top?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

values

Representa os valores brutos do intervalo especificado. Os dados retornados podem ser uma cadeia de caracteres, número ou booliano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor retornado começar com uma adição ("+"), menos ("-"), ou sinal igual ("="), o Excel interpretará esse valor como uma fórmula.

values?: any[][];

Valor da propriedade

any[][]

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

valuesAsJson

Uma representação JSON dos valores nas células nesse intervalo. Ao contrário Range.valuesde , Range.valuesAsJson dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham com a localidade en-US. Para recuperar dados na localidade de exibição do usuário, use Range.valuesAsJsonLocal.

valuesAsJson?: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valuesAsJsonLocal

Uma representação JSON dos valores nas células nesse intervalo. Ao contrário Range.valuesde , Range.valuesAsJsonLocal dá suporte a todos os tipos de dados que podem estar em uma célula. Exemplos incluem valores de número formatado e imagens da Web, além dos valores padrão booliano, número e cadeia de caracteres. Os dados retornados dessa API sempre se alinham à localidade de exibição do usuário. Para recuperar dados independentes da localidade, use Range.valuesAsJson.

valuesAsJsonLocal?: CellValue[][];

Valor da propriedade

Excel.CellValue[][]

Comentários

[ Conjunto de API: ExcelApi 1.16 ]

valueTypes

Especifica o tipo de dados em cada célula.

valueTypes?: Excel.RangeValueType[][];

Valor da propriedade

Excel.RangeValueType[][]

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

width

Retorna a distância em pontos, para 100% de zoom, da borda esquerda do intervalo até a borda direita do intervalo.

width?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]