- Source:
- API-4.1.js, line 22
Methods
setaxis(id, axis, expression, bins)
Sets axis properties for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis (X, Y or Z). |
expression |
string | Axis expression (with aggregation method if needed). |
bins |
integer | Number of bins (use "null" if not needed). |
- Source:
- API-4.1.js, line 1956
Examples
setaxis('1', 'X', 'ALogP', 'null');
setaxis('1', 'Y', 'ALogP', '20');
setaxisincludezeroinautozoom(id, axis, includezeroinautozoom)
Sets axis include zero in auto zoom for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis (X, Y or Z). |
includezeroinautozoom |
boolean | Include origin. |
- Source:
- API-4.1.js, line 1988
Throws:
Message error, use getError method to get the error message.
setaxisposition(id, axis, axisposition)
Sets axis position for a Heat Map visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
axisposition |
integer | Axis position: 0=top or right, 1=bottom or left. |
- Source:
- API-4.1.js, line 2118
Example
setaxisposition("1", "X", 0);
setlabelorientationaxis(id, axis, labelorientation)
Sets axis labels orientation property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
labelorientation |
integer | Labels orientaiton: 0=horizontal, 1=vertical. |
- Source:
- API-4.1.js, line 2086
Example
setlabelorientationaxis('1', 'X', 1);
setLogScaleAxis(id, axis, logscale)
Apply a Log 10 transform to an axis.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis ('X', 'Y', or 'Z'). |
logscale |
boolean | Apply a Log 10 transform? |
- Source:
- API-4.1.js, line 2036
Example
setLogScaleAxis('1', 'X', 'True');
setmanuelzoomaxis(id, axis, manuelzoom)
Shows axis manuel zoom property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
manuelzoom |
boolean | Show zoom slider. |
- Source:
- API-4.1.js, line 2004
Example
setmanuelzoomaxis('1', 'X', 'False');
setmaximumnumberofticksaxis(id, axis, maximumnumberofticks)
Sets axis Max number of labels for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
maximumnumberofticks |
integer | Max number of labels. |
- Source:
- API-4.1.js, line 2102
Example
setmaximumnumberofticksaxis('1', 'X', 15);
setreversedaxis(id, axis, reversed)
Set axis reverse scale property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis ('X', 'Y', or 'Z'). |
reversed |
boolean | Reverse scale. |
- Source:
- API-4.1.js, line 2054
Example
setreversedaxis('1', 'X', 'True');
setshowgridllinesaxis(id, axis, showgridlines)
Shows axis gridlines property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
showgridlines |
boolean | Show gridlines. |
- Source:
- API-4.1.js, line 2020
Example
setshowgridllinesaxis('1', 'X', 'True');
setshowlabelsaxis(id, axis, showlabels)
Shows axis labels property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
showlabels |
boolean | Show labels. |
- Source:
- API-4.1.js, line 2070
Example
setshowlabelsaxis('1', 'X', 'True');
setzoomrangeaxis(id, axis, zoomrangelow, zoomrangehigh)
Sets axis zoom range for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
axis |
string | Axis. |
zoomrangelow |
string | Min zoom range. |
zoomrangehigh |
string | Max zoom range. |
- Source:
- API-4.1.js, line 1972
showgridlines(id, showgridlines)
Shows gridlines Category Axis property for a Bar Chart visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showgridlines |
boolean | Shows gridlines property. |
- Source:
- API-4.1.js, line 1722