new(%args) => OBJ¶

Instantiate. Usually called through "Progress::Any::Output->set("TermProgressBarColor", %args)".

Known arguments:

• freq => num

  Limit the frequency of output updating. 0 means no frequency limiting (update output after every "update()").

  A positive number means to update output when there has been that amount of difference in position since last "update()". For example, if "freq" is 10 and the last "update()" was at position 5, then the next output update will be when position is at least 15.

  A negative number means to update output when time has passed that amount of absolute value (in seconds). For example, if "freq" is -3 and the last "update()" was 1 second ago, then the next output update will not be until the next two seconds has passed.

  By default undef, in which case Progress::Any will use the default -0.5 (at most once every 0.5 seconds).

• wide => bool

  If set to 1, enable wide character support (requires Text::ANSI::WideUtil.

• width => INT

  Width of progress bar. The default is to detect terminal width and use the whole width.

• color_theme => STR

  Not yet implemented.

  Choose color theme. To see what color themes are available, use "list_color_themes()".

• style => STR

  Not yet implemented.

  Choose style. To see what styles are available, use "list_styles()". Styles determine the characters used for drawing the bar, alignment, etc.

• template => str

  See fill_template in Progress::Any's documentation. Aside from conversions supported by Progress::Any, this output recognizes these additional conversions: %b to display the progress bar (with width using the rest of the available width), %B to display the progress bar as well as the message inside it. You can also enclose parts of text with "<color RGB>" ... "</color>" to give color.

  The default template is:

   <color ffff00>%p</color> <color 808000>[</color>%B<color 808000>]</color><color ffff00>%e</color>
      

• fh => handle (default: \*STDERR)

  Instead of the default STDERR, you can direct the output to another filehandle e.g. STDOUT.

• show_delay => int

  If set, will delay showing the progress bar until the specified number of seconds. This can be used to create, e.g. a CLI application that is relatively not chatty but will display progress after several seconds of seeming inactivity to indicate users that the process is still going on.

• rownum => uint

  Default 0. Can be set to put the progress bar at certain rownum. This can be used to display several progress bars together.

keep_delay_showing()¶

Can be called to reset the timer that counts down to show progress bar when "show_delay" is defined. For example, if "show_delay" is 5 seconds and two seconds have passed, it should've been 3 seconds before progress bar is shown in the next "update()". However, if you call this method, it will be 5 seconds again before showing.

How to update progress bar output more often?¶

Set "freq" to e.g. -0.1 or -0.05. The default "freq", when unset, is -0.5 which means to update output at most once every 0.5 second.

How to display a different message for this output?¶

For example, this output formats message using String::Elide::Parts so inside the message, substrings can be tagged for eliding priority:

 <elspan prio=2>Downloading </elspan><elspan prio=3 truncate=middle>http://127.0.0.1:7007/2.mp4 </elspan>37.3M/139.5M

while another output like Progress::Any::Output::TermMessage does not use String::Elide::Parts. It should just display the string as:

 Downloading http://127.0.0.1:7007/2.mp4 37.3M/139.5M

In the indicator, you can provide a specific message for this output:

 $progress->update(
     message => 'Downloading http://127.0.0.1:7007/2.mp4 37.3M/139.5M',
     'message.alt.output.TermProgressBarColor' => '<elspan prio=2>Downloading </elspan><elspan prio=3 truncate=middle>http://127.0.0.1:7007/2.mp4 </elspan>37.3M/139.5M',
     ...
 );

NO_COLOR¶

Bool. Can be used to disable color. Consulted before NO_COLOR. See Color::ANSI::Util.

COLOR¶

Bool. Can be used to force or disable color. See Color::ANSI::Util.

COLOR_DEPTH¶

Integer. Can be used to override color depth detection. See Color::ANSI::Util.

COLUMNS¶

Integer. Can be used to override terminal width detection.

PROGRESS_TERM_BAR¶

Bool. Forces disabling or enabling progress output (just for this output).

In the absence of PROGRESS_TERM_MESSAGE and PROGRESS, will default to 1 if filehandle is detected as interactive (using "-t").

PROGRESS¶

Bool. Forces disabling or enabling progress output (for all outputs).