StiProgressVisual Class
Namespace: Stimulsoft.Dashboard.Visuals.Progress
This is a base class to work with the progress element visualization.
Inheritance
Inherits from: StiVisual
Constructors
| Constructor | Description |
|---|---|
| StiProgressVisual(StiProgressElement element, List<StiProgressIteration> iterations) |
StiProgressVisual(element: StiProgressElement, iterations: List<StiProgressIteration>)
Parameters
- element (StiProgressElement)
- iterations (List<StiProgressIteration>)
Properties
| Property | Type | Description |
|---|---|---|
| Element | StiProgressElement | |
| Iterations | List<StiProgressIteration> | |
| MinElementSide | byte | |
| MinFontSize | byte | |
| Style | StiProgressElementStyle |
Methods
| Method | Returns | Description |
|---|---|---|
| GetColor | Color | |
| GetColors | Color[] | |
| GetDisplayText | string | |
| GetInteractionDataGeom | StiInteractionDataGeom | |
| GetTargetValues | List |
|
| GetTextValues | List |
|
| ProcessColor | Color | |
| ProcessFontName | string | |
| ProcessFontStyle | FontStyle | |
| ProcessForeColor | Color | |
| ProcessTrackColor | Color |
Method Details
GetColor
GetColor(index: int): Color
Parameters
- index (int)
Returns Color
GetColors
GetColors(seriesCount: int): Color[]
Parameters
- seriesCount (int)
Returns Color[]
GetDisplayText
GetDisplayText(iteration: StiProgressIteration, valuePercent: decimal): string
Parameters
- iteration (StiProgressIteration)
- valuePercent (decimal)
Returns string
GetInteractionDataGeom
GetInteractionDataGeom(iteration: StiProgressIteration): StiInteractionDataGeom
Parameters
- iteration (StiProgressIteration)
Returns StiInteractionDataGeom
GetTargetValues
GetTargetValues(): List
Returns List
GetTextValues
GetTextValues(): List
Returns List
ProcessColor
ProcessColor(color: Color, iteration: StiProgressIteration): Color
Parameters
- color (Color)
- iteration (StiProgressIteration)
Returns Color
ProcessFontName
ProcessFontName(fontName: string, iteration: StiProgressIteration): string
Parameters
- fontName (string)
- iteration (StiProgressIteration)
Returns string
ProcessFontStyle
ProcessFontStyle(fontText: Font, iteration: StiProgressIteration): FontStyle
Parameters
- fontText (Font)
- iteration (StiProgressIteration)
Returns FontStyle
ProcessForeColor
ProcessForeColor(iteration: StiProgressIteration, defaultColor: Color?): Color
Parameters
- iteration (StiProgressIteration)
- defaultColor (Color?)
Returns Color
ProcessTrackColor
ProcessTrackColor(color: Color, iteration: StiProgressIteration): Color
Parameters
- color (Color)
- iteration (StiProgressIteration)
Returns Color