Table of Contents

Interface IProjectTrend

Namespace
NDepend.Project
Assembly
NDepend.API.dll

Represents an NDepend project's settings relative to trend metrics log and diagrams displayed.

public interface IProjectTrend
Extension Methods

Properties (7)

ChartsSettings

Gets or sets the set of trend charts settings to show in the Dashboard panel and in the report.

IReadOnlyList<ChartSettings> ChartsSettings { get; set; }

Property Value

IReadOnlyList<ChartSettings>

Remarks

The order in the list is important since charts will be shown in this order.

CustomLogLabel

Gets or sets the kind of label used to tag trend metrics logs.

TrendMetricsLogLabel CustomLogLabel { get; set; }

Property Value

TrendMetricsLogLabel

Remarks

This value is taken account only if UseCustomLogFrequencyAndLabelValues is set to true.
Else the value defined in Options - Trend Metrics is used..
When the property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.Trend_Settings activated.

CustomLogRecurrence

Gets or sets the frequency of when trend metrics values are logged.

LogRecurrence CustomLogRecurrence { get; set; }

Property Value

LogRecurrence

Remarks

This value is taken account only if UseCustomLogFrequencyAndLabelValues is set to true.
Else the value defined in Options - Trend Metrics is used..
When this property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.Trend_Settings activated.

CustomTrendStoreDirectory

Gets or sets the custom directory where Trend Metrics Values are stored.

IDirectoryPath CustomTrendStoreDirectory { get; set; }

Property Value

IDirectoryPath

Remarks

This path is taken account only if UseCustomTrendStoreDirectory is set to true.
Else the default path $(NdProjectOutputDir)\TrendMetrics is used to store Trend Metrics Values.
An empty value for this property is represented by a null reference..
When the property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.Trend_StoreCustomDirectoryPath activated.

TrendStoreDirectory

Gets the absolute path to the directory that stores Trend Metrics Values.

IAbsoluteDirectoryPath TrendStoreDirectory { get; }

Property Value

IAbsoluteDirectoryPath

Remarks

A ITrendStore object can be obtained from this path thought the extension methods ExtensionMethodsTrend.GetTrendStoreFromDirectory(IAbsoluteDirectoryPath).
The returned path takes account of the values of UseCustomTrendStoreDirectory and CustomTrendStoreDirectory.

UseCustomLogFrequencyAndLabelValues

Gets or sets a boolean that indicates if the values of CustomLogRecurrence and CustomLogLabel are used, or if the values defined in Options - Trend Metrics are used instead.
When the property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.Trend_Settings activated.

bool UseCustomLogFrequencyAndLabelValues { get; set; }

Property Value

bool

UseCustomTrendStoreDirectory

Gets or sets a boolean that indicates if the value of CustomTrendStoreDirectory is used to define the directory that stores Trend Metrics Values, or if the default path $(NdProjectOutputDir)\TrendMetrics is used instead..
When the property is changed, the event IProject.SettingsChanged is triggered with the flag ProjectSettings.Trend_Settings activated.

bool UseCustomTrendStoreDirectory { get; set; }

Property Value

bool

Method (1)

GetTrendMetricsSettingsDescription(LogRecurrence, TrendMetricsLogLabel)

Returns a plain english description of the trend metrics settings.

string GetTrendMetricsSettingsDescription(LogRecurrence defaultLogRecurrence, TrendMetricsLogLabel defaultLogLabel)

Parameters

defaultLogRecurrence LogRecurrence

The log recurrence value defined in the options, used in case UseCustomLogFrequencyAndLabelValues is false.

defaultLogLabel TrendMetricsLogLabel

The log label value defined in the options, used in case UseCustomLogFrequencyAndLabelValues is false.

Returns

string