Excel.Interfaces.RangeData interface

Pacote:

excel

Uma interface que descreve os dados devolvidos ao chamar range.toJSON().

Propriedades

address	Especifica a referência de intervalo no estilo A1. O valor do endereço contém a referência da folha (por exemplo, "Folha1! A1:B4").
addressLocal	Representa a referência de intervalo para o intervalo especificado no idioma do utilizador.
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. O valor é true quando todas as colunas num intervalo estão ocultas. O valor é false quando não existem colunas no intervalo ocultadas. O valor é null quando algumas colunas num 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 no intervalo. Indexados com zero.
conditionalFormats	A coleção do ConditionalFormats que intersecta o intervalo.
control	Acede ao controlo de células aplicado a este intervalo. Se o intervalo tiver vários controlos de célula, devolve EmptyCellControl.
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 nenhuma fórmula, é devolvido o respetivo valor.
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 nenhuma fórmula, é devolvido o respetivo valor.
formulasR1C1	Representa a fórmula em notação no estilo L1C1. Se uma célula não tiver nenhuma fórmula, é devolvido o respetivo valor.
hasSpill	Representa se todas as células têm uma borda de despejo. Devolve true se todas as células tiverem um limite de transposição ou false se todas as células não tiverem um limite de transposição. Devolve null se existirem células com e sem limites de transposição dentro do intervalo.
height	Devolve a distância em pontos, para 100% de zoom, desde a margem superior do intervalo até à margem inferior do intervalo.
hidden	Representa se todas as células no intervalo atual estão ocultas. O valor é true quando todas as células num intervalo estão ocultas. O valor é false quando não existem células no intervalo ocultadas. O valor é null quando algumas células num intervalo estão ocultas e outras células no mesmo intervalo não estão ocultas.
hyperlink	Representa a hiperligação 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	Devolve a distância em pontos, para uma ampliação de 100%, desde a margem esquerda da folha de cálculo até à margem 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 especificado. 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 do formato de número de cada célula.
numberFormatLocal	Representa o código de formato de número do Excel para o intervalo especificado, com base nas definições de idioma do utilizador. O Excel não executa qualquer idioma ou coerção de formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto devolvido utiliza as cadeias formatadas localmente com base no idioma especificado nas definições do sistema.
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 num intervalo estão ocultas. O valor é false quando não existem linhas no intervalo ocultadas. O valor é null quando algumas linhas num 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.
savedAsArray	Representa se todas as células seriam guardadas como uma fórmula de matriz. Devolve true se todas as células fossem guardadas como uma fórmula de matriz ou false se todas as células não fossem guardadas como uma fórmula de matriz. Devolve null se algumas células fossem guardadas como uma fórmula de matriz e algumas não seriam.
style	Representa o estilo de intervalo atual. Se os estilos das células forem inconsistentes, null serão devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na BuiltInStyle enumeração.
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 IU do Excel não afetará o valor de texto devolvido pela API.
top	Devolve a distância em pontos, para uma ampliação de 100%, desde a margem superior da folha de cálculo até à margem superior do intervalo.
values	Representa os valores brutos do intervalo especificado. Os dados devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este valor como uma fórmula.
valuesAsJson	Uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize Range.valuesAsJsonLocal.
valuesAsJsonLocal	Uma representação JSON dos valores nas células deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize Range.valuesAsJson.
valueTypes	Especifica o tipo de dados em cada célula.
width	Devolve a distância em pontos, para um zoom de 100%, desde a margem esquerda do intervalo até à margem 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 folha (por exemplo, "Folha1! 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 utilizador.

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 estão ocultas. O valor é true quando todas as colunas num intervalo estão ocultas. O valor é false quando não existem colunas no intervalo ocultadas. O valor é null quando algumas colunas num 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 API: ExcelApi 1.2 ]

columnIndex

Especifica o número da 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 intersecta o intervalo.

conditionalFormats?: Excel.Interfaces.ConditionalFormatData[];

Valor da propriedade

Excel.Interfaces.ConditionalFormatData[]

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

control

Observação

Esta API é fornecida como uma versão prévia para desenvolvedores e pode ser alterada com base nos comentários que recebemos. Não use esta API em um ambiente de produção.

Acede ao controlo de células aplicado a este intervalo. Se o intervalo tiver vários controlos de célula, devolve EmptyCellControl.

control?: CellControl;

Valor da propriedade

Excel.CellControl

Comentários

[ Conjunto de API: ExcelApi BETA (APENAS PRÉ-VISUALIZAÇÃO) ]

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 nenhuma fórmula, é devolvido o respetivo valor.

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 nenhuma fórmula, é devolvido o respetivo valor.

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 nenhuma fórmula, é devolvido o respetivo valor.

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. Devolve true se todas as células tiverem um limite de transposição ou false se todas as células não tiverem um limite de transposição. Devolve null se existirem células com e sem limites de transposição dentro do intervalo.

hasSpill?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

height

Devolve a distância em pontos, para 100% de zoom, desde a margem superior do intervalo até à margem inferior do intervalo.

height?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

hidden

Representa se todas as células no intervalo atual estão ocultas. O valor é true quando todas as células num intervalo estão ocultas. O valor é false quando não existem células no intervalo ocultadas. O valor é null quando algumas células num 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 a hiperligação 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

Devolve a distância em pontos, para uma ampliação de 100%, desde a margem esquerda da folha de cálculo até à margem 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 especificado. 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 do 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 especificado, com base nas definições de idioma do utilizador. O Excel não executa qualquer idioma ou coerção de formato ao obter ou definir a numberFormatLocal propriedade. Qualquer texto devolvido utiliza as cadeias formatadas localmente com base no idioma especificado nas definiçõ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 estão ocultas. O valor é true quando todas as linhas num intervalo estão ocultas. O valor é false quando não existem linhas no intervalo ocultadas. O valor é null quando algumas linhas num 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 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 guardadas como uma fórmula de matriz. Devolve true se todas as células fossem guardadas como uma fórmula de matriz ou false se todas as células não fossem guardadas como uma fórmula de matriz. Devolve null se algumas células fossem guardadas como uma fórmula de matriz e algumas não seriam.

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 devolvidos. Para estilos personalizados, o nome do estilo será devolvido. Para estilos incorporados, será devolvida uma cadeia que representa um valor na BuiltInStyle enumeração.

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 do sinal de número (#) que ocorre na IU do Excel não afetará o valor de texto devolvido pela API.

text?: string[][];

Valor da propriedade

string[][]

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

top

Devolve a distância em pontos, para uma ampliação de 100%, desde a margem superior da folha de cálculo até à margem 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 devolvidos podem ser uma cadeia, número ou booleano. Células que contêm um erro retornarão a cadeia de caracteres de erro. Se o valor devolvido começar com uma adição ("+"), sinal de subtração ("-"), ou sinal de igual ("="), o Excel interpreta este 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 deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJson suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região en-US. Para obter dados na região de apresentação do utilizador, utilize 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 deste intervalo. Ao contrário Range.valuesde , Range.valuesAsJsonLocal suporta todos os tipos de dados que podem estar numa célula. Os exemplos incluem valores numéricos formatados e imagens Web, para além dos valores booleanos, numéricos e de cadeia padrão. Os dados devolvidos a partir desta API estão sempre alinhados com a região de apresentação do utilizador. Para obter dados independentemente da região, utilize 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

Devolve a distância em pontos, para um zoom de 100%, desde a margem esquerda do intervalo até à margem direita do intervalo.

width?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.10 ]