React Using Worksheets
The Infragistics React 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.
React Using Worksheets Example
El siguiente código muestra las importaciones necesarias para utilizar los fragmentos de código siguientes:
import { Workbook } from "igniteui-react-excel";
import { Worksheet } from "igniteui-react-excel";
import { WorkbookFormat } from "igniteui-react-excel";
import { Color } from "igniteui-react-core";
import { CustomFilterCondition } from "igniteui-react-excel";
import { ExcelComparisonOperator } from "igniteui-react-excel";
import { FormatConditionTextOperator } from "igniteui-react-excel";
import { OrderedSortCondition } from "igniteui-react-excel";
import { RelativeIndex } from "igniteui-react-excel";
import { SortDirection } from "igniteui-react-excel";
import { WorkbookColorInfo } from "igniteui-react-excel";
Configuring the Gridlines
Las líneas de cuadrícula se utilizan para separar visualmente las celdas de la hoja de trabajo. Puede mostrar u ocultar las líneas de la cuadrícula y también cambiar su color.
Puedes mostrar o ocultar las líneas de cuadrícula usando lashowGridlines propiedad de ladisplayOptions hoja de cálculo. El siguiente código demuestra cómo puedes ocultar las líneas de cuadrícula en tu hoja de cálculo:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.displayOptions.showGridlines = false;
Puedes configurar el color de las líneas de cuadrícula usando lagridlineColor propiedad de ladisplayOptions hoja de cálculo. El siguiente código demuestra cómo puedes cambiar las líneas de cuadrícula de tu hoja de cálculo para que sean rojas:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.displayOptions.gridlineColor = "Red";
Configuring the Headers
Los encabezados de columnas y filas se utilizan para identificar visualmente columnas y filas. También se utilizan para resaltar visualmente la celda o región de celda actualmente seleccionada.
Puedes mostrar o ocultar los encabezados de columna y fila usando lashowRowAndColumnHeaders propiedad de ladisplayOptions hoja de cálculo. El siguiente código demuestra cómo puedes ocultar los encabezados de fila y columna:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.displayOptions.showRowAndColumnHeaders = false;
Configuring Editing of the Worksheet
Por defecto, losworksheet objetos que guardes serán editables. Puedes desactivar la edición de una hoja de cálculo protegiéndola usando elworksheet método delprotect objeto. Este método tiene muchos argumentos anulablesbool que determinan qué piezas están protegidas, y una de estas opciones es permitir la edición de objetos, lo que si se pone en falso impedirá la edición de la hoja de cálculo.
El siguiente código demuestra cómo deshabilitar la edición en su hoja de trabajo:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.protect();
También puedes usar elworksheet método delprotect objeto para proteger una hoja de cálculo contra cambios estructurales.
Cuando la protección está activada, puedes establecer lacellFormat propiedad dellocked objeto en celdas individuales, filas, regiones de celdas fusionadas o columnas para anular la protección del objeto de hoja de cálculo sobre esos objetos. Por ejemplo, si necesitas que todas las celdas de una hoja de cálculo sean de solo lectura excepto las celdas de una columna, puedes proteger la hoja y luego poner lacellFormat propiedad dellocked objeto en false en un objeto específicoWorksheetColumn. Esto permitirá a tus usuarios editar celdas dentro de la columna mientras desactivan la edición de las otras celdas de la hoja de cálculo.
El siguiente código demuestra cómo puede hacer esto:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.protect();
worksheet.columns(0).cellFormat.locked = false;
Filtering Worksheet Regions
El filtrado se realiza estableciendo una condición de filtro en una hojaWorksheetFilterSettings de cálculo que puede recuperarse de laworksheet propiedad delfilterSettings objeto. Las condiciones de filtro solo se reaplican cuando se añaden, eliminan, modifican o cuando se llama alreapplyFilters método en la hoja de cálculo. No se evalúan constantemente a medida que cambian los datos dentro de la región.
Puedes especificar la región a aplicar el filtro usando elsetRegion método en elWorksheetFilterSettings objeto.
A continuación se muestra una lista de métodos y sus descripciones que puede utilizar para agregar un filtro a una hoja de trabajo:
| Método | Descripción |
|---|---|
applyAverageFilter |
Representa un filtro que puede filtrar datos en función de si están por debajo o por encima del promedio de todo el rango de datos. |
applyDatePeriodFilter |
Representa un filtro que puede filtrar fechas en un mes o trimestre de cualquier año. |
applyFillFilter |
Representa un filtro que filtrará las celdas según sus rellenos de fondo. Este filtro especifica un único CellFill. Las celdas con este relleno serán visibles en el rango de datos. Todas las demás celdas estarán ocultas. |
ApplyFixedValuesFilter |
Representa un filtro que puede filtrar celdas en función de valores fijos específicos, que pueden mostrarse. |
applyFontColorFilter |
Representa un filtro que filtrará las celdas según sus colores de fuente. Este filtro especifica un solo color. Las celdas con esta fuente de color serán visibles en el rango de datos. Todas las demás celdas estarán ocultas. |
applyIconFilter |
Representa un filtro que puede filtrar celdas según su icono de formato condicional. |
applyRelativeDateRangeFilter |
Representa un filtro que puede filtrar celdas de fecha en función de fechas relativas al momento en que se aplicó el filtro. |
applyTopOrBottomFilter |
Representa un filtro que puede filtrar en celdas en la parte superior o inferior de los valores ordenados. |
applyYearToDateFilter |
Representa un filtro que puede filtrar en celdas de fecha si las fechas ocurren entre el inicio del año actual y el momento en que se evalúa el filtro. |
applyCustomFilter |
Representa un filtro que puede filtrar datos según una o dos condiciones personalizadas. Estas dos condiciones de filtro se pueden combinar con una operación lógica "y" o "o". |
Puede utilizar el siguiente fragmento de código como ejemplo para agregar un filtro a una región de la hoja de trabajo:
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
Puede congelar filas en la parte superior de su hoja de trabajo o columnas a la izquierda usando las funciones de paneles de congelación. Las filas y columnas congeladas permanecen visibles en todo momento mientras el usuario se desplaza. Las filas y columnas congeladas están separadas del resto de la hoja de trabajo por una única línea continua que no se puede eliminar.
Para habilitar el congelamiento de paneles, necesitas establecer lapanesAreFrozen propiedad delworksheet objetodisplayOptions en true. Luego puedes especificar las filas o columnas que se congelarán usando lasFrozenRows propiedades yFrozenColumns de las opcionesfrozenPaneSettings de visualización, respectivamente.
También puedes especificar la primera fila en el panel inferior o la primera columna en el panel derecho usando lasFirstRowInBottomPane propiedades yFirstColumnInRightPane respectivamente.
El siguiente fragmento de código demuestra cómo utilizar las funciones de paneles congelados en una hoja de trabajo:
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
Puedes cambiar el nivel de zoom de cada hoja de cálculo de forma independiente usando laMagnificationInNormalView propiedad delworksheet objetodisplayOptions. Esta propiedad toma un valor entre 10 y 400 y representa el porcentaje de zoom que deseas aplicar.
El siguiente código demuestra cómo puede hacer esto:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.displayOptions.magnificationInNormalView = 300;
Worksheet Level Sorting
La clasificación se realiza estableciendo una condición de clasificación en un objeto a nivel de hoja de trabajo, ya sea en columnas o filas. Puede ordenar columnas o filas en orden ascendente o descendente.
Esto se hace especificando una región y un tipo de ordenación a losworksheetWorksheetSortSettings objetos que pueden recuperarse usando lasortSettings propiedad de la hoja.
Las condiciones de ordenación en una hoja solo se reaplican cuando se añaden, eliminan, modifican condiciones de ordenamiento o cuando se llama alreapplySortConditions método en la hoja de cálculo. Las columnas o filas se ordenarán dentro de la región. "Filas" es el tipo de ordenamiento por defecto.
El siguiente fragmento de código demuestra cómo aplicar una clasificación a una región de celdas en una hoja de trabajo:
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
Puedes proteger una hoja de cálculo llamando alprotect método en elworksheet objeto. Este método expone muchos parámetros anulablesbool que permiten restringir o permitir las siguientes operaciones de usuario:
- Edición de celdas.
- Edición de objetos como formas, comentarios, gráficos u otros controles.
- Edición de escenarios.
- Filtrado de datos.
- Formateo de celdas.
- Insertar, eliminar y formatear columnas.
- Insertar, eliminar y formatear filas.
- Inserción de hipervínculos.
- Clasificación de datos.
- Uso de tablas dinámicas.
Puedes eliminar la protección de la hoja de cálculo llamando alunprotect método en elworksheet objeto.
El siguiente fragmento de código muestra cómo habilitar la protección de todas las operaciones de usuario mencionadas anteriormente:
var workbook = new Workbook(WorkbookFormat.Excel2007);
var worksheet = workbook.worksheets().add("Sheet1");
worksheet.protect();
Worksheet Conditional Formatting
Puedes configurar el formato condicional de unworksheet objeto usando los muchos métodos "Añadir" que se exponen en laconditionalFormats colección de esa hoja de trabajo. El primer parámetro de estos métodos "Add" es lastring región de la hoja de cálculo a la que quieres aplicar el formato condicional.
Muchos de los formatos condicionales que puedes añadir a tu hoja tienen unacellFormat propiedad que determina cómo deben verse losWorksheetCell elementos cuando la condición en ese formato condicional se cumple. Por ejemplo, puedes usar las propiedades asociadas a estacellFormat propiedad, comofill yfont para determinar el fondo y la configuración de fuente de tus celdas bajo un formato condicional particular, respectivamente.
Existen algunos formatos condicionales que no tienen unacellFormat propiedad, ya que su visualización en la celda de la hoja de cálculo se comporta de forma diferente. Estos formatos condicionales son elDataBarConditionalFormat,ColorScaleConditionalFormat, yIconSetConditionalFormat.
Al cargar un archivo preexistenteworkbook desde Excel, los formatos se conservarán cuando se cargueworkbook. Lo mismo ocurre cuando guardas laworkbook salida en un archivo de Excel.
El siguiente ejemplo de código demuestra el uso de formatos condicionales en una hoja de trabajo:
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);