Connector JavaScript API Reference

Members

Type: string

constant SpotfireAxisEvaluationMode

Represents the enumeration for axis evaluation modes.

Properties:

Name	Description
`allData`	Apply to all data. Other available values: 'All data', 'AllData'.
`filteredData`	Apply to filtered data. Other available values: 'Current filtering only', 'FilteredData'.

Type: string

constant SpotfireAxisModes

Represents the enumeration for axis modes.

Properties:

Name	Description
`continuous`	For numerical columns, when you want the values to be treated as continuous, numerical values. Other available value: 'Continuous'.
`categorical`	When you want the values to be seen as categories rather than numerical values. Other available value: 'Categorical'.

Type: String

constant SpotfireAxisTypes

Represents the enumeration for axis types.

Properties:

Name	Description
`colorAxis`	Axis used to define coloring within a visualization.
`drawingOrderAxis`	Axis used to control drawing order of the markers within a visualization.
`heatMapMeasureAxis`	Axis used to define heat map measures.
`groupByAxis`	Axis used to define grouping within a visualization, such as the "marker by" properties.
`scaleAxis`	Represents an X or Y axis in a visualization. It is used to map values to an axis, typically by applying a range. When mapping, the scale axis can transform the values.
`sectorSizeAxis`	Axis used to define sector sizes (Pie Chart).
`sizeAxis`	Axis used to define the "size by" properties.
`trellisAxis`	Axis used to define a trellis.

Type: String

constant SpotfireBarChartLayouts

Represents the enumeration for bar chart layouts (Appearance).

Properties:

Name	Description
`sideBySide`	To place bars from the color category side-by-side instead of stacked on top of each other. Other available values: 'Side-by-side bars', 'None'.
`stack`	To keep color categories stacked on top of each other. Note: This option should not be used if you want to display error bars in the bar chart. Other available values: 'Stacked bars', 'Stack'.
`stack100Percent`	to set the heights of all bars to 100%. The size of the bar segments represents how much of the percentage of the total sum for the group is constituted of the sums of the values in the category. The exact percentage of each category can be seen in the tooltip displayed when hovering with the mouse pointer over a bar segment. Note: This option should not be used if you want to display error bars in the bar chart. Other available values: 'Stacked bars', 'Stack'.

Type: String

constant SpotfireBarChartOrientations

Represents the enumeration for bar chart orientations (Appearance).

Properties:

Name	Description
`vertical`	To display the bars in the visualization vertically. Other accepted values: 'Vertical bars', 'Vertical'.
`horizontal`	To display the bars in the visualization horizontally. Other accepted values: 'Horizontal bars', 'Horizontal'.

Type: string

constant SpotfireCategoryModes

Represents the enumeration for category modes.

Properties:

Name	Description
`showFiltered`	To display values available after current filtering only. This means that those categories that are visible will change with the filtering and that categories currently without any values will be hidden from the visualization. Other available values: 'Show filtered values', 'ShowFiltered'.
`showFilteredRange`	To hide empty categories on both ends of the currently visible range. This means that those categories that are visible will change with the filtering, and that empty categories within the currently visible range will remain visible. Other available values: 'Show filtered range', 'ShowFilteredRange'.
`showAll`	To keep all categories visible even if data for some categories have been filtered out. Other available values: 'Show all values', 'ShowAll'.

Type: String

constant SpotfireColoringRulesTypes

Represents the enumeration for coloring rule types.

Properties:

Name	Description
`top`
`bottom`
`between`
`equalTo`
`notEqualTo`
`greaterThan`
`greaterThanOrEqual`
`lessThan`
`lessThanOrEqual`
`booleanExpression`
`gradient`
`segments`
`uniqueValues`
`string`

Type: String

constant SpotfireColorModes

Represents the enumeration for color modes.

Properties:

Name	Description
`fixed`	Available as an option for columns in both categorical scale mode and continuous scale mode. In fixed mode, all items in the visualization will get a single, fixed color. Other available value: 'Fixed'.
`categorical`	Available for columns in categorical scale mode, and gives each value in the column a separate color. Other available value: 'Categorical'.
`gradient`	Available for columns in continuous scale mode. In this mode the items will show a color gradient between two or more anchor points. Other available value: 'Gradient'.
`segments`	Available for columns in continuous scale mode. This will color the items representing values between two or more anchor points in fixed colors. Other available value: 'Segments'.
`uniqueValues`	Available for columns in continuous scale mode. It is similar to the Categorical color mode, and gives each unique value in the column a separate color. Other available values: 'UniqueValues', 'Unique values'.

