TIBCO Spotfire Visualization Properties - Lines & Curves

Source:

Methods

addColumnValuesLine(id, idLine, datatable, xValuesColumn, yValuesColumn)

Adds a line or multiline. The points of the line are defined from the values of a pair of columns.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
datatable string Name of the Spotfire Data Table containing the columns. If empty, the datatable associated to the visualization is used.
xValuesColumn string Name of the column containing the x-values.
yValuesColumn string Name of the column containing the y-values.
Source:
Examples
addColumnValuesLine("1", "4", "Pipeline Pilot Data 1", "ALogP", "Molecular_Weight");
addColumnValuesLine("1", "4", "", "ALogP", "CL_SIZE");

addCurve(id, idLine, datatable, expression)

Adds a curve to a Spotfire visualization.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
datatable string Name of the Spotfire Data Table. If it is empty, this function corresponds to the "Curve Draw..." option in Spotfire, if it is precised, this function corresponds to the "Curve From Data Table..." option.
expression string Expression of the curve to draw.
Source:
Examples
addCurve(id, "1", "", "5.0*Sin(x) + 2.5");
addCurve(id, "1", "Pipeline Pilot Data 1", "5.0*Sin(x) + 2.5");

addExponentialCurve(id, idLine)

Adds an exponential curve fit.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
Source:
Example
addExponentialCurve("1", "3");

addGaussianCurve(id, idLine, amplitude, position, width)

Adds a gaussian curve fit.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
amplitude double The amplitude of the Gaussian curve. Leave empty for automatic calculation.
position double The position (mean) of the Gaussian curve. Leave empty for automatic calculation.
width double The width of the Gaussian curve. Leave empty for automatic calculation.
Source:
Example
addGaussianCurve("1", "3", "", "", 10.0, true, "", "");

addHorizontalLine(id, idLine, datatable, expression)

Adds an horizontal line to a Spotfire visualization.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
datatable string Name of the Spotfire Data Table. Can be empty.
expression string Expression of the horizontal line to draw. If the "datatable" is null or empty, the "expression" is either a fixed value or an aggregated value (Min, Max, ...) on the Y axis or a custom expression. If the "datatable" is precised, the "expression" must indicate a column name of the "datatable".
Source:
Examples
addHorizontalLine("1", "1", "", "Max(Y)");
addHorizontalLine("1", "1", "Pipeline Pilot Data 1", "CL_VAR");

addLogarithmicCurve(id, idLine)

Adds a logarithmic curve fit.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
Source:
Example
addLogarithmicCurve("1", "3");

addLogisticRegressionCurve(id, idLine, min, max, XTransformType)

Adds a logistic regression curve fit.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
min double The fixed min. Leave empty for automatic calculation.
max double The fixed min. Leave empty for automatic calculation.
XTransformType integer X-axis transformation type : 0 for None, 1 for log10.
Source:
Example
addLogisticRegressionCurve("1", "1", "", "", 1);

addPolynomialCurve(id, idLine, degree)

Adds a polynomial curve fit.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
degree integer Degree of the polynomial.
Source:
Example
addPolynomialCurve("1", "3", 5);

addPowerCurve(id, idLine)

Adds a power curve fit.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
Source:
Example
addPowerCurve("1", "3");

addStraightLineFit(id, idLine)

Adds a straight line that minimizes the sum-of-squares of the y-distances between the data and the line.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
Source:
Example
addStraightLineFit("1", "3");

addVerticalLine(id, idLine, datatable, expression)

Adds a vertical line to a Spotfire visualization.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
datatable string Name of the Spotfire Data Table. Can be empty.
expression string Expression of the vertical line to draw. If the "datatable" is null or empty, the "expression" is either a fixed value or an aggregated value (Min, Max, ...) on the X axis or a custom expression. If the "datatable" is precised, the "expression" must indicate a column name of the "datatable".
Source:
Examples
addVerticalLine("1", "2", "", "Max(X)");
addVerticalLine("1", "2", "Pipeline Pilot Data 1", "CL_VAR");

linesAndCurvesAddLabelAndTooltip(id, idLine, columnName, showInLabel, showInTooltip)

Adds a label and a tooltip to a line/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
columnName string Name of the column to add in tooltips of the line/curve.
showInLabel boolean Show in label of the line/curve ? Can be "null", null, or "". By default, false.
showInTooltip boolean Show in tooltip of the line/curve ? Can be "null", null, or "". By default, true.
Source:
Examples
linesAndCurvesAddLabelAndTooltip("1", "4", "CL_SIZE", true, true);
linesAndCurvesAddLabelAndTooltip("1", "4", "Value (x)", true, true);

linesAndCurvesAffectAxisRange(id, idLine, affect)

Sets the "Included in axis range" property of a line/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
affect boolean Included in axis range ?
Source:
Example
linesAndCurvesAffectAxisRange("1", "4", true);

linesAndCurvesCustomName(id, idLine, customName)

Sets the "Curve name" property of a line/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
customName string Name of the line.
Source:
Example
linesAndCurvesCustomName("1", "4", "LineOnALogP");

linesAndCurvesEmptyValues(id, idLine, ignoreEmpty)

