- Source:
- API-4.1.js, line 34
Methods
setLineConnectionColor(id, color)
Sets Line Connection Color property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
color |
string | The color, either in the HTML format or its name, by which the Line Connection is rendered. Can be empty, default is black. |
- Source:
- API-4.1.js, line 2869
Example
setLineConnectionColor("1", "#FF0000");
setLineConnectionDrawBy(id, drawByExpression, bins)
Sets Line Connection Draw by property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
drawByExpression |
string | Column name on which draw a separate line per value. Force Categorical mode by arrounding name with "<" and ">" characters. |
bins |
integer | Number of bins (use "null" if not needed). |
- Source:
- API-4.1.js, line 2823
Examples
setLineConnectionDrawBy("1", "CLUSTER", 5);
setLineConnectionDrawBy("1", "<CLUSTER>", "null");
setLineConnectionIsBackground(id, isBackground)
Sets Line Connection Is Background property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
isBackground |
boolean | Place the Line Connection in background ? |
- Source:
- API-4.1.js, line 2917
Example
setLineConnectionIsBackground("1", false);
setLineConnectionOrderBy(id, orderByExpression)
Sets Line Connection Order By property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
orderByExpression |
string | Column name on which order each line. Aggregation methods are allowed. Can be empty. |
- Source:
- API-4.1.js, line 2838
Example
setLineConnectionOrderBy("1", "Avg(CL_SIZE)");
setLineConnectionShowOrderArrows(id, showArrows)
Sets Line Connection Show order arrows property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showArrows |
boolean | Show arrows to indicate connection order ? |
- Source:
- API-4.1.js, line 2853
Example
setLineConnectionShowOrderArrows("1", false);
setLineConnectionUseMarkerColor(id, useMarkerColor)
Sets Line Connection Use Marker Color property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
useMarkerColor |
boolean | Use the Marker Color to color the Line Connection ? |
- Source:
- API-4.1.js, line 2885
Example
setLineConnectionUseMarkerColor("1", false);
setLineConnectionWidth(id, width)
Sets Line Connection Width property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
width |
float | Width of the Line Connection, between 1 and 6. |
- Source:
- API-4.1.js, line 2901
Example
setLineConnectionWidth("1", 1);