Interface IColumn

Namespace: BenchmarkDotNet.Columns
Assembly: BenchmarkDotNet.dll
Syntax
public interface IColumn

Properties

AlwaysShow

Declaration
bool AlwaysShow { get; }
Property Value
Type Description
Boolean

Category

Declaration
ColumnCategory Category { get; }
Property Value
Type Description
ColumnCategory

ColumnName

Display column title in the summary.

Declaration
string ColumnName { get; }
Property Value
Type Description
String

Id

An unique identifier of the column. If there are several columns with the same Id, only one of them will be shown in the summary.

Declaration
string Id { get; }
Property Value
Type Description
String

IsNumeric

Defines if the column's value represents a number

Declaration
bool IsNumeric { get; }
Property Value
Type Description
Boolean

Legend

Column description.

Declaration
string Legend { get; }
Property Value
Type Description
String

PriorityInCategory

Defines order of column in the same category.

Declaration
int PriorityInCategory { get; }
Property Value
Type Description
Int32

UnitType

Defines how to format column's value

Declaration
UnitType UnitType { get; }
Property Value
Type Description
UnitType

Methods

GetValue(Summary, BenchmarkCase)

Value in this column formatted using the default style.

Declaration
string GetValue(Summary summary, BenchmarkCase benchmarkCase)
Parameters
Type Name Description
Summary summary
BenchmarkCase benchmarkCase
Returns
Type Description
String

GetValue(Summary, BenchmarkCase, SummaryStyle)

Value in this column formatted using the specified style.

Declaration
string GetValue(Summary summary, BenchmarkCase benchmarkCase, SummaryStyle style)
Parameters
Type Name Description
Summary summary
BenchmarkCase benchmarkCase
SummaryStyle style
Returns
Type Description
String

IsAvailable(Summary)

Declaration
bool IsAvailable(Summary summary)
Parameters
Type Name Description
Summary summary
Returns
Type Description
Boolean

IsDefault(Summary, BenchmarkCase)

Declaration
bool IsDefault(Summary summary, BenchmarkCase benchmarkCase)
Parameters
Type Name Description
Summary summary
BenchmarkCase benchmarkCase
Returns
Type Description
Boolean

Extension Methods