Class BarChartVisualizationViewModelBase

Base class for bar chart visuals.

Inheritance

System.Object

VisualizationViewModel

ChartVisualizationViewModelBase

BarChartVisualizationViewModelBase

ColumnChartVisualizationViewModel

RowChartVisualizationViewModel

Inherited Members

ChartVisualizationViewModelBase.ChartHeight

ChartVisualizationViewModelBase.ChartWidth

ChartVisualizationViewModelBase.SettingsIsExpanded

ChartVisualizationViewModelBase.SettingsExpandIcon

VisualizationViewModel.Id

VisualizationViewModel.Name

VisualizationViewModel.ParentRecommendation

VisualizationViewModel.IsExpanded

VisualizationViewModel.VisualType

Namespace: Phoenix.Polaris.Visualizations

Assembly: Phoenix.Plugin.Polaris.dll

Syntax

public class BarChartVisualizationViewModelBase : ChartVisualizationViewModelBase

Constructors

BarChartVisualizationViewModelBase(BarChartVisualizationViewModelBase)

Initializes a new instance of the BarChartVisualizationViewModelBase class.

Declaration

public BarChartVisualizationViewModelBase(BarChartVisualizationViewModelBase barChartVM)

Parameters

Type	Name	Description
BarChartVisualizationViewModelBase	barChartVM	A bar chart to copy.

BarChartVisualizationViewModelBase(String, String, VisualizationLibrary.VisualizationType, RecommendationViewModel)

Initializes a new instance of the BarChartVisualizationViewModelBase class.

Declaration

public BarChartVisualizationViewModelBase(string id, string name, VisualizationLibrary.VisualizationType visType, RecommendationViewModel parent = null)

Parameters

Type	Name	Description
System.String	id	The visualization id.
System.String	name	The name of this visual.
VisualizationLibrary.VisualizationType	visType	The type of visual.
RecommendationViewModel	parent	The parent recommendation of this visual.

Properties

AvailableColumnsToGroupBy

Gets the current available columns to sort by.

Declaration

public List<string> AvailableColumnsToGroupBy { get; }

Property Value

Type	Description
System.Collections.Generic.List<System.String>

Chart

Gets or sets the chart that is displaying this data.

Declaration

public CartesianChart Chart { get; set; }

Property Value

Type	Description
CartesianChart

ColumnToGroupBy

Gets or sets the current column to group data by.

Declaration

public string ColumnToGroupBy { get; set; }

Property Value

Type	Description
System.String

Data

Gets the data for this visual.

Declaration

public DataTable Data { get; }

Property Value

Type	Description
System.Data.DataTable

Formatter

Gets the function used to format data on an axis.

Declaration

public Func<double, string> Formatter { get; }

Property Value

Type	Description
System.Func<System.Double, System.String>

HasMultipleColumnsToGroupBy

Gets a value indicating whether this data set has multiple ways it can be grouped.

Declaration

public bool HasMultipleColumnsToGroupBy { get; }

Property Value

Type	Description
System.Boolean

Labels

Gets the labels for to be displayed on an axis.

Declaration

public IList<string> Labels { get; }

Property Value

Type	Description
System.Collections.Generic.IList<System.String>

SeriesAxisTitle

Gets the title for the chart's (Row: Y, Column X) axis

Declaration

public string SeriesAxisTitle { get; }

Property Value

Type	Description
System.String

SeriesCollection

Gets the series collection for this chart.

Declaration

public SeriesCollection SeriesCollection { get; }

Property Value

Type	Description
SeriesCollection

SeriesList

Gets the list of series items for toggling enabled state of a series.

Declaration

public ObservableCollection<ChartSeriesListItem> SeriesList { get; }

Property Value

Type	Description
System.Collections.ObjectModel.ObservableCollection<ChartSeriesListItem>

ValueAxisTitle

Gets the title for the chart's (Row: X, Column: Y) axis

Declaration

public string ValueAxisTitle { get; }

Property Value

Type	Description
System.String

Methods

ChangeSeriesVisibility()

Changes the visibility for all the current series. Stops if a series isn't loaded.

Declaration

public void ChangeSeriesVisibility()

ChangeSeriesVisibility(ChartSeriesListItem)

Changes the visibility of a series based on the given item.

Declaration

public void ChangeSeriesVisibility(ChartSeriesListItem item)

Parameters

Type	Name	Description
ChartSeriesListItem	item	The series item to specify which series' visibility to change.

CreateSeries(String)

Used to create a series. Will differ depending on the chart type.

Declaration

public virtual Series CreateSeries(string title)

Parameters

Type	Name	Description
System.String	title	The title of the series.

Returns

Type	Description
Series	A new series.

UpdateData(DataTable)

Update the data for this visual.

Declaration

public override void UpdateData(DataTable data)

Parameters

Type	Name	Description
System.Data.DataTable	data	The data as a DataTable.

Overrides

VisualizationViewModel.UpdateData(DataTable)

UpdateSeriesList()

Updates the series list from the data in the chart.

Declaration

public void UpdateSeriesList()