TIBCO Spotfire Visualization Properties - Colors

Source:

Methods

addbreakpointcolorrule(id, idpoint, type, value, color)

Adds a breakpoint color rule for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
idpoint string The id of the breakpoint color rule.
type string the rule type for the breakpoint color rule. Can be "Value", "Min", "Max", "Average", "Median", "Percent", "Percentile", "Custom expression".
value string The value for the breakpoint color rule (null if the rule type is "Min", "Max", "Average" or "Median").
color string The color associated with the value of the breakpoint color rule.
Source:

addcolorrule(id, idpoint, type, value, color)

Adds a color rule for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
idpoint string The id of the color rule.
type string the rule type for the color rule. Available values depend of the TIBCO Spotfire Color Axis Mode.
value string The value for the color rule.
color string The color associated with the value of the color rule.
Source:

setcoloraxismode(id, coloraxismode)

Sets axis mode property (from color by propoerty) for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
coloraxismode string Color axis mode, "True" for Categorical, "False" for Continuous.
Source:

setcolorby(id, colorbyexpression)

Sets color by property for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
colorbyexpression string Color by expression (with aggregation method if needed).
Source:

setcolorcolormode(id, colorcolormode)

Sets color mode property (from color by propoerty) for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
colorcolormode string Color color mode, it can only be "Categorical", "Fixed, "Gradient", "Segments", "Unique values".
Source:

setcolorfromfile(id, urlfile)

Sets color by property for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
urlfile string XML file containing the dxp ColorScheme.
Source:
Example
setcolorfromfile('3', 'path/ColorScheme.dxpcolor');

setcolorfromlibrary(id, librarypath)

Sets color by property for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
librarypath string XML file containing the dxp ColorScheme in the library.
Source:

setdefaultcolor(id, defaultcolor)

Sets default color property for a visualization.
Parameters:
Name Type Description
id string The id of the visualization. Unique in the current TIBCO Spotfire Document.
defaultcolor string Default color name.
Source:
Example
setdefaultcolor('3', 'CornflowerBlue');