Web Components Using Worksheets

    The Infragistics Web Components Excel Engine's worksheet is where your data is kept. You can input data by working with the Worksheet's rows and cells and setting their corresponding values. The worksheet allows you to filter, sort, and customize the formats of the cells, as shown below.

    Web Components Using Worksheets Example

    O código a seguir mostra as importações necessárias para usar os trechos de código abaixo:

    import { Workbook } from "igniteui-webcomponents-excel";
import { Worksheet } from "igniteui-webcomponents-excel";
import { WorkbookFormat } from "igniteui-webcomponents-excel";
import { Color } from "igniteui-webcomponents-core";

import { CustomFilterCondition } from "igniteui-webcomponents-excel";
import { ExcelComparisonOperator } from "igniteui-webcomponents-excel";
import { FormatConditionTextOperator } from "igniteui-webcomponents-excel";
import { OrderedSortCondition } from "igniteui-webcomponents-excel";
import { RelativeIndex } from "igniteui-webcomponents-excel";
import { SortDirection } from "igniteui-webcomponents-excel";
import { WorkbookColorInfo } from "igniteui-webcomponents-excel";

    Configuring the Gridlines

    As linhas de grade são usadas para separar visualmente as células na planilha. Você pode mostrar ou ocultar as linhas de grade e também alterar suas cores.

    Você pode mostrar ou ocultar as linhas de grade usando a propriedade showGridlines do displayOptions da planilha. O código a seguir demonstra como você pode ocultar as linhas de grade na sua planilha:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.displayOptions.showGridlines = false;

    Você pode configurar a cor das linhas de grade usando a propriedade gridlineColor do displayOptions da planilha. O código a seguir demonstra como você pode alterar as linhas de grade na sua planilha para vermelho:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.displayOptions.gridlineColor = "Red";

    Configuring the Headers

    Os cabeçalhos de coluna e linha são usados para identificar visualmente colunas e linhas. Eles também são usados para destacar visualmente a célula ou região de célula selecionada no momento.

    Você pode mostrar ou ocultar os cabeçalhos de coluna e linha usando a propriedade showRowAndColumnHeaders do displayOptions da planilha. O código a seguir demonstra como você pode ocultar os cabeçalhos de linha e coluna:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.displayOptions.showRowAndColumnHeaders = false;

    Configuring Editing of the Worksheet

    Por padrão, os objetos worksheet que você salvar serão editáveis. Você pode desabilitar a edição de uma planilha protegendo-a usando o método protect do objeto worksheet. Esse método tem muitos argumentos bool anuláveis que determinam quais partes são protegidas, e uma dessas opções é permitir a edição de objetos, que se definido como false impedirá a edição da planilha.

    O código a seguir demonstra como desabilitar a edição na sua planilha:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.protect();

    Você também pode usar o método protect do objeto worksheet para proteger uma planilha contra alterações estruturais.

    Quando a proteção é definida, você pode definir a propriedade locked do objeto cellFormat em células individuais, linhas, regiões de células mescladas ou colunas para substituir a proteção do objeto de planilha nesses objetos. Por exemplo, se você precisar que todas as células de uma planilha sejam somente leitura, exceto as células de uma coluna, você pode proteger a planilha e, em seguida, definir a propriedade locked do objeto cellFormat como false em um objeto WorksheetColumn específico. Isso permitirá que seus usuários editem células dentro da coluna enquanto desabilitam a edição das outras células na planilha.

    O código a seguir demonstra como você pode fazer isso:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.protect();
worksheet.columns(0).cellFormat.locked = false;

    Filtering Worksheet Regions

    A filtragem é feita definindo uma condição de filtro em WorksheetFilterSettings de uma planilha que pode ser recuperada da propriedade filterSettings do objeto worksheet. As condições de filtro são reaplicadas somente quando são adicionadas, removidas, modificadas ou quando o método reapplyFilters é chamado na planilha. Elas não são constantemente avaliadas conforme os dados dentro da região mudam.

    Você pode especificar a região para aplicar o filtro usando o método setRegion no objeto WorksheetFilterSettings.

    Abaixo está uma lista de métodos e suas descrições que você pode usar para adicionar um filtro a uma planilha:

    Método Descrição
    applyAverageFilter Representa um filtro que pode filtrar dados com base no fato de os dados estarem abaixo ou acima da média de todo o intervalo de dados.
    applyDatePeriodFilter Representa um filtro que pode filtrar datas em um mês ou trimestre de qualquer ano.
    applyFillFilter Representa um filtro que filtrará células com base em seus preenchimentos de fundo. Este filtro especifica um único CellFill. Células com este preenchimento ficarão visíveis no intervalo de dados. Todas as outras células ficarão ocultas.
    ApplyFixedValuesFilter Representa um filtro que pode filtrar células com base em valores específicos e fixos, que podem ser exibidos.
    applyFontColorFilter Representa um filtro que filtrará células com base em suas cores de fonte. Este filtro especifica uma única cor. Células com esta fonte de cor serão visíveis no intervalo de dados. Todas as outras células serão ocultadas.
    applyIconFilter Representa um filtro que pode filtrar células com base em seu ícone de formatação condicional.
    applyRelativeDateRangeFilter Representa um filtro que pode filtrar células de data com base em datas relativas a quando o filtro foi aplicado.
    applyTopOrBottomFilter Representa um filtro que pode filtrar células na parte superior ou inferior dos valores classificados.
    applyYearToDateFilter Representa um filtro que pode filtrar em células de data se as datas ocorrerem entre o início do ano atual e o momento em que o filtro é avaliado.
    applyCustomFilter Representa um filtro que pode filtrar dados com base em uma ou duas condições personalizadas. Essas duas condições de filtro podem ser combinadas com uma operação lógica "e" ou uma operação lógica "ou".

    Você pode usar o seguinte trecho de código como exemplo para adicionar um filtro a uma região da planilha:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.filterSettings.setRegion("Sheet1!A1:A10");