Type: String

constant SpotfireColumnTransformations

Properties:

Name	Description
`none`	No transformation, use the raw value.
`date`	Convert the value to date.
`time`	Convert the value to time.
`dateTime`	Convert the value to date time.
`timeSpan`	Convert the value to time span.
`days`	Convert the value to days.
`hours`	Convert the value to hours.
`minutes`	Convert the value to minutes.
`seconds`	Convert the value to seconds.
`string`	Convert the value to string.
`real`	Convert the value to real.
`integer`	Convert the value to integer.
`longInteger`	Convert the value to longInteger.
`singleReal`	Convert the value to singleReal.
`currency`	Convert the value to currency.
`boolean`	Convert the value to boolean.
`upper`	(For string only) Convert the value to upper case.
`lower`	(For string only) Convert the value to lower case.
`len`	(For string only) Convert the value to the length of the string.
`trim`	(For string only) Remove whitespaces on the string.
`parseReal`	(For string only) Convert string to real.
`nameEncode`	(For string only) Encode the value using name convention (0-9a-ZA-Z and . only).
`nameDecode`	(For string only) Decode the value using name convention (to utf16 encoding).
`base64Decode`	(For string only) Decode the value of a base64 string.

Type: String

constant SpotfireComparisonOperators

Properties:

Name	Description
`less`
`lessOrEqual`
`equal`
`notEqual`
`greater`
`greaterOrEqual`

Type: String

constant SpotfireConditionalValueTypes

Properties:

Name	Description
`min`
`max`
`average`
`median`
`literal`
`percent`
`percentile`
`expression`

Type: String

constant SpotfireDataColumnsTypes

Properties:

Name	Description
`calculatedDataColumn`	Calculated data column type.
`hierarchyDataColumn`	Hierarchy data column type.

Type: String

constant SpotfireDataFunctionInputHandlers

Represents the enumeration for data function input handler types.

Properties:

Name	Description
`columns`	Columns input handler. Authorized only if input parameter type is 'Table'. Other accepted value: 'Columns'.
`column`	Column input handler. Authorized only if input parameter type is 'Column'. Other accepted value: 'Column'.
`documentProperty`	Document property input handler. Authorized only if input parameter type is 'Value'. Other accepted value: 'Document property'.
`tableProperty`	Data table property input handler. Authorized only if input parameter type is 'Value'. Other accepted values: 'Table property' and 'Data table property'.
`columnProperty`	Column property input handler. Authorized only if input parameter type is 'Value'. Other accepted values: 'Column property' and 'Data column property'.
`expression`	Expression input handler. Other accepted value: 'Expression'.
`none`	No input handler. Other accepted value: 'None'.

Type: String

constant SpotfireDataFunctionOutputHandlers

Represents the enumeration for data function output handler types.

Properties:

Name	Description
`table`	Table output handler. Other accepted value: 'Data table'.
`columns`	Columns output handler. Other accepted value: 'Columns'.
`rows`	Rows output handler. Other accepted value: 'Rows'.
`documentProperty`	Document property output handler. Authorized only if input parameter type is 'Value'. Other accepted value: 'Document Property'.
`tableProperty`	Data table property output handler. Authorized only if input parameter type is 'Value'. Other accepted values: 'Table property' and 'Data table property'.
`columnProperty`	Column property output handler. Authorized only if input parameter type is 'Value'. Other accepted values: 'Column property' and 'Data column property'.
`none`	No output handler. Other accepted value: 'None'.

Type: String

constant SpotfireDataSelectionOperations

Represents the enumeration for data selection operations.

Properties:

Name	Description
`replace`	Replaces the given marking with the new conditions specified in the where clause.
`add`	Adds rows from the specified where clause to the given marking.
`subtract`	Removes rows from the specified where clause in the given marking.
`toggle`	Toggles between the current marking and the result of the specified where clause.
`intersect`	Intersects the current marking with the marking specified in the where clause.

Type: String

constant SpotfireDataTransformationTypes

Represents the enumeration for data transformation types.

Properties:

