autogroup

bool

If this is set to True (which is the default), and the file display is grouped by this column, Opus will generate the groups automatically based on the column value. If you set this to False, Opus will expect you to provide grouping information in your OnScriptColumn function.

defsort

int

This property lets you control the default sort behavior for your column. Normally when the user clicks the column header to sort by a column the column is initially sorted in ascending order, and then clicking again reverses the sort order. If you set defsort to -1, the first click on the column header will sort in descending order. Date and size fields have this behavior set by default.

graph_colors

object:Vector 

For graph columns, specifies the first graph color set. The graph will be displayed in these colors as long as its percentage is below the threshold.
 

You can either specify a single color (in r,g,b or #rrggbb format), in which case the graph will be a flat solid color, or exactly five colors to configure the graph's gradient. In the second case, the five colors correspond to outer bright, inner bright, inner dark, outer dark, and flat. The first four control the gradient and the fifth (flat) is used when gradients are disabled. 

The graph_colors property returns a Vector; you need to use the push_back() method to add your colors to it.

graph_threshold

For graph columns, specifies the percentage threshold at which the graph will switch from the first color set to the second (e.g. a blue graph goes red to indicate a drive is nearly full). Set the threshold to -1 to disable the second color set altogether.

header

string

If this property is set, this defines the string that will be displayed in the column header when this column is added to a Lister. If not set, the label value will be used.

justify

string

This field lets you control the justification of your column. If not specified, columns default to left justify. Acceptable values are center, left, right and path.

label

string

Use this to set a label for the column. This is displayed in the column header when the column is added to a Details/Power mode file display (unless overridden by the header property), and in various column lists such as in the Folder Options dialog.

maxstars

int

If the column type is set to stars this property lets you specify the maximum number of stars that will be used. This is used to ensure the column is sized correctly.

multicol

bool

If your script implements multiple columns that require common calculations to perform, you may wish to set the multicol property. If this is set to True then your column handler function has the option of returning data for multiple columns simultaneously, rather than just the specific column it is being invoked for.

When your handler is called, the ScriptColumnData object won't contain the usual group, sort, type and value properties. Instead, it will have a columns property that points to a Map that lets you set the values for one or more of your columns at once.

For example, you might set the value of a column called MyColumn like this:

scriptColData.columns("MyColumn").value = "My Column Value";

namerefresh

Set to True to force Opus to update the value for this column when a file's name changes.

nosort

bool

Set to True to prevent the file display being sorted by this column.

type

string

This field lets you set the default type of the column.

If not specified, columns default to plain text.

Acceptable values are:

number:

The column displays integer numbers.

double:

The column displays floating point (fractional) numbers.

size:

The column displays file sizes (automatically displays bytes, KB, MB, etc.).

zip:

The column displays file sizes (uses the settings for Zip file sizes).

graph:

The column displays a bar graph (expects a value from 0 to 100).

graphrel:

The column displays a bar graph. Opus automatically keeps track of the minimum and maximum values provided and scales the graph accordingly.

graphrel0:

Similar to graphrel except the minimum value is always 0, and Opus keeps track of the maximum value.

igraph:

The column displays an inverted bar graph.

igraphrel:

Inverted relative bar graph.

igraphrel0:

Inverted bar graph relative to 0.

percent:

The column displays a percentage.

percentrel:

Relative percentage.

percentrel0:

Percentage relative to 0.

date:

The column displays a date.

time:

The column displays a time.

datetime:

The column displays both a date and a time.

stars:

The column displays stars (similar to the built-in Rating column).

For plain text columns, you can specify numericsort or nonumericsort to override the "numeric order filename sorting" setting in Folder Options. Similarly, wordsort or nowordsort can be used to override the "word sort (special handling for hyphens, etc.)" setting. You can also combine both options, e.g. nonumericsort,nowordsort to request only basic sorting. Leave the type unset, or set it to an empty string, for plain text data which respects the Folder Options sort settings.

For date, time and datetime columns, you can also specify utc to have the values automatically converted from UTC to local time (e.g. datetime,utc).

For number and double columns, you can also specify signed to have the values treated as signed rather than unsigned (e.g. number,signed).

For the graph columns, you can use graph_colors, graph_colors2 and graph_threshold to configure the graph's appearance.

Your OnScriptColumn method can override the type on a per-file basis, however this field sets the default type and also controls the behavior of the Advanced Find function when searching using your column.