Class FeedVisualizationViewModel

Class for the feed visual.

Inheritance

System.Object

FeedVisualizationViewModel

Implements

System.IDisposable

Namespace: Phoenix.Polaris.Visualizations

Assembly: Phoenix.Plugin.Polaris.dll

Syntax

public class FeedVisualizationViewModel : BindableBase, IDisposable

Constructors

FeedVisualizationViewModel(Boolean, Boolean, Int32, Boolean, RecommendationSetViewModel)

Initializes a new instance of the FeedVisualizationViewModel class.

Declaration

public FeedVisualizationViewModel(bool isVertical = true, bool isCondensed = false, int messageDisplayLimit = 200, bool noLimitOnDisplayMessageCount = false, RecommendationSetViewModel parent = null)

Parameters

Type	Name	Description
System.Boolean	isVertical	Whether the feed should start vertical.
System.Boolean	isCondensed	Whether the feed should start condensed.
System.Int32	messageDisplayLimit	The number of messages to keep displayed in the feed.
System.Boolean	noLimitOnDisplayMessageCount	Whether there is a limit on the number of messages displayed in the feed.
RecommendationSetViewModel	parent	The recommendation set that is the parent of this feed.

Fields

DefaultMessageDisplayLimit

The default message display limit.

Declaration

public const int DefaultMessageDisplayLimit = 200

Field Value

Type	Description
System.Int32

Properties

IsCondensed

Gets or sets a value indicating whether the console feed should be using a condensed mode.

Declaration

public bool IsCondensed { get; set; }

Property Value

Type	Description
System.Boolean

IsCondensedToolTip

Gets the tooltip associated with the IsCondensed button.

Declaration

public static string IsCondensedToolTip { get; }

Property Value

Type	Description
System.String

IsVertical

Gets or sets a value indicating whether the console feed should be vertical or horizontal.

Declaration

public bool IsVertical { get; set; }

Property Value

Type	Description
System.Boolean

IsVerticalToolTip

Gets the tooltip associated with the IsVertical button.

Declaration

public string IsVerticalToolTip { get; }

Property Value

Type	Description
System.String

MessageDisplayLimit

Gets or sets the number of messages to keep displayed in the feed.

Declaration

public int MessageDisplayLimit { get; set; }

Property Value

Type	Description
System.Int32

MessageDisplayLimitTooltip

Gets the tooltip associated with the message display limit button.

Declaration

public static string MessageDisplayLimitTooltip { get; }

Property Value

Type	Description
System.String

Messages

Gets the collection of messages.

Declaration

public ObservableCollection<FeedItem> Messages { get; }

Property Value

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

NoLimitOnDisplayMessageCount

Gets or sets a value indicating whether there should be a limit on the number of messages kept in the feed.

Declaration

public bool NoLimitOnDisplayMessageCount { get; set; }

Property Value

Type	Description
System.Boolean

ShowSettings

Gets or sets a value indicating whether to show the settings in the UI.

Declaration

public bool ShowSettings { get; set; }

Property Value

Type	Description
System.Boolean

Methods

AddMessage(FeedItem)

Adds a new message to the feed. Will remove the oldest 10% of messages if the message display limit is reached.

Declaration

public void AddMessage(FeedItem message)

Parameters

Type	Name	Description
FeedItem	message	The message to be added.

Dispose()

Declaration

public void Dispose()

Shutdown()

Cancels remove messages loop if needed.

Declaration

public void Shutdown()

Implements

System.IDisposable