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

Constructors

constructor

  • Parameters

    • resourceItem: RVDataSourceItem

    Returns RVExcelDataSourceItem

Accessors

dataSource

  • get dataSource(): RVDashboardDataSource
  • set dataSource(value: RVDashboardDataSource): void
  • Reference to the data source object this item belongs to.

    Returns RVDashboardDataSource

  • Reference to the data source object this item belongs to.

    Parameters

    • value: RVDashboardDataSource

    Returns void

defaultRefreshRate

  • get defaultRefreshRate(): null | number
  • set defaultRefreshRate(v: null | number): 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.

    Returns null | number

  • 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: null | number

    Returns void

description

  • get description(): nullableString
  • set description(value: nullableString): void
  • Description of this data source item.

    Returns nullableString

  • Description of this data source item.

    Parameters

    • value: nullableString

    Returns void

firstRowContainsLabels

  • get firstRowContainsLabels(): boolean
  • set firstRowContainsLabels(value: boolean): void
  • 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

  • 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.

    Parameters

    • value: boolean

    Returns void

id

  • get id(): nullableString
  • set id(value: nullableString): void
  • 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

  • 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.

    Parameters

    • value: nullableString

    Returns void

namedRange

  • get namedRange(): nullableString
  • set namedRange(value: nullableString): void
  • Named range to get data from, it's optional and if no specified the sheet specified in @see Sheet will be used.

    Returns nullableString

  • Named range to get data from, it's optional and if no specified the sheet specified in @see Sheet will be used.

    Parameters

    • value: nullableString

    Returns void

pivotTable

  • get pivotTable(): nullableString
  • set pivotTable(value: nullableString): void
  • Name of the pivot table to get data from.

    Returns nullableString

  • Name of the pivot table to get data from.

    Parameters

    • value: nullableString

    Returns void

range

  • get range(): nullableExcelRange
  • set range(value: nullableExcelRange): void
  • Definition of the range to load data from in the specified sheet.

    Returns nullableExcelRange

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

    Parameters

    • value: nullableExcelRange

    Returns void

resourceItem

  • get resourceItem(): null | RVDataSourceItem
  • set resourceItem(value: null | RVDataSourceItem): void
  • 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 null | RVDataSourceItem

  • 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.

    Parameters

    • value: null | RVDataSourceItem

    Returns void

sheet

  • get sheet(): nullableString
  • set sheet(value: nullableString): void
  • 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.

    Returns nullableString

  • 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.

    Parameters

    • value: nullableString

    Returns void

subtitle

  • get subtitle(): nullableString
  • set subtitle(value: nullableString): void
  • 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

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

    Parameters

    • value: nullableString

    Returns void

title

  • get title(): nullableString
  • set title(value: nullableString): void
  • 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

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

    Parameters

    • value: nullableString

    Returns void