Difference between revisions of "LGUI2:progressbar"

From Lavish Software Wiki
Jump to navigation Jump to search
 
Line 2: Line 2:
  
 
== Defining a progressbar element ==
 
== Defining a progressbar element ==
An progressbar element is an [[LGUI2:Element|Element]] with additional properties used to display the gauge.
+
An progressbar element is an [[LGUI2:Element|Element]] with additional properties for a standard [[LGUI2:Border|Border]] as well as to display the gauge.
  
 
{| border="1" style="border-collapse:collapse" cellpadding="5"
 
{| border="1" style="border-collapse:collapse" cellpadding="5"
Line 27: Line 27:
 
! value
 
! value
 
| An integer (whole number) specifying the current value for the progressbar, or '''0 by default'''.
 
| An integer (whole number) specifying the current value for the progressbar, or '''0 by default'''.
 +
|-
 +
! borderBrush
 +
| A [[LGUI2:Brush|Brush]] definition specifying the brush for the standard Border
 +
|-
 +
! backgroundBrush
 +
| A [[LGUI2:Brush|Brush]] definition specifying the brush for the background inside the Border
 +
|-
 +
! borderThickness
 +
| A [[LGUI2:Thickness|Thickness]] definition specifying the thickness for the standard Border
 
|}
 
|}
  

Latest revision as of 22:44, 15 July 2018

A LavishGUI 2 progressbar element is a gauge that shows graphically how full or complete something is.

Defining a progressbar element

An progressbar element is an Element with additional properties for a standard Border as well as to display the gauge.

Expander element properties
textblock An Element definition specifying the properties of an optional text display, e.g. to show a percent value
text One of "none" "percent" "value" "value/max", specifying the way the progressbar should use the optional textblock
fillerBrush A Brush definition specifying the brush for the progressbar filler
overlayBrush A Brush definition specifying the brush for the optional progressbar filler overlay
minValue An integer (whole number) specifying the minimum value for the progressbar, or 0 by default.
maxValue An integer (whole number) specifying the maximum value for the progressbar, or 100 by default.
value An integer (whole number) specifying the current value for the progressbar, or 0 by default.
borderBrush A Brush definition specifying the brush for the standard Border
backgroundBrush A Brush definition specifying the brush for the background inside the Border
borderThickness A Thickness definition specifying the thickness for the standard Border

Examples

{
  "type": "progressbar",
  "borderThickness": 1,
  "borderBrush": { "color": [ 1.0, 1.0, 1.0 ] },
  "width": 200,
  "backgroundBrush": { "color": [ 0, 0, 0 ] },
  "fillerBrush": { "color": [ 0, 0, 1.0 ] },
  "value": 90,
  "text": "percent"
}

LavishGUI 2 Element Types

LavishGUI 2 LavishScript Object Types

Core API (see Using LavishGUI 2 from LavishScript)
lgui2 - lgui2animateargs - lgui2animationtype - lgui2elementref - lgui2eventargs - lgui2eventhandler - lgui2elementtype - lgui2itemviewgeneratorargs - lgui2inputbinding - lgui2layer - lgui2skin - lgui2trigger
Enums
elgui2animationframestate - elgui2dpad - elgui2edge - elgui2fontflags - elgui2horizontalalignment - elgui2imageorientation - elgui2progresstext - elgui2scrollbar - elgui2sizetocontent - elgui2verticalignment - elgui2visibility
Element Components
lgui2animation - lgui2brush - lgui2fontstyle - lgui2margins - lgui2item - lgui2property - lgui2radialitem - lgui2radialgaugeneedle
Element Base Types
lgui2element - lgui2bordered - lgui2contentbase - lgui2headeredcontentbase - lgui2itemlist
Elements