ODProgressBarRenderer_DefaultSettings interface
We are still working the API Reference! This page might be incomplete or doesn't contain all details!
Overview
This interface contains the settings for the default progress bar renderer.
Properties
barWidth number ➜ number
The width of the bar. (50 characters by default)
borderColor type ➜ api.ODValidConsoleColor|"openticket"
The color of the progress bar border.
emptyBarChar string ➜ string
The character used in the empty side of the progress bar.
emptyBarColor type ➜ api.ODValidConsoleColor|"openticket"
The color of the progress bar (empty side).
filledBarChar string ➜ string
The character used in the filled side of the progress bar.
filledBarColor type ➜ api.ODValidConsoleColor|"openticket"
The color of the progress bar (filled side).
labelColor type ➜ api.ODValidConsoleColor|"openticket"
The color of the progress bar label.
labelPosition type ➜ "start"|"end"
The position of the label.
labelType type ➜ api.ODProgressBarRenderer_DefaultSettingsLabel
The label type. (will show a number related to the progress)
leftBorderChar string ➜ string
The character used in the left border.
prefixColor type ➜ api.ODValidConsoleColor|"openticket"
The color of the text before the progress bar.
rightBorderChar string ➜ string
The character used in the right border.
showBar boolean ➜ boolean
Show the bar.
showBorder boolean ➜ boolean
Show the border.
showLabel boolean ➜ boolean
Show the label.
suffixColor type ➜ api.ODValidConsoleColor|"openticket"
The color of the text after the progress bar.