All
  • Public
  • Public/Protected
  • All

Class RVVisualization

The class representing a visualization (widget) in the dashboard model.

Hierarchy

  • RVVisualization

Index

Accessors

Methods

Accessors

chartType

  • The chart used in this visualization

    Returns RVChartType

filters

id

  • get id(): string

  • The ID of the visualization

    Returns string

referencedDataSourceId

  • get referencedDataSourceId(): null | string

  • Returns the ID of the data source referenced by this visualization (if any).

    Returns null | string

referencedResourceDataSourceId

  • get referencedResourceDataSourceId(): null | string

  • Returns the ID of the data source used by the resource refenced by this visualization (if any). For a visualization getting data from a JSON document loaded from a REST services, this ID will be the ID of the REST data source.

    Returns null | string

showTitle

  • get showTitle(): boolean
  • set showTitle(value: boolean): void

  • Gets the visibility status of the visualization's title and breadcrumb.

    Returns boolean

    • true if the title is visible, false otherwise.

  • Sets the visibility of the visualization's title and breadcrumb.

    Parameters

    • value: boolean

      If true, the title will be shown; if false, it will be hidden.

    Returns void

    • true if the title is visible, false otherwise.

title

  • get title(): string

  • The title of the visualization

    Returns string

Methods

loadFilters

  • loadFilters(): void

  • Analyze the widget model and update the values that are to be returned by the Filters property.

    Returns void

updateFilterSelectedValues

  • updateFilterSelectedValues(filter: RVVisualizationFilter, selectedValues: RVFilterValue[]): boolean

  • Parameters

    Returns boolean