Class ColorBar

Namespace

ScottPlot.Panels

Assembly

ScottPlot.dll

An axis panel which displays a colormap and range of values

public class ColorBar : IPanel

Inheritance

object

ColorBar

Implements

IPanel

Inherited Members

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

Extension Methods

IPanelExtensions.IsHorizontal(IPanel)

IPanelExtensions.IsVertical(IPanel)

IPanelExtensions.LockSize(IPanel, float)

IPanelExtensions.ResetSize(IPanel)

DataSourceUtilities.BinarySearch<T, TList>(TList, int, int, T, IComparer<T>?)

DataSourceUtilities.GetClosestIndex<TValue, TList>(TList, TValue, IndexRange, IComparer<TValue>?)

Constructors

ColorBar(IHasColorAxis, Edge)

An axis panel which displays a colormap and range of values

public ColorBar(IHasColorAxis source, Edge edge = Edge.Right)

Parameters

source IHasColorAxis

edge Edge

Properties

Axis

Axis (spine, ticks, label, etc) for the colorbar

public IAxis Axis { get; }

Property Value

IAxis

Edge

Indicates which edge of the data rectangle this panel lays on

public Edge Edge { get; set; }

Property Value

Edge

IsVisible

If false, the panel will not be displayed or report any size

public bool IsVisible { get; set; }

Property Value

bool

Label

Title for the colorbar, displayed outside the ticks.

public string Label { get; set; }

Property Value

string

LabelStyle

Title for the colorbar, displayed outside the ticks.

public LabelStyle LabelStyle { get; }

Property Value

LabelStyle

MaximumSize

Disallow the panel to be larger than this

public float MaximumSize { get; set; }

Property Value

float

MinimumSize

Disallow the panel to be smaller than this

public float MinimumSize { get; set; }

Property Value

float

ShowDebugInformation

Enable this to display extra information on the axis to facilitate development

public bool ShowDebugInformation { get; set; }

Property Value

bool

Source

public IHasColorAxis Source { get; set; }

Property Value

IHasColorAxis

Width

Thickness of the colorbar image (in pixels)

public float Width { get; set; }

Property Value

float

Methods

GetPanelRect(PixelRect, float, float)

Return a rectangle encapsulating the colormap bitmap plus the axis and ticks.

public PixelRect GetPanelRect(PixelRect dataRect, float size, float offset)

Parameters

dataRect PixelRect

size float

offset float

Returns

PixelRect

Measure()

Return the size (in pixels) of the panel in the dimension perpendicular to the edge it lays on

public float Measure()

Returns

float

Render(RenderPack, float, float)

Draw this panel on a canvas

public void Render(RenderPack rp, float size, float offset)

Parameters

rp RenderPack

size float

size of this panel (pixel units)

offset float

distance from the edge of this panel to the edge of the data area