Table of Contents

Interface IColumn

Namespace
BenchmarkDotNet.Columns
Assembly
BenchmarkDotNet.dll
public interface IColumn
Extension Methods

Properties

AlwaysShow 

bool AlwaysShow { get; }

Property Value

bool

Category 

ColumnCategory Category { get; }

Property Value

ColumnCategory

ColumnName

Display column title in the summary.

string ColumnName { get; }

Property Value

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.

string Id { get; }

Property Value

string

IsNumeric

Defines if the column's value represents a number

bool IsNumeric { get; }

Property Value

bool

Legend

Column description.

string Legend { get; }

Property Value

string

PriorityInCategory

Defines order of column in the same category.

int PriorityInCategory { get; }

Property Value

int

UnitType

Defines how to format column's value

UnitType UnitType { get; }

Property Value

UnitType

Methods

GetValue(Summary, BenchmarkCase)

Value in this column formatted using the default style.

string GetValue(Summary summary, BenchmarkCase benchmarkCase)

Parameters

summary Summary
benchmarkCase BenchmarkCase

Returns

string

GetValue(Summary, BenchmarkCase, SummaryStyle)

Value in this column formatted using the specified style.

string GetValue(Summary summary, BenchmarkCase benchmarkCase, SummaryStyle style)

Parameters

summary Summary
benchmarkCase BenchmarkCase
style SummaryStyle

Returns

string

IsAvailable(Summary) 

bool IsAvailable(Summary summary)

Parameters

summary Summary

Returns

bool

IsDefault(Summary, BenchmarkCase) 

bool IsDefault(Summary summary, BenchmarkCase benchmarkCase)

Parameters

summary Summary
benchmarkCase BenchmarkCase

Returns

bool