- Source:
- API-4.1.js, line 29
Methods
setfixedshape(id, defaultshape)
Sets fixed shape property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
defaultshape |
integer | Fixed shape: 0=Circle, 1=Diamond, 2=Pentagon, 3=Square, 4=StarFive, 5= StarFour, 6=TriangleDown, 7=TriangleLeft, 8=TriangleRight, 9=TriangleUp |
- Source:
- API-4.1.js, line 2438
setshapeby(id, shapebyexpression)
Sets shape by property for a visualization.
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapebyexpression |
string | Shape by expression (with aggregation method if needed). |
- Source:
- API-4.1.js, line 2452
setShapeLabelPosition(id, shapelabelposition)
Sets the label position property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapelabelposition |
int | The label position: 0 = Inside, 1 = Outside. |
- Source:
- API-4.1.js, line 2550
setShapeSectorCategory(id, shapesectorcategory)
Sets the sector category property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesectorcategory |
boolean | True to show the sector category in labels, false otherwise. |
- Source:
- API-4.1.js, line 2494
setShapeSectorPercentage(id, shapesectorpercentage)
Sets the sector percentage property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesectorpercentage |
boolean | True to show the sector percentage in labels, false otherwise. |
- Source:
- API-4.1.js, line 2508
setShapeSectorPercentageDecimals(id, shapesectorpercentagedecimals)
Sets the sector percentage decimals property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesectorpercentagedecimals |
int | Number of decimal digits for percentages. |
- Source:
- API-4.1.js, line 2536
setShapeSectorPercentageThreshold(id, shapesectorpercentagethreshold)
Sets the sector percentage threshold property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesectorpercentagethreshold |
int | Value indicating the limit for label percentage. Labels with a percentage above this value will be rendered. |
- Source:
- API-4.1.js, line 2522
setShapeSectorSizeBy(id, shapesectorsizeby)
Sets sector size by property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesectorsizeby |
string | Sector size by expression (an aggregation method is mandatory). |
- Source:
- API-4.1.js, line 2466
setShapeSectorValue(id, shapesectorvalue)
Sets the sector value property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesectorvalue |
boolean | True to show the sector value in labels, false otherwise. |
- Source:
- API-4.1.js, line 2480
setShapeSortSectorsBySize(id, shapesortsectorsbysize)
Sets the sort sectors by size property for a visualization (only for the "Pies" method).
Parameters:
Name | Type | Description |
---|---|---|
id |
string | The id of the visualization. Unique in the current TIBCO Spotfire Document. |
shapesortsectorsbysize |
boolean | True to sort sectors by size, false otherwise. |
- Source:
- API-4.1.js, line 2564