Class RVExcelDataSourceItem

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.

Hierarchy

Index

Accessors

  • get defaultRefreshRate(): number | null

    Returns number | null

  • set defaultRefreshRate(v: number | null): void

    Default value to use for "Refresh Data" setting for visualizations created using this item, expressed in minutes (e.g. 1440 = 1 day). A value of N means that whenever the visualization requests data, the engine will return data found in the cache if it's not older than N minutes -this means, if the engine fetched it from the datasource no more than N minutes before-. If not set it will use the default value set in the data source object.

    Parameters

    • v: number | null

    Returns void

  • get description(): nullableString

    Description of this data source item.

    Returns nullableString

  • set description(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get firstRowContainsLabels(): boolean

    Flag indicating if the first row contains labels or data, it defaults to "true". If you set this flag to false the columns will be automatically named as 'COL1', 'COL2', etc.

    Returns boolean

  • set firstRowContainsLabels(value: boolean): void

    Parameters

    • value: boolean

    Returns void

  • get id(): nullableString

    The value that identifies this item in the data source, it might be for example the name of the schema concatenated with the table name.

    Returns nullableString

  • set id(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get namedRange(): nullableString

    Named range to get data from, it's optional and if no specified the sheet specified in

    Returns nullableString

    Sheet will be used.

  • set namedRange(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get pivotTable(): nullableString

    Name of the pivot table to get data from.

    Returns nullableString

  • set pivotTable(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get range(): nullableExcelRange

    Definition of the range to load data from in the specified sheet.

    Returns nullableExcelRange

  • set range(value: nullableExcelRange): void

    Parameters

    • value: nullableExcelRange

    Returns void

  • get resourceItem(): RVDataSourceItem | null

    The resource item used to get the data for the referenced file, must be an item from one of the resource providers: Sharepoint, Web Resource, REST API, etc.

    Returns RVDataSourceItem | null

  • set resourceItem(value: RVDataSourceItem | null): void

    Parameters

    Returns void

  • get sheet(): nullableString

    Name of the sheet in the worksheet to get the data from, if not specified and

    Returns nullableString

    NamedRange is null, then the first sheet in the file will be used.

  • set sheet(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get subtitle(): nullableString

    The subtitle of the data source, if not null will be displayed to users instead of connection information like host and database name.

    Returns nullableString

  • set subtitle(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void

  • get title(): nullableString

    The title of the item, as displayed to the user, it might be for example the name of the table in a database.

    Returns nullableString

  • set title(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void