Class RVExcelDataSourceItem
- java.lang.Object
-
- com.infragistics.reveal.sdk.api.model.RVDataSourceItem
-
- com.infragistics.reveal.sdk.api.model.RVResourceBasedDataSourceItem
-
- com.infragistics.reveal.sdk.api.model.RVExcelDataSourceItem
-
- Direct Known Subclasses:
RVGoogleSheetDataSourceItem
public class RVExcelDataSourceItem extends RVResourceBasedDataSourceItem
The data source item used to represent a dataset from an Excel file, it includes information like the name of the sheet to get data from and the range to use when loading data.
-
-
Constructor Summary
Constructors Constructor Description RVExcelDataSourceItem(IRVResourceItem resourceItem)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
getFirstRowContainsLabels()
If you set this flag tofalse
the columns will be automatically named as 'COL1', 'COL2', etc.String
getNamedRange()
Named range to get data from, it's optional and if no specified the sheet specified ingetSheet()
will be used.String
getPivotTable()
RVExcelRange
getRange()
Definition of the range to load data from in the specified sheet.String
getSheet()
Name of the sheet in the worksheet to get the data from, if not specified andgetNamedRange()
isnull
, then the first sheet in the file will be used.boolean
setFirstRowContainsLabels(boolean value)
If you set this flag tofalse
the columns will be automatically named as 'COL1', 'COL2', etc.String
setNamedRange(String value)
Named range to get data from, it's optional and if no specified the sheet specified ingetSheet()
will be used.String
setPivotTable(String value)
RVExcelRange
setRange(RVExcelRange value)
Definition of the range to load data from in the specified sheet.String
setSheet(String value)
Name of the sheet in the worksheet to get the data from, if not specified andgetNamedRange()
isnull
, then the first sheet in the file will be used.-
Methods inherited from class com.infragistics.reveal.sdk.api.model.RVResourceBasedDataSourceItem
getResourceItem, setResourceItem
-
Methods inherited from class com.infragistics.reveal.sdk.api.model.RVDataSourceItem
getDataSource, getDefaultRefreshRate, getDescription, getId, getSubtitle, getTitle, setDataSource, setDefaultRefreshRate, setDescription, setId, setSubtitle, setTitle
-
-
-
-
Constructor Detail
-
RVExcelDataSourceItem
public RVExcelDataSourceItem(IRVResourceItem resourceItem)
-
-
Method Detail
-
setSheet
public String setSheet(String value)
Name of the sheet in the worksheet to get the data from, if not specified andgetNamedRange()
isnull
, then the first sheet in the file will be used.- Parameters:
value
-- Returns:
-
getSheet
public String getSheet()
Name of the sheet in the worksheet to get the data from, if not specified andgetNamedRange()
isnull
, then the first sheet in the file will be used.- Returns:
-
setRange
public RVExcelRange setRange(RVExcelRange value)
Definition of the range to load data from in the specified sheet.- Parameters:
value
-- Returns:
-
getRange
public RVExcelRange getRange()
Definition of the range to load data from in the specified sheet.- Returns:
-
setNamedRange
public String setNamedRange(String value)
Named range to get data from, it's optional and if no specified the sheet specified ingetSheet()
will be used.- Parameters:
value
-- Returns:
-
getNamedRange
public String getNamedRange()
Named range to get data from, it's optional and if no specified the sheet specified ingetSheet()
will be used.- Returns:
-
getPivotTable
public String getPivotTable()
-
setFirstRowContainsLabels
public boolean setFirstRowContainsLabels(boolean value)
If you set this flag tofalse
the columns will be automatically named as 'COL1', 'COL2', etc.- Parameters:
value
-- Returns:
-
getFirstRowContainsLabels
public boolean getFirstRowContainsLabels()
If you set this flag tofalse
the columns will be automatically named as 'COL1', 'COL2', etc.- Returns:
-
-