GridCell.SetTextColorRules(Array, Array) Method

 Top 

Description

Applies the array of rangeThresholds and rangeColors as rules so that whenever the value of the cell is between two threshold values, the color corresponding to that range is applied to the text in that cell. The size of the rangeColors array must be one greater than the size of the rangeThresholds array. The cell's text color will default to GridCell.TextColor in the case where there are no matches.

 

Timing Precision Mode

This page describes functionality in millisecond timing precision mode. Millisecond timing precision mode is deprecated and will be removed in a future release. We recommend that you migrate your Mission Plans to nanosecond timing precision mode.

Click here to see the documentation for this object in nanosecond timing precision mode.

 

Method Signature

GridCell.SetTextColorRules(

Array rangeThresholds,

Array rangeColors)

 

 

Arguments

rangeThresholds

Description:

The thresholds for the applied rules.

 

 

rangeColors

Description:

The colors to apply when between threshold values.

 

 

 

Syntax

myGridCell1.SetTextColorRules(myArray1, myArray2);

 

 

Example 1

The script example below shows how to use the text color rules in a GridCell for a range of numbers

 

// Add a Value with a Range to the GridWindow

 

Spacecraft sc;

GridWindow gw;

gw.Show();

 

gw.NumberOfRows    = 1;

gw.NumberOfColumns = 1;

 

// Note that the color array is 1 size larger than the range array

gw.GetCell(0, 0).SetTextColorRules({0.25, 0.75}, {ColorTools.Green, ColorTools.Orange, ColorTools.Red});

While (sc.ElapsedDays < 1);

    Step sc;

    // This becomes Orange at 0.25 days and Red at 0.75 days

    gw.GetCell(0, 0).SetValue(sc.ElapsedDays);

End;

 

 

 

 

See also

GridCell Object

GridCell.SetTextColorRules

GridWindow Guide