LoadFilter
LoadFilter class
Represents the filter that provides options for loading data when loading workbook from template.
abstract class LoadFilter;
Remarks
User may specify the filter options or implement their own LoadFilter to specify how to load data.
Constructors
| Name | Description |
|---|---|
| constructor() | Default Constructor. |
| constructor(LoadDataFilterOptions) | Constructs one LoadFilter with given filter options. |
Methods
| Method | Description |
|---|---|
| getLoadDataFilterOptions() | The filter options to denote what data should be loaded. |
| setLoadDataFilterOptions(LoadDataFilterOptions) | The filter options to denote what data should be loaded. |
| startSheet(Worksheet) | Prepares filter options before loading given worksheet. User’s implementation of LoadFilter can change the LoadDataFilterOptions here to denote how to load data for this worksheet. |
| abstract getSheetsInLoadingOrder() | Specifies the sheets(indices) and order to be loaded. Default is null, that denotes to load all sheets in the default order in template file. If not null and some sheet’s index is not in the returned array, then the sheet will not be loaded. |
constructor()
Default Constructor.
constructor();
constructor(LoadDataFilterOptions)
Constructs one LoadFilter with given filter options.
constructor(opts: LoadDataFilterOptions);
Parameters:
| Parameter | Type | Description |
|---|---|---|
| opts | LoadDataFilterOptions | The default filter options. |
getLoadDataFilterOptions()
The filter options to denote what data should be loaded.
getLoadDataFilterOptions() : LoadDataFilterOptions;
Returns
setLoadDataFilterOptions(LoadDataFilterOptions)
The filter options to denote what data should be loaded.
setLoadDataFilterOptions(value: LoadDataFilterOptions) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | LoadDataFilterOptions | The value to set. |
startSheet(Worksheet)
Prepares filter options before loading given worksheet. User’s implementation of LoadFilter can change the LoadDataFilterOptions here to denote how to load data for this worksheet.
startSheet(sheet: Worksheet) : void;
Parameters:
| Parameter | Type | Description |
|---|---|---|
| sheet | Worksheet | The worksheet to be loaded. /// There are only few properties can be used for the given worksheet object here /// because most data and properties have not been loaded. The available properties are: /// Name, Index, VisibilityType |
getSheetsInLoadingOrder()
Specifies the sheets(indices) and order to be loaded. Default is null, that denotes to load all sheets in the default order in template file. If not null and some sheet’s index is not in the returned array, then the sheet will not be loaded.
abstract getSheetsInLoadingOrder() : number[];
Returns
number[]