Type Definitions
addColumnsSettings
Properties:
Name | Type | Attributes | Default | Description |
---|---|---|---|---|
targetIdColumn |
string | the name of the column used as identifier in the target datatable |
||
sourceIdColumn |
string | the name of the column used as identifier in the imported source |
||
otherColumnsMatching |
Array.<ColumnMatching> | list of columns matching to apply. The column of the target will be replace by default by the imported column |
||
replaceCommonColumns |
boolean |
<optional> |
false | indicate if all common columns are replace or duplicated (using number to identify imported column) |
columnsToReplace |
Array.<string> |
<optional> |
list of columns to be replaced by imported ones (if you do not want to have all common columns to be replaced) |
ColumnMatching
Description of a matching between columns.
Properties:
Name | Type | Description |
---|---|---|
targetColumn |
String | The name of the column in the target data table to use for the matching. |
sourceColumn |
String | The name of the column in the source data table to use for the matching. |
DataTableProperty
Properties:
Name | Type | Description |
---|---|---|
name |
string | the name of the property |
value |
string | number | object | the value of the property |
DocumentClosedEventHandler(analysisPath)
Callback to be executed after the document is closed.
Parameters:
Name | Type | Description |
---|---|---|
analysisPath
|
string | the path of the document which was closed |
DocumentOpenedEventHandler([err])
Callback that will be executed after the open document. Invoked with an error object or null
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err
|
Error |
<optional> |
the error that may have occured |
markedRows
Properties:
Name | Type | Description |
---|---|---|
columnName1 |
Array.<string> | the list of values for each rows for the column name |
columnName2 |
Array.<string> | the list of values for each rows for the column name |
columnNameN |
Array.<string> | the list of values for each rows for the column name |
onConnectorReadyCb([err])
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
err
|
Error |
<optional> |
the error that may have occured after the connector instance is ready to used |
onDocumentClosedCb(analysisPath)
Parameters:
Name | Type | Description |
---|---|---|
analysisPath
|
string | the path to the current analysis that is being closed |
onDocumentOpenedCb(responseCode, responseMessage)
Parameters:
Name | Type | Description |
---|---|---|
responseCode
|
number | |
responseMessage
|
string |
onMarkingChangedCb(markedRows)
Parameters:
Name | Type | Description |
---|---|---|
markedRows
|
Array.<string> | the list of newly marked rows |
SpotfireApplyTo
Properties:
Name | Description |
---|---|
background |
Apply property to background |
text |
Apply property to text |
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'. |
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'. |
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). |
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'. |
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'. |
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'. |
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 |
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'. |
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. |
SpotfireComparisonOperators
Properties:
Name | Description |
---|---|
less |
|
lessOrEqual |
|
equal |
|
notEqual |
|
greater |
|
greaterOrEqual |
SpotfireConditionalValueTypes
Properties:
Name | Description |
---|---|
min |
|
max |
|
average |
|
median |
|
literal |
|
percent |
|
percentile |
|
expression |
SpotfireDataColumnsTypes
Properties:
Name | Description |
---|---|
calculatedDataColumn |
Calculated data column type. |
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) |
SpotfireIndividualScalingModes
Properties:
Name | Description |
---|---|
color |
|
trellis |
SpotfireLabelOrientations
Properties:
Name | Description |
---|---|
horizontal |
|
vertical |
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'. |
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'. |
SpotfireScaleDockPositions
Properties:
Name | Description |
---|---|
left |
|
right |
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 |
SpotfireSortDirections
Properties:
Name | Description |
---|---|
ascending |
|
descending |
SpotfireStringComparisonOperators
Properties:
Name | Description |
---|---|
equal |
|
notEqual |
|
startsWith |
|
endsWith |
|
contains |
SpotfireTableCellBorderStyles
Properties:
Name | Description |
---|---|
none |
|
solid |
SpotfireTooltipFormats
Properties:
Name | Description |
---|---|
valueNamesAndValues |
|
visualizationPropertiesAndValues |
SpotfireTrellisAxisHierarchyOptions
Properties:
Name | Description |
---|---|
nest |
|
cross |
SpotfireTrellisModes
Properties:
Name | Description |
---|---|
rowsColumns |
|
panels |
SpotfireValueRendererTypes
Properties:
Name | Description |
---|---|
text |
|
link |
|
imageFromUrl |