SpotfireColorAxis

new SpotfireColorAxis(colorAxisDescription)

Parameters:

Name	Type	Description
[ colorAxisDescription ]	SpotfireAxisDescription ▼
type	string	The type of the axis to create.
columns	Array.<string>	Specifies the column or hierarchy to use for the Axis. Note: We strongly recommend to escape the column names using square brackets (column names must be identical to the 'Edit expression' field in TIBCO Spotfire).
axisMode	string	Specifies whether the column or hierarchy should be treated as continuous or categorical. From SpotfireAxisModes
categoryMode	string	Determines how to display the categories. 'Show filtered values': to display values available after current filtering only; 'Show filtered range': to hide empty categories on both ends of the currently visible range; 'Show all values': to keep all categories visible even if data for some categories have been filtered out. From SpotfireCategoryModes
evaluationMode	string	Determines how to evaluate the axis. 'Auto': to automatically evaluate the axis based on the data; 'Manual': to manually evaluate the axis based on the specified range. From SpotfireAxisEvaluationMode

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