Connector JavaScript API Reference

Constructor

new SpotfireColorAxis(colorAxisDescription)

Parameters:

Name	Type	Description
`colorAxisDescription`	colorAxisDescription ▼
`columns`	String	Specifies the column or hierarchy to color by.
`[ colorMode ]`	SpotfireColorModes {Enum} ▼	Specifies in which color mode to set up the color scheme. Which modes are available depend on whether the scale is in categorical or continuous mode. For columns in continuous scale mode, you can select one of the following color modes: Gradient, Segments, or Fixed. For columns in categorical scale mode, you can select either Categorical or Fixed color mode.
	Enum options: fixed, categorical, gradient, segments, uniqueValues
`defaultColor`	String \| Object	Specifies the default color to be used, in the hexadecimal format, with color name, or the ARGB object. Especially used with the 'Fixed' color mode.
`[ oneScalePer ]`	SpotfireOneScalePer {Enum} ▼	Specifies whether there should be one separate scale per trellis panel for trellised bar charts, or if one scale should apply to the entire visualization. Only applicable to columns in continuous scale mode.
	Enum options: column, trellis
`[ templateLibraryPath ]`	String	The path in the library of the file that contains a color scheme to be applied to the visualization.
`[ templateUrl ]`	String	The URL of the file that contains a color scheme to be applied to the visualization.
`[ templateName ]`	String	The name of the document color scheme.
`[ colorRules ]`	Object \| Array.<Object>	Array of color rules to be applied on the visualization.
`displayName`	String	Optionally specify a descriptive name for the rule. The name is used to identify the rule in the Visualization Properties dialog, and it can be displayed in the legend of the visualization. Leave the field blank if you want to use the default rule name.
`color`	String \| Object	Specifies the color to be used for the rule, in the hexadecimal format, with color name, or the ARGB object.
`[ a ]`	Number	Opacity factor, between 0 and 255.
`[ r ]`	Number	Red intensity, between 0 and 255.
`[ g ]`	Number	Green intensity, between 0 and 255.
`[ b ]`	Number	Blue intensity, between 0 and 255.
`[ a ]`	Number	Opacity factor, between 0 and 255.
`[ r ]`	Number	Red intensity, between 0 and 255.
`[ g ]`	Number	Green intensity, between 0 and 255.
`[ b ]`	Number	Blue intensity, between 0 and 255.
`type`	SpotfireColoringRulesTypes {Enum} ▼	Specifies which rule type to add. Which types are available depends on the data type of the column, or hierarchy that the rule is applied to.
	Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, gradient, segments, uniqueValues, string
`value`	Number \| String	Defines the value the rule should apply to. The available options depend on the rule type.
`startValue`	Number	Only available for the "Between" type. Specifies the minimum value the rule should apply to.
`endValue`	Number	Only available for the "Between" type. Specifies the maximum value the rule should apply to.
`expression`	String	Only available for the "Boolean expression" type. Specifies the expression the rule should apply to, all the items for which the expression is true will get the specified color.
`[ colorPoints ]`	Object \| Array.<Object>	Array of anchor points to be applied on the visualization. Available for continuous columns only.
`type`	SpotfireColoringRulesTypes {Enum} ▼	Specifies which point type to add. Only types for continuous columns are available.
	Enum options: top, bottom, between, equalTo, notEqualTo, greaterThan, greaterThanOrEqual, lessThan, lessThanOrEqual, booleanExpression, gradient, segments, uniqueValues, string
`value`	Number \| String	Defines the value the rule should apply to. The available options depend on the point type.
`color`	String \| Object	Specifies the color to be used for the anchor point, in the hexadecimal format, with color name, or the ARGB object.

Examples

const colorAxisDescription = {
    columns: ['my column'],
    colorMode: 'Fixed',
    defaultColor: '#FF0000'
}

const colorAxisDescription = {
    columns: ['my column'],
    colorMode: 'Fixed',
    colorRules: {
        type: 'Between',
        startValue: 1,
        endValue: 3,
        color: '#FF0000'
    }
}

const colorAxisDescription = {
    columns: ['my categorical column'],
    colorMode: 'Categorical',
    colorRules: {
        type: 'Contains',
        value: 'val_',
        color: '#FFD633',
        displayName: 'Contains val_'
    }
}

const colorAxisDescription = {
    columns: ['my continuous column'],
    colorMode: 'Gradient',
    colorRules: [
        {
            type: 'Top',
            value: 3,
            color: '#FF0000'
        },
        {
            type: 'Bottom',
            value: 3,
            color: '#FF0000'
        }
    ],
    colorPoints: {
        type: 'Median',
        color: '#FFD633'
    }
}

const colorAxisDescription = {
    columns: ['aColumn'],
    templateLibraryPath: '/myLibraryFolder/color_scheme_file'
}