Name	Description
`replaceColumn`	Transformation used to replace an existing column with a calculated column. See `setReplaceColumn`. Other accepted value: 'Calculate and replace column'.
`addCalculatedColumn`	Transformation used to create a new calculated column. See `setAddCalculatedColumn`. Other accepted value: 'Calculate new column'.
`renameColumns`	Transformation used to change the name of a set of columns according to an expression. See `setRenameColumns`. Other accepted value: 'Change column names'.
`changeDataType`	Transformation used to change the DataType of one or more columns. See `setChangeDataType`. Other accepted value: 'Change data types'.
`dataFunction`	Transformation using a previously registered data function. See `setDataFunction`. Other accepted value: 'Data function'.
`excludeColumns`	Transformation used to exclude a set of columns. See `setExcludeColumns`. Other accepted value: 'Exclude columns'.
`filterRows`	Transformation used to only keep the rows that match a given expression. See `setFilterRows`. Other accepted value: 'Filter rows'.
`pivot`	Transformation used to pivot tall-skinny data into short-wide data. See `setPivot`. Other accepted value: 'Pivot'.
`replaceSpecificValue`	Transformation used to replace values on specific rows, or on a single specific row. See `setReplaceSpecificValue`. Other accepted value: 'Replace specific value'.
`replaceValues`	Transformation used to replace all values in a column that match a given value. See `setReplaceValues`. Other accepted value: 'Replace value'.
`unpivot`	Transformation used to unpivot short-wide data into tall-skinny data. See `setUnpivot`. Other accepted value: 'Unpivot'.

Type: String

constant SpotfireDocumentLocation

Represents the enumeration for document location.

Properties:

Name	Description
`library`	Document will be save or present in the library
`local`	Document will be save or present in the local directory (only for Analyst)

Type: String

constant SpotfireExporterType

Properties:

Name	Description
`local`	Export to local folder. ONLY AVAILABLE IN SPOTFIRE ANALYST
`pipelinePilot`	Export to a Pipeline Pilot server.
`remote`	Export to a remote server using a POST request.

Type: String

constant SpotfireFilterRowType

Represents the enumeration for filter row types.

Properties:

Name	Description
`all`	No filter applied, all rows are selected.
`marking`	Filter only marked rows.
`filtering`	Filter only filtered rows.

Type: String

constant SpotfireFiltersTypes

Represents the enumeration for filter types.

Properties:

Name	Description
`rangeFilter`	The Range Filter type, see `SpotfireRangeFilter` for details on this filter.
`itemFilter`	The Item Filter type, see `SpotfireItemFilter` for details on this filter.
`radioButtonFilter`	The Radio Button Filter type, see `SpotfireRadioButtonFilter` for details on this filter.
`checkBoxFilter`	The Check Box Filter type, see `SpotfireCheckBoxFilter` for details on this filter.
`textFilter`	The Text Filter type, see `SpotfireTextFilter` for details on this filter.
`listBoxFilter`	The List Box Filter type, see `SpotfireListBoxFilter` for details on this filter.

Type: String

constant SpotfireFilterVisualScales

Represents the enumeration specifying the valid scale transformations available for filters.

Properties:

Name	Description
`log10`	A Log10 transformation. Other available value: 'Log10'.
`linear`	Linear transformation, leave data unchanged. Other available value: 'Linear'.

Type: String

constant SpotfireIndividualScalingModes

Properties:

Name	Description
`color`
`trellis`

Type: String

constant SpotfireItemFilteringValues

Represents the enumeration for the special values that an SpotfireItemFilter or SpotfireRadioButtonFilter may filter.

Properties:

Name	Description
`all`	Filter all values. Other available value: 'All' and '(All)'.
`empty`	All Empty values. Other available value: 'Empty' and '(Empty)'.
`none`	Filter no values. Other available value: 'None' and '(None)'.

Type: String

constant SpotfireLabelOrientations

Properties:

Name	Description
`horizontal`
`vertical`

Type: String

constant SpotfireLabelPositions

Properties:

Name	Description
`inside`	The label is placed inside the marker.
`outside`	The label is placed outside the marker.

Type: string

constant SpotfireLegendPositions

Represents the enumeration for legend positions.

Properties:

Name	Description
`left`	To place the legend on the left-hand side. Other available value: 'Left'.
`right`	To place the legend on the right-hand side. Other available value: 'Right'.

Type: String

constant SpotfireMapChartLayers

Represents the enumeration for map chart layers.

Properties:

