- Source:
- API-4.1.js, line 30
Methods
setlabelby(id, labelbyexpression)
Sets label by property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
labelbyexpression |
string | Label by expression (with aggregation method if needed). |
- Source:
- API-4.1.js, line 2658
setlabelorientation(id, labelorientation)
Sets label orientation property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
labelorientation |
integer | Labels orientation: 0=Horizontal, 1=Vertical. |
- Source:
- API-4.1.js, line 2686
setlabelproperties(id, labelvisibility, labelorientation, labelcompletebar, labelsegment, segmentlabelinformationtype, maxnumberoflabels, labelpercentagedecimaldigits)
Sets label properties for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
labelvisibility |
integer | Label visibility: 0=All, 1=Marked rows, 2=None (use null for default value). |
labelorientation |
boolean | Label orientation: 0=Horizontal, 1=Vertical (use null for default value). |
labelcompletebar |
boolean | Label complete Bar (use null for default value). |
labelsegment |
boolean | Label segment (use null for default value). |
segmentlabelinformationtype |
integer | Segment label information type: 0=Percentage, 1=Value (use null for default value). |
maxnumberoflabels |
integer | Max number of labels, must be between 0 and 200 (use null for default value). |
labelpercentagedecimaldigits |
integer | Percentage decimals digits, must be between 0 and 6 (use null for default value). |
- Source:
- API-4.1.js, line 2599
setmaxnumberoflabels(id, maxnumberoflabels)
Sets max number of labels for property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
maxnumberoflabels |
integer | Max number of labels, must be between 0 to 200. |
- Source:
- API-4.1.js, line 2644
setpercentagedecimals(id, decimals)
Sets percentage decimals property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
decimals |
boolean | Percentage decimals. |
- Source:
- API-4.1.js, line 2744
setsectorpercentagethreshold(id, threshold)
Sets sector percentage threshold property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
threshold |
boolean | Sector percentage threshold. |
- Source:
- API-4.1.js, line 2730
showbarlabels(id, showbarlabels)
Sets show bar labels property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showbarlabels |
boolean | Show bar labels. |
- Source:
- API-4.1.js, line 2672
showhierarchyheaders(id, showhierarchyheaders)
Sets hierarchy headers property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showhierarchyheaders |
boolean | Show hierarchy headers. |
- Source:
- API-4.1.js, line 2758
showinlabels(id, showlinelabels, showindividualvalues)
Sets show in labels property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showlinelabels |
boolean | Show line labels (use null for default value). |
showindividualvalues |
boolean | Show individual values (use null for default value). |
- Source:
- API-4.1.js, line 2616
showlabelsfor(id, labelvisibility)
Sets show labels for property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
labelvisibility |
integer | Labels visibility: 0=All, 1=Marked rows, 2=None. |
- Source:
- API-4.1.js, line 2630
showlables(id, showlabels)
Sets show labels property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showlabels |
boolean | Show labels. |
- Source:
- API-4.1.js, line 2772
showlinemarkerlabels(id, showlinemarkerlabels)
Sets show line marker labels property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
showlinemarkerlabels |
boolean | Show line marker labels. |
- Source:
- API-4.1.js, line 2700
showsectorinlabels(id, sectorpercentage, sectorvalue, sectorcategory)
Sets show sector in labels property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
sectorpercentage |
boolean | Sector percentage (use null for default value). |
sectorvalue |
boolean | Sector value (use null for default value). |
sectorcategory |
boolean | Sector category (use null for default value). |
- Source:
- API-4.1.js, line 2716