reveal-sdk-node
Version:
RevealBI Node.js SDK
55 lines (54 loc) • 2.09 kB
TypeScript
import { RVResourceBasedDataSourceItem } from "../AbstractClasses/RVResourceBasedDataSourceItem";
import { RVExcelRange } from "./RVExcelRange";
import { nullableString } from "../types";
import { RVDataSourceItem } from "../AbstractClasses/RVDataSourceItem";
declare type nullableExcelRange = RVExcelRange | null;
/**
* 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.
*/
export declare class RVExcelDataSourceItem extends RVResourceBasedDataSourceItem {
constructor(resourceItem: RVDataSourceItem);
/** @hidden */
constructor(json: any);
/** @hidden */
toJson(): any;
private _sheet;
/**
* Name of the sheet in the worksheet to get the data from, if not specified and @see NamedRange is null,
* then the first sheet in the file will be used.
*/
get sheet(): nullableString;
set sheet(value: nullableString);
private _range;
/**
* Definition of the range to load data from in the specified sheet.
*/
get range(): nullableExcelRange;
set range(value: nullableExcelRange);
private _namedRange;
/**
* Named range to get data from, it's optional and if no specified the sheet specified in @see Sheet
* will be used.
*/
get namedRange(): nullableString;
set namedRange(value: nullableString);
private _pivotTable;
/**
* Name of the pivot table to get data from.
*/
get pivotTable(): nullableString;
set pivotTable(value: nullableString);
private _firstRowContainsLabels;
/**
* Flag indicating if the first row contains labels or data, it defaults to "true".
* If you set this flag to <c>false</c> the columns will be automatically named as 'COL1', 'COL2', etc.
*/
get firstRowContainsLabels(): boolean;
set firstRowContainsLabels(value: boolean);
/** @hidden */
getType(): string;
/** @hidden */
_getWrapper(): any;
}
export {};