Name	Description
`markerLayer`	The Marker layer, see `SpotfireMarkerLayer` for details on this layer.
`featureLayer`	The Feature layer, see `SpotfireFeatureLayer` for details on this layer.
`standardTileLayer`	The Standard Tile layer, see `SpotfireStandardTileLayer` for details on this layer.

Type: String

constant SpotfireMarkerClasses

Represents the enumeration for marker appearance.

Properties:

Name	Description
`simple`	Simple shapes are used as markers.
`chart`	Separate charts are used as markers.
`tile`	Tiled rectangles are used as markers.

Type: String

constant SpotfireOneScalePer

Represents the enumeration for the "One scale per" property.

Properties:

Name	Description
`column`	To have one separate scale for each column in the color scheme grouping, or to have one common scale applied to all the columns. Other available value: 'Column'.
`trellis`	To have one separate scale per trellis panel for trellised visualizations. Other available value: 'Trellis'.

Type: String

constant SpotfirePanelTypes

Represents the enumeration for panel types.

Properties:

Name	Description
`webPanel`	The Discngine Connector Web Panel. Other accepted values: 'Web panel', 'Web Panel' and 'Discngine Client Automation'.
`filters`	The Filters Panel. Other accepted value: 'Filters'.
`detailsOnDemand`	The Details-On-Demand Panel. Other accepted values: 'Details-on-Demand' and 'Details-On-Demand'.
`tags`	The Tags Panel. Other accepted value: 'Tags'.
`lists`	The Lists Panel. Other accepted value: 'Lists'.
`bookmarks`	The Bookmarks Panel. Other accepted value: 'Bookmarks'.
`webPage`	The Web Page Panel. Other accepted values: 'Web page' and 'Web Page'.

Type: String

constant SpotfirePositioningMethods

Represents the enumeration for positioning methods.

Properties:

Name	Description
`longitudeLatitude`	Positioning using longitude/latitude values.
`identifier`	Positioning using identifiers (geocoding).

Type: String

constant SpotfireScaleDockPositions

Properties:

Name	Description
`left`
`right`

Type: String

constant SpotfireShowHideItemsRulesTypes

Represents the Show/Hide Items rule types.

Properties:

Name	Description
`top`	Shows or hides the top number of items. Specify the number of items in the Value field.
`bottom`	Shows or hides the bottom number of items. Specify the number of items in the Value field.
`between`	Shows or hides all the items representing values between the two specified values. Specify the values in the two Value fields.
`equalTo`	Shows or hides all the items representing values that are equal to the specified value.
`notEqualTo`	Shows or hides all the items representing values that are not equal to the specified value.
`greaterThan`	Shows or hides all the items representing values greater than the specified value.
`greaterThanOrEqual`	Shows or hides all the items representing values greater than or equal to the specified value.
`lessThan`	Shows or hides all the items representing values less than the specified value.
`lessThanOrEqual`	Shows or hides all the items representing values less than or equal to the specified value.
`booleanExpression`	Lets you define a boolean expression. All the items for which the expression is true will be shown (or hidden, depending on which you select).
`string`

Type: String

constant SpotfireSortDirections

Properties:

Name	Description
`ascending`
`descending`

Type: String

constant SpotfireStringComparisonOperators

Properties:

Name	Description
`equal`
`notEqual`
`startsWith`
`endsWith`
`contains`

Type: String

constant SpotfireTableCellBorderStyles

Properties:

Name	Description
`none`
`solid`

Type: String

constant SpotfireTooltipFormats

Properties:

Name	Description
`valueNamesAndValues`
`visualizationPropertiesAndValues`

Type: String

constant SpotfireTrellisAxisHierarchyOptions

Properties:

Name	Description
`nest`
`cross`

Type: String

constant SpotfireTrellisModes

Properties:

Name	Description
`rowsColumns`
`panels`

Type: String

constant SpotfireValueRendererTypes

Properties:

Name	Description
`text`
`link`
`imageFromUrl`
`rdkit`	Render value as chemical structure using RDKit (!WARNING! RDKit renderer must be installed on the server)
`chemDraw`	Render value as chemical structure using chemDraw (!WARNING! ChemDraw renderer must be installed on the server)

Type: String

constant SpotfireWhenExistingBehaviors

Represents the enumeration for data types.

Properties:

Name	Description
`add`	Add behavior.
`replace`	Replace behavior.

Methods