Sets the "Empty values" property of a line/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
ignoreEmpty boolean Ignore (skip) empty values? If false, splits line at empty values.
Source:
Example
linesAndCurvesEmptyValues("1", "4", true);

linesAndCurvesIndividualFittingModes(id, idLine, fittingMode)

Sets the individual fitting modes properties for a line/curve (called "One per" in the Spotfire interface).
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
fittingMode integer Individual fitting mode codes : 0 for None, 1 for Color, 2 for Shape, 3 for Line, 4 for Trellis.
Source:
Example
linesAndCurvesIndividualFittingModes("1", "4", 2);

linesAndCurvesInflectionPointAffectAxisRange(id, idLine, affect)

Sets the inflection point "Included in axis range" property of a logistic regression curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
affect boolean Included in axis range ?
Source:
Example
linesAndCurvesInflectionPointAffectAxisRange("1", "4", true);

linesAndCurvesSetAppearance(id, idLine, color, transparency, lineStyle, width, isBackground)

Sets the appearance properties of a line/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
color string The color, either in the HTML format or its name, by which the line is rendered. Can be empty, default is black.
transparency integer The transparency of the line, between 0 and 255, default is 255 (no transparency).
lineStyle integer Code indicating the line style by which the line is rendered: 0 for dash line, 1 for dot line, 2 for single line, 3 for double line. Can be empty, default is single line.
width integer The width of the line. Can be empty, default is 2.
isBackground boolean Value controlling if the line is renderer behind other visual elements in the visualization. Can be empty, default is "False".
Source:
Example
linesAndCurvesSetAppearance("1", "4", "#FF0000", 50, 3, 1, true);

linesAndCurvesSetInflectionPointAppearance(id, idLine, color, transparency, shape, pointSize, isBackground)

Sets the inflection point appearance properties of a logistic regression curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
color string The color, either in the HTML format or its name, by which the line is rendered. Can be empty, default is black.
transparency integer The transparency of the line, between 0 and 255. Can be empty, default is 255 (no transparency).
shape integer The code indicating the shape to use for the point. Can be empty, default is Circle. Codes: 0: Circle, 1: CircleOutline, 2: Cross, 3: CrossLine, 4: CrossOutline, 5: Diamond, 6: DiamondOutline, 7: DownPointingArrow, 8: DownPointingArrowLine, 9: DownPointingArrowOutline, 10: HorizontalLine, 11: HorizontalRectangle, 12: HorizontalRectangleOutline, 13: LeftPointingArraw, 14: LeftPointingArrawLine, 15: LeftPointingArrawOutline, 16: Pentagon, 17: PentagonOutline, 18: Plus, 19: PlusLine, 20: PlusOutline, 21: RightPointingArrow, 22: RightPointingArrowLine, 23: RightPointingArrowOutline, 24: Square, 25: SquareOutline, 26: StarFive, 27: StarFiveOutline, 28: StarFour, 29: StarFourOutline, 30: StarSixLine, 31: TriangleDown, 32: TriangleDownOutline, 33: TriangleLeft, 34: TriangleLeftOutline, 35: TriangleRight, 36: TriangleRightOutline, 37: TriangleUp, 38: TriangleUpOutline, 39: UpPointingArrow, 40: UpPointingArrowLine, 41: UpPointingArrowOutline, 42: VerticalLine, 43: VerticalRectangle, 44: VerticalRectangleOutline.
pointSize float The size of the inflection point, between 0 and 100. Can be empty.
isBackground boolean Value controlling if the line is renderer behind other visual elements in the visualization. Can be empty, default is "False".
Source:
Example
linesAndCurvesSetInflectionPointAppearance("1", "4", "#FF0000", 100, 3, 50, false);

linesAndCurvesSetVisible(id, idLine, visible)

Sets the line/curve visible or not.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
visible boolean Set the line/curve visible ?
Source:
Example
linesAndCurvesSetVisible("1", "4", false);

linesAndCurvesSortedByColumn(id, idLine, sortedBy)

Adds the "Sorted by column" property to a multiline/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
sortedBy string Name of the column used to sort the x- and y-values before connecting the points to a multiline.
Source:
Example
linesAndCurvesSortedByColumn("1", "4", "ALogP");

linesAndCurvesUpdate(id, idLine)

Updates a line or curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
Source:
Example
linesAndCurvesUpdate("1", "4");

linesAndCurvesUpdateManually(id, idLine, update)

Sets the "Update manually" property of a line/curve.
Parameters:
Name Type Description
id string The visualization identifier.
idLine string The line/curve identifier.
update boolean Update manually ?
Source:
Example
linesAndCurvesUpdateManually("1", "4", true);

removeAllLinesAndCurves(id)

Remove all lines and curves drew on a Spotfire visualization.
Parameters:
Name Type Description
id string Visualization identifier.
Source:
Example
closevisual("1"); clearAllLinesAndCurves("1"); showVisual("1");

removeLinesAndCurves(id, idLinesList, separator)

Remove the precised list of lines and curves drew on a Spotfire visualization.
Parameters:
Name Type Description
id string Visualization identifier.
idLinesList string List of line/curve identifiers to remove from the visualization.
separator string Separator used in idLinesList.
Source:
Example
closevisual("1"); clearLinesAndCurves("1", "2;5", ";"); showVisual("1");