Compartilhar via

Excel.Interfaces.WorksheetData interface

  • Referência
Pacote:
excel

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

Propriedades

autoFilter

Representa o AutoFilter objeto da folha de cálculo.
charts

Devolve uma coleção de gráficos que fazem parte da folha de cálculo.
comments

Retorna um conjunto de todos os objetos Comments na planilha.
customProperties

Obtém uma coleção de propriedades personalizadas ao nível da folha de cálculo.
enableCalculation

Determina se o Excel deve recalcular a folha de cálculo quando necessário. Verdadeiro se o Excel recalcular a folha de cálculo quando necessário. False se o Excel não recalcular a planilha.
horizontalPageBreaks

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.
id

Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.
name

O nome de exibição da planilha. O nome tem de ter menos de 32 carateres.
names

Coleção de nomes com escopo para a planilha atual.
notes

Devolve uma coleção de todos os objetos de notas na folha de cálculo.
pageLayout

Obtém o PageLayout objeto da folha de cálculo.
pivotTables

Coleção de Tabelas Dinâmicas que fazem parte da planilha.
position

A posição baseada em zero da planilha na pasta de trabalho.
protection

Devolve o objeto de proteção de folha para uma folha de cálculo.
shapes

Retorna a coleção de todos os objetos Shape na planilha.
showGridlines

Especifica se as linhas de grelha estão visíveis para o utilizador.
showHeadings

Especifica se os cabeçalhos estão visíveis para o utilizador.
slicers

Devolve uma coleção de segmentações de dados que fazem parte da folha de cálculo.
standardHeight

Retorna a altura padrão de todas as linhas na planilha, em pontos.
standardWidth

Especifica a largura padrão (predefinida) de todas as colunas na folha de cálculo. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).
tabColor

A cor do separador da folha de cálculo. Ao obter a cor do separador, se a folha de cálculo for invisível, o valor será null. Se a folha de cálculo estiver visível, mas a cor do separador estiver definida como automática, será devolvida uma cadeia vazia. Caso contrário, a propriedade será definida como uma cor, no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, utilize uma cadeia vazia para definir uma cor "automática" ou uma cor real.
tabId

Devolve um valor que representa esta folha de cálculo que pode ser lida por Open Office XML. Trata-se de um valor inteiro, diferente de worksheet.id (que devolve um identificador exclusivo global) e worksheet.name (que devolve um valor como "Folha1").
tables

Coleção de tabelas que fazem parte da planilha.
verticalPageBreaks

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.
visibility

A visibilidade da planilha.

Detalhes da propriedade

autoFilter

Representa o AutoFilter objeto da folha de cálculo.

autoFilter?: Excel.Interfaces.AutoFilterData;

Valor da propriedade

Excel.Interfaces.AutoFilterData

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

charts

Devolve uma coleção de gráficos que fazem parte da folha de cálculo.

charts?: Excel.Interfaces.ChartData[];

Valor da propriedade

Excel.Interfaces.ChartData[]

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

comments

Retorna um conjunto de todos os objetos Comments na planilha.

comments?: Excel.Interfaces.CommentData[];

Valor da propriedade

Excel.Interfaces.CommentData[]

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

customProperties

Obtém uma coleção de propriedades personalizadas ao nível da folha de cálculo.

customProperties?: Excel.Interfaces.WorksheetCustomPropertyData[];

Valor da propriedade

Excel.Interfaces.WorksheetCustomPropertyData[]

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

enableCalculation

Determina se o Excel deve recalcular a folha de cálculo quando necessário. Verdadeiro se o Excel recalcular a folha de cálculo quando necessário. False se o Excel não recalcular a planilha.

enableCalculation?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

horizontalPageBreaks

Obtém a coleção de quebra de página horizontal da planilha. Esta coleção contém apenas quebras de página manuais.

horizontalPageBreaks?: Excel.Interfaces.PageBreakData[];

Valor da propriedade

Excel.Interfaces.PageBreakData[]

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

id

Retorna um valor que identifica de forma exclusiva a planilha em uma determinada pasta de trabalho. O valor do identificador permanece o mesmo, ainda que a planilha seja renomeada ou movida.

