Class ContinuousHighlight
Namespace: FastReport.Olap.Highlight
Assembly: FastCube.Mono.dll
Highlight all cells depending on value
public class ContinuousHighlight : GraphicHighlight
Inheritance
object ← CustomHighlight ← GraphicHighlight ← ContinuousHighlight
Inherited Members
GraphicHighlight.Style, GraphicHighlight.Assign(CustomHighlight), GraphicHighlight.DrawExample(Graphics, Rectangle), GraphicHighlight.DrawValue(Graphics, Rectangle, MeasureCell, ref bool, ref bool), GraphicHighlight.GetStyleFor(MeasureCell), GraphicHighlight.Load(XmlItem), GraphicHighlight.Save(XmlItem), GraphicHighlight.StyleChanged(object, EventArgs), CustomHighlight.owner, CustomHighlight.Changed, CustomHighlight.ApplyTo, CustomHighlight.Caption, CustomHighlight.HideValue, CustomHighlight.Index, CustomHighlight.IsCustomDrawn, CustomHighlight.Owner, CustomHighlight.ScanDirection, CustomHighlight.AcceptCell(MeasureCell), CustomHighlight.Assign(CustomHighlight), CustomHighlight.BeginUpdate(), CustomHighlight.EndUpdate(), CustomHighlight.GetExpressions(), CustomHighlight.Load(XmlItem), CustomHighlight.Save(XmlItem), CustomHighlight.DoChange()
Constructors
ContinuousHighlight(CustomHighlights)
Creates a new instance.
public ContinuousHighlight(CustomHighlights owner)
Parameters
owner CustomHighlights
Fields
kindStr
Internal helper.
public static string[] kindStr
Field Value
string[]
Properties
BarAxisColor
Gets bar axis color.
public Color BarAxisColor { get; set; }
Property Value
BarAxisPosition
Axis position to split positive and negative value bars
public ContinuousHighlightBarAxisPosition BarAxisPosition { get; set; }
Property Value
ContinuousHighlightBarAxisPosition
BarColor
Color of the bar chart.
public Color BarColor { get; set; }
Property Value
Caption
Caption for highlight editor
public override string Caption { get; }
Property Value
FrameColor
Color of the bar chart frame
public Color FrameColor { get; set; }
Property Value
GradientDraw
Draw bar chart with gradient from BarColor
public bool GradientDraw { get; set; }
Property Value
HideValue
Defines whether to draw only highlight in the cell without the cell value itself E.g.: bar and icon highlights can be drawn without the value
public override bool HideValue { get; }
Property Value
IconSet
IconSet name
public string IconSet { get; set; }
Property Value
IconSets
Gets map of iconsets.
public static Dictionary<string, IconSetPreset> IconSets { get; }
Property Value
Dictionary<string, IconSetPreset>
IconSetsByIndex
Gets list of iconsets.
public static List<string> IconSetsByIndex { get; }
Property Value
ImageCount
Image count for IconSet
public int ImageCount { get; }
Property Value
Images
ImageList for icons
public ImageList Images { get; }
Property Value
IsCustomDrawn
Defines whether highlight needs to be pained by highlight class
public override bool IsCustomDrawn { get; }
Property Value
Kind
Kind of continuous highlight
public ContinuousHighlightKind Kind { get; set; }
Property Value
MaxValue
Gets or sets maximum value.
public double MaxValue { get; set; }
Property Value
MaxValueColor
Gets or sets color for maximum value.
public Color MaxValueColor { get; set; }
Property Value
MaxValueType
Gets or sets highlight type for max value.
public ContinuousHighlightValueType MaxValueType { get; set; }
Property Value
MidValue
Gets or sets average value.
public double MidValue { get; set; }
Property Value
MidValueColor
Gets or sets color for average value.
public Color MidValueColor { get; set; }
Property Value
MidValueType
Gets or sets hightlight type for average value.
public ContinuousHighlightValueType MidValueType { get; set; }
Property Value
MinValue
Gets or sets minimum value.
public double MinValue { get; set; }
Property Value
MinValueColor
Gets or sets color for minimum value.
public Color MinValueColor { get; set; }
Property Value
MinValueType
Gets or sets hightlight type for minimum value.
public ContinuousHighlightValueType MinValueType { get; set; }
Property Value
NegativeBarColor
Color for negative values of the bar chart
public Color NegativeBarColor { get; set; }
Property Value
NegativeBarColorIsEmpty
Gets indicator that negative bar color is empty.
public bool NegativeBarColorIsEmpty { get; }
Property Value
NegativeFrameColor
Color of the negative values frame of the bar chart
public Color NegativeFrameColor { get; set; }
Property Value
NegativeFrameColorIsEmpty
Gets indicator that negative frame is empty.
public bool NegativeFrameColorIsEmpty { get; }
Property Value
ShowCellValue
Gets or sets condition for showing cell value.
public bool ShowCellValue { get; set; }
Property Value
Methods
AcceptCell(MeasureCell)
Test whether value passes highlight condition
public override bool AcceptCell(MeasureCell cell)
Parameters
cell MeasureCell
cell to test
Returns
True - acceps, False - skips
Assign(CustomHighlight)
Copy settings from source highlight
public override void Assign(CustomHighlight source)
Parameters
source CustomHighlight
Source to copy from
DrawExample(Graphics, Rectangle)
Draw highlight example on the given Graphics and Rectangle
public override void DrawExample(Graphics g, Rectangle r)
Parameters
g Graphics
Graphics to draw on
Rectangle where to draw
DrawIconSet(Graphics, Rectangle, string)
Draw IconSet with the given name on the graphics rectangle
public void DrawIconSet(Graphics g, Rectangle r, string name)
Parameters
g Graphics
Graphics to draw on
Rectangle where to draw
name string
IconSet name
DrawValue(Graphics, Rectangle, MeasureCell, ref bool, ref bool)
Draw measure cell
public override void DrawValue(Graphics g, Rectangle r, MeasureCell Value, ref bool CanDrawImage, ref bool CanDrawText)
Parameters
g Graphics
Graphics to draw on
Rectangle where to draw
Value MeasureCell
Measure cell
CanDrawImage bool
output param which defines whether grid can draw image
CanDrawText bool
output param which defines whether grid can draw text
GetImageIndex(int)
Get icon image index
public int GetImageIndex(int icon)
Parameters
icon int
icon index
Returns
image index
GetImageInfo(int)
Get string representation for particular icon
public string GetImageInfo(int icon)
Parameters
icon int
icon index
Returns
string representation
GetImageValue(int)
Get icon value
public double GetImageValue(int icon)
Parameters
icon int
icon index
Returns
value
GetImageValueCondition(int)
Get icon compare condition
public ContinuousHighlightIconCondition GetImageValueCondition(int icon)
Parameters
icon int
icon index
Returns
ContinuousHighlightIconCondition
icon compare condition
GetImageValueType(int)
Get icon value type
public ContinuousHighlightValueType GetImageValueType(int icon)
Parameters
icon int
icon index
Returns
value type
GetStyleFor(MeasureCell)
Get style for measure cell
public override Style GetStyleFor(MeasureCell Value)
Parameters
Value MeasureCell
Returns
draw Style
Load(XmlItem)
Load from XML
public override void Load(XmlItem item)
Parameters
item XmlItem
XML Item
LoadPreset(ContinuousHighlightKind, string)
Load highlight preset
public bool LoadPreset(ContinuousHighlightKind kind, string name)
Parameters
Continuous highlight kind
name string
Preset to load
Returns
Success or fail
Save(XmlItem)
Save to XML
public override void Save(XmlItem item)
Parameters
item XmlItem
XML Item
SetImageIndex(int, int)
Sets image index for icon.
public void SetImageIndex(int icon, int imageIndex)
Parameters
icon int
imageIndex int
SetImageReverseOrder()
Reverse icon direction for IconSet kind
public void SetImageReverseOrder()
SetImageValue(int, double)
Sets value for icon.
public void SetImageValue(int icon, double value)
Parameters
icon int
value double
SetImageValueCondition(int, ContinuousHighlightIconCondition)
Sets condition type for icon.
public void SetImageValueCondition(int icon, ContinuousHighlightIconCondition value)
Parameters
icon int
value ContinuousHighlightIconCondition
SetImageValueType(int, ContinuousHighlightValueType)
Sets hightight type for icon.
public void SetImageValueType(int icon, ContinuousHighlightValueType value)
Parameters
icon int
value ContinuousHighlightValueType
StyleChanged(object, EventArgs)
Handles style changed event.
protected override void StyleChanged(object sender, EventArgs e)
Parameters
sender object
ToString()
Returns a string that represents the current object.
public override string ToString()
Returns
A string that represents the current object.