Bootprint

The Spotfire mod manifest schema

version: string , must match ^(.*)$

Specifies the version of this Mod.

apiVersion: string 2.0 , must match ^(.*)$

Specifies the version of the Mod JavaScript API used by the code of this Mod. Set the lowest possible version number that the Mod requires to ensure best possible backward compatibility with older Spotfire systems. Using a newer API version than specified will result in runtime errors, even if the current Spotfire system includes that API.

name: string , must match ^(.*)$

Specifies the name of this Mod. The name will be shown to the user when this Mod is handled in Spotfire.

description: string , must match ^(.*)$

Specifies the description of this Mod. The description will be shown to the user of the mod.

icon: string icon.svg

id: string , must match ^[a-zA-Z0-9]+[a-zA-Z0-9-._]*(?<=[a-zA-Z0-9])$

type: string , x ∈ { visualization (default) } , must match ^(.*)$

externalResources: string[]

Only declared external resources will work in the mod. A visualization mod with external resources cannot be exported using the web client.

string

properties: object[]

Specifies the properties that are stored in this Mods part of the Spotfire document. Use properties to store settings values.

object

name: string , must match ^(.*)$: Specifies the unique name used to refer to this property from the code.
type: string , x ∈ { integer , double , string (default) , boolean } , must match ^(.*)$: Specifies the type of values stored by this property.
defaultValue: string,number,boolean , must match ^(.*)$: Specifies the value that this property will have when an instance of the Mod is created.

dataViewDefinition: object [object Object]

Specifies how Spotfire computes the data consumed by the Mod.

colorAxis:

axis

Specifies that the Mod shall have a color axis.

legendItem: object

Specifies behavior and properties of how this axis is shown in the legend.

defaultVisibility: string , x ∈ { visible , hidden }: Specifies whether to initially show or hide the item for this axis in the legend.

axes: []

Specifies the axes that defines how Spotfire computes the data view consumed by the Mod.

axis

name: string X , must match ^(.*)$

Specifies the unique named used to refer to this axis from the code.

allowMultipleMeasures: boolean

Specifies if this axis supports having multiple measure expression when it is in continuous mode.

placement: string , x ∈ { left , bottom , top , right , none }

Specifies the placement of the axis tray for this axis.

legendItem: object

Specifies behavior and properties of how this axis is shown in the legend.

defaultVisibility: string , x ∈ { visible (default) , hidden }: Specifies whether to initially show or hide the item for this axis in the legend.
title: string: Specifies the title to show in the item for this axis in the legend.

propertyControl: object

Specifies behavior and properties of how a control for this axis is shown in the properties dialog.

visibility: string , x ∈ { visible (default) , hidden }: Specifies whether to show a control for this axis in the properties dialog.
title: string: Specifies the title of the control for this axis.

tooltip: object [object Object]

Specifies how the Mod uses Spotfire native style configurable tooltips. Added in API version 1.3

enabled: boolean true: Specifies whether to enable configurable tooltips, both in the API and in the properties dialog.

legend: object [object Object]

Specifies properties of the Spotfire Legend for the Mod.

defaultPlacement: string , x ∈ { left , right }: Specifies where the Legend is initially placed. If omitted, the Legend will be placed to the right.
defaultVisibility: string , x ∈ { visible , hidden }: Specifies whether to initially show or hide the Legend. If omitted, the Legend will be shown.

files: string[]

All files of a mod will be saved into Spotfire. The files array lists all files so that Spotfire can save them.

string , must match ^(.*)$

Definitions

axis: object

Specifies properties that can be used to configure Axis and ColorAxis entries.

mode: string , x ∈ { continuous , categorical , dual }

Specifies what kind of expressions this axis supports: categorical, continuous or both.

preferredDualMode: string , x ∈ { continuous , categorical (default) }

Specifies the mode that this axis prefers to be in. This option only applies if this axis is configured with mode 'dual'.

allowNonAggregatingMeasures: boolean

Specifies if this axis supports non-aggregating expressions (expressions without an aggregation method) when it is in continuous mode.

automaticConfiguration: object

Specifies how automatic configuration is made for this axis when the Mod Visualization is created.

expressionHeuristics: string , x ∈ { none , default (default) }: Specifies the heuristics to use when this axis is assigned an initial expression. Use 'none' to skip the heuristics and leave this axis with an empty expression.
priority: integer 0: Specifies the order in which this axis will be treated when the heuristics assigns the initial expression. A higher value means it will be treated before axes with a lower value. Two axes with the same value will be treated in undefined order.

dataTypes: object

Specifies which data types that this axis should support. These settings affect which expressions that Spotfire will consider valid for this axis.

allowNumeric: boolean true: Specifies whether to allow expressions with numeric data types.
allowDateTime: boolean: Specifies whether to allow expressions with Time, Date and DateTime data types.
allowTimeSpan: boolean: Specifies whether to allow expressions with TimeSpan data type.
allowString: boolean: Specifies whether to allow expressions with String data type.
allowBoolean: boolean: Specifies whether to allow expressions with Boolean data type.

dropTarget: object

Specifies the drop target behavior for this axis.

icon: string , x ∈ { XAxis , YAxis , XAxis3D , YAxis3D , ZAxis3D , SectorSize , MarkerSize , Size , Color , Shape , Line , TrellisPanels , TrellisHorizontally , TrellisVertically , Column , ColumnAxis , RowAxis , CellValues , CellValuesSum , Icon , Tile , Hierarchy , Time , Compare , TableCategories }: Specifies which, from a selection of built-in icons, to use as the drop target.
description: string: Specifies the text to display when dragging an expression or column over the drop target. Use {0} to inject the name of the item being dragged.