All files / lib/interpolate set.js

100% Statements 72/72
100% Branches 8/8
100% Functions 1/1
100% Lines 72/72

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 7313x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 13x 22x 22x 22x 14x 14x 8x 15x 7x 7x 7x 7x 7x 22x 13x 13x 13x 13x 13x  
/**
* @license Apache-2.0
*
* Copyright (c) 2025 The Stdlib Authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
*    http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
 
/* eslint-disable no-invalid-this */
 
'use strict';
 
// MODULES //
 
var logger = require( 'debug' );
var isDeepEqual = require( '@stdlib/assert/deep-equal' );
var isInterpolationMethod = require( '@stdlib/plot/vega/base/assert/is-scale-range-interpolation-method' );
var isObject = require( '@stdlib/assert/is-object' );
var isUndefined = require( '@stdlib/assert/is-undefined' );
var copy = require( '@stdlib/utils/copy' );
var format = require( '@stdlib/string/format' );
var changeEvent = require( './../change_event.js' );
var prop = require( './properties.js' );
 
 
// VARIABLES //
 
var debug = logger( 'vega:scale:set:'+prop.name );
 
 
// MAIN //
 
/**
* Sets the scale range interpolation method.
*
* ## Notes
*
* -   Providing `undefined` "unsets" the configured value.
*
* @private
* @param {(string|Object|void)} value - input value
* @throws {TypeError} must be a valid interpolation method
* @returns {void}
*/
function set( value ) {
	var flg = isInterpolationMethod( value );
	if ( !flg && !isObject( value ) && !isUndefined( value ) ) {
		throw new TypeError( format( 'invalid assignment. `%s` must be either an object or a valid interpolation method. Value: `%s`.', prop.name, value ) );
	}
	// TODO: explore whether we can be more intelligent when performing deep equality checks for an interpolation object rather than relying on a general deep equality check.
	if ( !isDeepEqual( value, this[ prop.private ] ) ) {
		value = copy( value );
		debug( 'Current value: %s. New value: %s.', this[ prop.private ], value );
		this[ prop.private ] = value;
		this.emit( 'change', changeEvent( prop.name ) );
	}
}
 
 
// EXPORTS //
 
module.exports = set;