worksheet.filterSettings.applyAverageFilter(0, AverageFilterType.AboveAverage);

    Freezing and Splitting Panes

    Você pode congelar linhas na parte superior da sua planilha ou colunas à esquerda usando os recursos de painéis de congelamento. Linhas e colunas congeladas permanecem visíveis o tempo todo enquanto o usuário rola. As linhas e colunas congeladas são separadas do restante da planilha por uma única linha sólida, que não pode ser removida.

    Para habilitar o congelamento de painéis, você precisa definir a propriedade panesAreFrozen do displayOptions do objeto worksheet como true. Você pode então especificar as linhas ou colunas a serem congeladas usando as propriedades FrozenRows e FrozenColumns das opções de exibição frozenPaneSettings, respectivamente.

    Você também pode especificar a primeira linha no painel inferior ou a primeira coluna no painel direito usando as propriedades FirstRowInBottomPane e FirstColumnInRightPane, respectivamente.

    O trecho de código a seguir demonstra como usar os recursos de congelamento de painéis em uma planilha:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.displayOptions.panesAreFrozen = true;

worksheet.displayOptions.frozenPaneSettings.frozenRows = 3;
worksheet.displayOptions.frozenPaneSettings.frozenColumns = 1;

worksheet.displayOptions.frozenPaneSettings.firstColumnInRightPane = 2;
worksheet.displayOptions.frozenPaneSettings.firstRowInBottomPane = 6;

    Setting the Worksheet Zoom Level

    Você pode alterar o nível de zoom para cada planilha independentemente usando a propriedade MagnificationInNormalView no displayOptions do objeto da worksheet. Essa propriedade assume um valor entre 10 e 400 e representa a porcentagem de zoom que você deseja aplicar.

    O código a seguir demonstra como você pode fazer isso:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.displayOptions.magnificationInNormalView = 300;

    Worksheet Level Sorting

    A classificação é feita definindo uma condição de classificação em um objeto de nível de planilha em colunas ou linhas. Você pode classificar colunas ou linhas em ordem crescente ou decrescente.

    Isso é feito especificando uma região e um tipo de classificação para WorksheetSortSettings do objeto worksheet, que podem ser recuperados usando a propriedade sortSettings da planilha.

    As condições de classificação em uma planilha são reaplicadas somente quando as condições de classificação são adicionadas, removidas, modificadas ou quando o método reapplySortConditions é chamado na planilha. Colunas ou linhas serão classificadas dentro da região. "Linhas" é o tipo de classificação padrão.

    O trecho de código a seguir demonstra como aplicar uma classificação a uma região de células em uma planilha:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.sortSettings.sortConditions().addItem(new RelativeIndex(0), new OrderedSortCondition(SortDirection.Ascending));

    Worksheet Protection

    Você pode proteger uma planilha chamando o método protect no objeto worksheet. Esse método expõe muitos parâmetros bool anuláveis que permitem restringir ou permitir as seguintes operações do usuário:

    • Edição de células.
    • Edição de objetos como formas, comentários, gráficos ou outros controles.
    • Edição de cenários.
    • Filtragem de dados.
    • Formatação de células.
    • Inserir, excluir e formatar colunas.
    • Inserir, excluir e formatar linhas.
    • Inserção de hiperlinks.
    • Classificação de dados.
    • Uso de tabelas dinâmicas.

    Você pode remover a proteção da planilha chamando o método unprotect no objeto worksheet.

    O trecho de código a seguir mostra como habilitar a proteção de todas as operações de usuário listadas acima:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

worksheet.protect();

    Worksheet Conditional Formatting

    Você pode configurar a formatação condicional de um objeto worksheet usando os muitos métodos "Add" expostos na coleção conditionalFormats dessa planilha. O primeiro parâmetro desses métodos "Add" é a região string da planilha à qual você gostaria de aplicar o formato condicional.

    Muitos dos formatos condicionais que você pode adicionar à sua planilha têm uma propriedade cellFormat que determina a maneira como os elementos WorksheetCell devem ficar quando a condição naquele formato condicional for verdadeira. Por exemplo, você pode usar as propriedades anexadas a essa propriedade cellFormat como fill e font para determinar as configurações de plano de fundo e fonte das suas células sob um formato condicional específico, respectivamente.

    Existem alguns formatos condicionais que não têm uma propriedade cellFormat, pois sua visualização na célula da planilha se comporta de forma diferente. Esses formatos condicionais são DataBarConditionalFormat, ColorScaleConditionalFormat e IconSetConditionalFormat.

    Ao carregar uma workbook preexistente do Excel, os formatos serão preservados quando essa workbook for carregada. O mesmo é verdadeiro para quando você salva a workbook em um arquivo do Excel.

    O exemplo de código a seguir demonstra o uso de formatos condicionais em uma planilha:

    var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");

var color = new Color();
color.colorString = "Red";

var format = worksheet.conditionalFormats().addAverageCondition("A1:A10", FormatConditionAboveBelow.AboveAverage);
format.cellFormat.font.colorInfo = new WorkbookColorInfo(color);

    API References