id?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

name

O nome de exibição da planilha. O nome tem de ter menos de 32 carateres.

name?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

names

Coleção de nomes com escopo para a planilha atual.

names?: Excel.Interfaces.NamedItemData[];

Valor da propriedade

Excel.Interfaces.NamedItemData[]

Comentários

[ Conjunto de API: ExcelApi 1.4 ]

notes

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.

Devolve uma coleção de todos os objetos de notas na folha de cálculo.

notes?: Excel.Interfaces.NoteData[];

Valor da propriedade

Excel.Interfaces.NoteData[]

Comentários

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

pageLayout

Obtém o PageLayout objeto da folha de cálculo.

pageLayout?: Excel.Interfaces.PageLayoutData;

Valor da propriedade

Excel.Interfaces.PageLayoutData

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

pivotTables

Coleção de Tabelas Dinâmicas que fazem parte da planilha.

pivotTables?: Excel.Interfaces.PivotTableData[];

Valor da propriedade

Excel.Interfaces.PivotTableData[]

Comentários

[ Conjunto de API: ExcelApi 1.3 ]

position

A posição baseada em zero da planilha na pasta de trabalho.

position?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

protection

Devolve o objeto de proteção de folha para uma folha de cálculo.

protection?: Excel.Interfaces.WorksheetProtectionData;

Valor da propriedade

Excel.Interfaces.WorksheetProtectionData

Comentários

[ Conjunto de API: ExcelApi 1.2 ]

shapes

Retorna a coleção de todos os objetos Shape na planilha.

shapes?: Excel.Interfaces.ShapeData[];

Valor da propriedade

Excel.Interfaces.ShapeData[]

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

showGridlines

Especifica se as linhas de grelha estão visíveis para o utilizador.

showGridlines?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

showHeadings

Especifica se os cabeçalhos estão visíveis para o utilizador.

showHeadings?: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.8 ]

slicers

Devolve uma coleção de segmentações de dados que fazem parte da folha de cálculo.

slicers?: Excel.Interfaces.SlicerData[];

Valor da propriedade

Excel.Interfaces.SlicerData[]

Comentários

[ Conjunto de API: ExcelApi 1.10 ]

standardHeight

Retorna a altura padrão de todas as linhas na planilha, em pontos.

standardHeight?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

standardWidth

Especifica a largura padrão (predefinida) de todas as colunas na folha de cálculo. Uma unidade de largura de coluna equivale à largura de um caractere no estilo Normal. Para fontes proporcionais, será usada a largura do caractere 0 (zero).

standardWidth?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tabColor

A cor do separador da folha de cálculo. Ao obter a cor do separador, se a folha de cálculo for invisível, o valor será null. Se a folha de cálculo estiver visível, mas a cor do separador estiver definida como automática, será devolvida uma cadeia vazia. Caso contrário, a propriedade será definida como uma cor, no formato #RRGGBB (por exemplo, "FFA500"). Ao definir a cor, utilize uma cadeia vazia para definir uma cor "automática" ou uma cor real.

tabColor?: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

tabId

Devolve um valor que representa esta folha de cálculo que pode ser lida por Open Office XML. Trata-se de um valor inteiro, diferente de worksheet.id (que devolve um identificador exclusivo global) e worksheet.name (que devolve um valor como "Folha1").

tabId?: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.14 ]

tables

Coleção de tabelas que fazem parte da planilha.

tables?: Excel.Interfaces.TableData[];

Valor da propriedade

Excel.Interfaces.TableData[]

Comentários

[ Conjunto de API: ExcelApi 1.1 ]

verticalPageBreaks

Obtém a coleção de quebra de página vertical da planilha. Esta coleção contém apenas quebras de página manuais.

verticalPageBreaks?: Excel.Interfaces.PageBreakData[];

Valor da propriedade

Excel.Interfaces.PageBreakData[]

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

visibility

A visibilidade da planilha.

visibility?: Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden";

Valor da propriedade

Excel.SheetVisibility | "Visible" | "Hidden" | "VeryHidden"

Comentários

[ Conjunto de API: ExcelApi 1.1 para visibilidade de leitura; 1.2 para defini-lo. ]