All files / lib/label-overlap set.js

100% Statements 68/68
100% Branches 7/7
100% Functions 1/1
100% Lines 68/68

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 6974x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 74x 26x 26x 14x 14x 19x 8x 8x 8x 8x 26x 74x 74x 74x 74x 74x  
/**
* @license Apache-2.0
*
* Copyright (c) 2026 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 isBoolean = require( '@stdlib/assert/is-boolean' ).isPrimitive;
var contains = require( '@stdlib/array/base/assert/contains' ).factory;
var join = require( '@stdlib/array/base/join' );
var format = require( '@stdlib/string/format' );
var changeEvent = require( './../change_event.js' );
var prop = require( './properties.js' );
 
 
// VARIABLES //
 
var debug = logger( 'vega:legend:set:'+prop.name );
var STRATEGIES = [
	'parity',
	'greedy'
];
var isStrategy = contains( STRATEGIES );
 
 
// MAIN //
 
/**
* Sets the strategy to use for resolving overlapping legend labels in gradient legends.
*
* @private
* @param {(boolean|string)} value - input value
* @throws {TypeError} must be a boolean or supported strategy
* @returns {void}
*/
function set( value ) {
	if ( !isBoolean( value ) && !isStrategy( value ) ) {
		throw new TypeError( format( 'invalid assignment. `%s` must be a boolean or one of the following: "%s". Value: `%s`.', prop.name, join( STRATEGIES, '", "' ), value ) );
	}
	if ( value !== this[ prop.private ] ) {
		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;