Title

Global

Methods

instanciateSpotfireDocumentAsync(serverUrlOrDocumentParametersObject, documentPath, [onDocumentOpened], [configurationBlockText], [sfConnector], [defaultSerializer], [apiVersion])

Loads all required dependencies and returns an instance of SpotfireDocument.

Parameters:
Name Type Default Description
serverUrlOrDocumentParametersObject String | DocumentParametersObject

The TIBCO Spotfire® Server url or the DocumentParametersObject.

serverUrl String

The Spotfire Server url, of the form 'htt(s)://[server][:port]/spotfire/wp or the DocumentParametersObject.

documentPath String

The complete path to the library document.

[ onDocumentOpened ] onDocumentOpenedEventHandler

The callback that will be executed after the document is opened.

[ err ] Error

The error that may have occurred or undefined.

[ 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+).

documentPath String

The complete path to the library document.

[ onDocumentOpened ] onDocumentOpenedEventHandler

The callback that will be executed after the document is opened.

[ err ] Error

The error that may have occurred or undefined.

[ configurationBlockText ] String

The configuration block text that will be applied after the document is opened.

[ sfConnector ] SpotfireConnectorBase

The Spotfire connector that will be used by this instance (used for unit test).

[ defaultSerializer ] SpotfireDocumentEditorDefaultSerializer

The serializer that will be used to serialize the state to python script when applying state.

[ apiVersion = '7.14' ] String

The WebPlayer API version (for Spotfire 7.14+).

Type Definitions

Enum

SpotfireApplyTo

Properties:
Name Description
background

Apply property to background

text

Apply property to text

Enum

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'.

Enum

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'.

Enum

SpotfireAxisTypes

Represents the enumeration for axis types.

Properties:
Name Description
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.

colorAxis

Axis used to define coloring within a visualization.

trellisAxis

Axis used to define a trellis.

sectorSizeAxis

Axis used to define sector sizes (Pie Chart).

heatMapMeasureAxis

Axis used to define heat map measures.

sizeAxis

Axis used to define the "size by" properties.

Enum

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'.

Enum

SpotfireBarChartOrientations

Represents the enumeration for bar chart orientations (Appearance).

Properties:
Name Description
vertical

To display the bars in the visualization vertically.
Other available values: 'Vertical bars', 'Vertical'.

horizontal

To display the bars in the visualization horizontally.
Other available values: 'Horizontal bars', 'Horizontal'.

Enum

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'.

Enum

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
Enum

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'.

Enum

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.

Enum

SpotfireComparisonOperators

Properties:
Name Description
less
lessOrEqual
equal
notEqual
greater
greaterOrEqual
Enum

SpotfireConditionalValueTypes

Properties:
Name Description
min
max
average
median
literal
percent
percentile
expression
Enum

SpotfireDataColumnsTypes

Properties:
Name Description
calculatedDataColumn

Calculated data column type.

Enum

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.

Enum

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)

Enum

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.

Enum

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.

Enum

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'.

Enum

SpotfireIndividualScalingModes

Properties:
Name Description
color
trellis
Enum

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)'.

Enum

SpotfireLabelOrientations

Properties:
Name Description
horizontal
vertical
Enum

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'.

Enum

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'.

Enum

SpotfireScaleDockPositions

Properties:
Name Description
left
right
Enum

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
Enum

SpotfireSortDirections

Properties:
Name Description
ascending
descending
Enum

SpotfireStringComparisonOperators

Properties:
Name Description
equal
notEqual
startsWith
endsWith
contains
Enum

SpotfireTableCellBorderStyles

Properties:
Name Description
none
solid
Enum

SpotfireTooltipFormats

Properties:
Name Description
valueNamesAndValues
visualizationPropertiesAndValues
Enum

SpotfireTrellisAxisHierarchyOptions

Properties:
Name Description
nest
cross
Enum

SpotfireTrellisModes

Properties:
Name Description
rowsColumns
panels
Enum

SpotfireValueRendererTypes

Properties:
Name Description
text
link
imageFromUrl