instantiateSpotfireDocumentAsync(serverUrlOrDocumentParametersObject, documentPath, [onDocumentOpened], [configurationBlockText], [apiVersion], [initClientOptions]) → {Promise}

Loads all required dependencies and returns a Promise resolving with an instance of SpotfireDocument.

Parameters:

Name	Type	Description
`serverUrlOrDocumentParametersObject`	String \| DocumentParametersObject ▼	The TIBCO Spotfire® Server url or the DocumentParametersObject.
`serverUrl`	String	The Spotfire Server url, of the form 'http(s)://[server][:port]/spotfire/wp or the DocumentParametersObject.
`documentPath`	String	The complete path to the library document or its GUID.
`[ onDocumentOpened ]`	onDocumentOpenedEventHandler	The callback that will be executed after the document is opened.
`[ configurationBlockText ]`	String	The configuration block text that will be applied after the document is opened.
`[ apiVersion = '7.14' ]`	String	The webplayer apiVersion (for Spotfire 7.14+).
`[ initClientOptions ]`	InitClientOptions ▼	specific options to be used for web player UI customization
`[ pageIndex ]`	String	The page index to be opened at start
`[ targetDiv ]`	String	The location of the iframe for the Web Player
`[ customization ]`	Object	The customization options. See https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/html/T_spotfire_webPlayer_Customization.htm#! for details
`[ onCreateLoginElement ]`	onCreateLoginElement	The callback that returns a clickable DOM element to log into spotfire if needed
`[ reloadInstances ]`	Boolean	Maps the reloadInstances option from Spotfire JS API (WebPlayer only)
`[ emptyDocumentOnOpen ]`	Boolean	Whether to remove all data tables from the document on open opened.
`[ modApi ]`	Object	The mods API, to be used from spotfire 11.0 in a Mod context (Custom visualization)
`[ customPythonToolConfiguration ]`	CustomPythonToolConfiguration	The configuration to create a webconnector that uses custom python tool for execution of python script
`documentPath`	String	The complete path to the library document.
`[ onDocumentOpened ]`	OnDocumentOpenedEventHandler	The callback that will be executed after the document is opened.
`[ configurationBlockText ]`	String	The configuration block text that will be applied after the document is opened.
`[ apiVersion = '7.14' ]`	String	The WebPlayer API version (for Spotfire 7.14+).
`[ initClientOptions ]`	InitClientOptions ▼	The webplayer init client options.
`[ pageIndex ]`	String	The page index to be opened at start
`[ targetDiv ]`	String	The location of the iframe for the Web Player
`[ customization ]`	Object	The customization options. See https://docs.tibco.com/pub/sfire_dev/area/doc/api/TIB_sfire_Web_Player_JavaScript_API_Reference/html/T_spotfire_webPlayer_Customization.htm#! for details
`[ onCreateLoginElement ]`	onCreateLoginElement	The callback that returns a clickable DOM element to log into spotfire if needed

Returns:

A promise resolving to an instance of SpotfireDocument

Type: Promise

Type Definitions

Type: Object

DataTableProperty

Properties:

Name	Type	Description
`name`	String	The name of the property.
`value`	String \| Number \| Object	The value of the property.

LocalExporterArgs

Properties:

Name	Type	Description
`destinationPath`	String	The existing destination path of the file to be saved.
`destinationFile`	String	The name of the file.

onCreateLoginElement() → {HTMLElement}

Callback that will be executed when creating login element

Returns:

A clickable DOM element

Type: HTMLElement

onDocumentOpenedEventHandler()

Callback that will be executed after the open document. Invoked with an error object or null.

OnDocumentOpenedEventHandler()

Callback that will be executed after the open document. Invoked with an error object or null.

PipelinePilotExporterArgs

Properties:

Name	Type	Attributes	Description
`serverRoot`	string		The root URL of the Pipeline Pilot server.
`sessionId`	string		The Pipeline Pilot session id. Can be found in the Pipeline Pilot session cookie SCISID
`destinationPath`	string		The path on the server OS where the file will be saved. Typically `C:\Program Files\BIOVIA\PPS\public\users\<username>`
`destinationFile`	string	<nullable>	The name of the file to save. If not specified, the file will be named `[DataTableName].sbdf`

RemoteExporterArgs

Properties:

Name	Type	Attributes	Description
`url`	string		The url to send the data to
`fieldName`	string		The name of the field in form-data which will contain the file
`headers`	Object	<nullable>	Optional headers to send with the request