Skip to main content

ODProgressBarRenderer_DefaultSettings interface

under construction

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.

View Source

Properties


barWidth number number

The width of the bar. (50 characters by default)

View Source


borderColor type api.ODValidConsoleColor|"openticket"

The color of the progress bar border.

View Source


emptyBarChar string string

The character used in the empty side of the progress bar.

View Source


emptyBarColor type api.ODValidConsoleColor|"openticket"

The color of the progress bar (empty side).

View Source


filledBarChar string string

The character used in the filled side of the progress bar.

View Source


filledBarColor type api.ODValidConsoleColor|"openticket"

The color of the progress bar (filled side).

View Source


labelColor type api.ODValidConsoleColor|"openticket"

The color of the progress bar label.

View Source


labelPosition type "start"|"end"

The position of the label.

View Source


labelType type api.ODProgressBarRenderer_DefaultSettingsLabel

The label type. (will show a number related to the progress)

View Source


leftBorderChar string string

The character used in the left border.

View Source


prefixColor type api.ODValidConsoleColor|"openticket"

The color of the text before the progress bar.

View Source


rightBorderChar string string

The character used in the right border.

View Source


showBar boolean boolean

Show the bar.

View Source


showBorder boolean boolean

Show the border.

View Source


showLabel boolean boolean

Show the label.

View Source


suffixColor type api.ODValidConsoleColor|"openticket"

The color of the text after the progress bar.

View Source