Class CompassObjectsVisualizationViewModel

Class for displaying a compass object visual.

Inheritance
System.Object
VisualizationViewModel
CompassObjectsVisualizationViewModel
Inherited Members
Namespace: Phoenix.Polaris.Visualizations
Assembly: Phoenix.Plugin.Polaris.dll
Syntax
public class CompassObjectsVisualizationViewModel : VisualizationViewModel

Constructors

View Source

CompassObjectsVisualizationViewModel(String, String, DataTable, CompassViewModel, Boolean, RecommendationViewModel)

Initializes a new instance of the CompassObjectsVisualizationViewModel class.

Declaration
public CompassObjectsVisualizationViewModel(string id, string name, DataTable data, CompassViewModel compass, bool sortingEnabled = true, RecommendationViewModel parent = null)
Parameters
Type Name Description
System.String id

The visualization id.
System.String name

The name of this visual.
System.Data.DataTable data

The data associated with this visual.
CompassViewModel compass

The compass that this visual will be sending data to.
System.Boolean sortingEnabled

Whether to allow sorting of the object list table.
RecommendationViewModel parent

The parent recommendation of this visual.

Properties

View Source

ColumnNames

Gets the list of column names for this data set.

Declaration
public List<string> ColumnNames { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>
View Source

CompassGameObjects

Gets the list of compass game objects for this compass visual request.

Declaration
public List<CompassGameObject> CompassGameObjects { get; }
Property Value
Type Description
System.Collections.Generic.List<CompassGameObject>
View Source

Data

Gets or sets the data for this visual.

Declaration
public DataTable Data { get; set; }
Property Value
Type Description
System.Data.DataTable
View Source

HasObjectTypeGroupings

Gets a value indicating whether this compass object set has object type groupings.

Declaration
public bool HasObjectTypeGroupings { get; }
Property Value
Type Description
System.Boolean
View Source

ObjectsTable

Gets the table with the object data.

Declaration
public TableVisualizationViewModel ObjectsTable { get; }
Property Value
Type Description
TableVisualizationViewModel
View Source

ObjectTypes

Gets the collection of object types and whether they are for the entire set (true) or based on a column (false).

Declaration
public ObservableCollection<Tuple<bool, string>> ObjectTypes { get; }
Property Value
Type Description
System.Collections.ObjectModel.ObservableCollection<System.Tuple<System.Boolean, System.String>>

Methods

View Source

CreateCompassObjectsByColumn(String, Boolean)

Creates a type grouping of compass objects based on a column name.

Declaration
public void CreateCompassObjectsByColumn(string typeColumnName, bool dataUpdated = false)
Parameters
Type Name Description
System.String typeColumnName

The column name to group objects by.
System.Boolean dataUpdated

Whether or not the data behind has updated or the just the sorting was updated.
View Source

CreateCompassObjectsByEntireSetType(String, Boolean)

Creates a type grouping for the entire set of objects with the given name.

Declaration
public void CreateCompassObjectsByEntireSetType(string setTypeName, bool dataUpdated = false)
Parameters
Type Name Description
System.String setTypeName

The name of the grouping.
System.Boolean dataUpdated

Whether or not the data behind has updated or the just the sorting was updated.
View Source

RemoveGrouping(Tuple<Boolean, String>)

Removes a type grouping for this object set.

Declaration
public void RemoveGrouping(Tuple<bool, string> itemToRemove)
Parameters
Type Name Description
System.Tuple<System.Boolean, System.String> itemToRemove

The type grouping item to remove.
View Source

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