Class RVRESTDataSourceItem

REST API data source item

Hierarchy

Index

Accessors

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 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 parameters(): any

    Values for the parameters specified in the data source RVRESTDataSource.url property.

    Returns any

  • set parameters(value: any): void

    Parameters

    • value: any

    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

  • get url(): nullableString

    URL to the REST endpoint. The value will be set as the URL of the item's associated RVRESTDataSource data source object.

    Returns nullableString

    This property is deprecated and will soon be removed. Please set the Url directly on the data source instead.

  • set url(value: nullableString): void

    Parameters

    • value: nullableString

    Returns void