feat: add plot/vega/mark/rule/encoding

PR-URL: #14059
Reviewed-by: Athan Reines <kgryte@gmail.com>

Author: Sachinn-64

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/examples/index.js

@@ -0,0 +1,39 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+var Value = require( '@stdlib/plot/vega/value/ctor' );
+var RuleEncodingSet = require( '@stdlib/plot/vega/mark/rule/encoding-set' );
+var RuleEncoding = require( './../lib' );
+
+var update = new RuleEncodingSet({
+	'x': new Value({
+		'field': 'x',
+		'scale': 'xScale'
+	}),
+	'y': new Value({
+		'field': 'y',
+		'scale': 'yScale'
+	})
+});
+
+var encoding = new RuleEncoding({
+	'update': update
+});
+console.log( encoding.toJSON() );

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/change_event.js

@@ -0,0 +1,41 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MAIN //
+
+/**
+* Returns a new change event object.
+*
+* @private
+* @param {string} property - property name
+* @returns {Object} event object
+*/
+function event( property ) { // eslint-disable-line stdlib/no-redeclare
+	return {
+		'type': 'update',
+		'source': 'mark',
+		'property': property
+	};
+}
+
+
+// EXPORTS //
+
+module.exports = event;

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/custom/index.js

@@ -0,0 +1,91 @@
+/**
+* @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 isRuleEncodingSet = require( '@stdlib/plot/vega/base/assert/is-rule-mark-encoding-set' );
+var isUndefined = require( '@stdlib/assert/is-undefined' );
+var property2object = require( '@stdlib/plot/vega/base/property2object' );
+var format = require( '@stdlib/string/format' );
+var changeEvent = require( './../change_event.js' );
+
+
+// VARIABLES //
+
+var debug = logger( 'vega:mark:rule:encoding:set:custom' );
+
+
+// MAIN //
+
+/**
+* Returns a getter and setter for a custom encoding set.
+*
+* @private
+* @param {string} name - encoding set name
+* @returns {Object} object containing a getter and setter
+*/
+function factory( name ) {
+	var prop = property2object( name );
+	return {
+		'get': get,
+		'set': set
+	};
+
+	/**
+	* Returns an encoding set specifying visual encoding properties for a custom encoding set.
+	*
+	* @private
+	* @returns {(RuleEncodingSet|void)} encoding set
+	*/
+	function get() {
+		return this[ prop.private ];
+	}
+
+	/**
+	* Sets the encoding set specifying visual encoding properties for a custom encoding set.
+	*
+	* ## Notes
+	*
+	* -   Providing `undefined` "unsets" the configured value.
+	*
+	* @private
+	* @param {(RuleEncodingSet|void)} value - input value
+	* @throws {TypeError} must be a rule mark encoding set
+	* @returns {void}
+	*/
+	function set( value ) {
+		if ( !isRuleEncodingSet( value ) && !isUndefined( value ) ) {
+			throw new TypeError( format( 'invalid assignment. `%s` must be a rule mark encoding set. Value: `%s`.', prop.name, 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 = factory;

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/enter/get.js

@@ -0,0 +1,43 @@
+/**
+* @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 prop = require( './properties.js' );
+
+
+// MAIN //
+
+/**
+* Returns an encoding set specifying visual encoding properties when marks are newly added to a visualization scene.
+*
+* @private
+* @returns {(RuleEncodingSet|void)} encoding set
+*/
+function get() {
+	return this[ prop.private ];
+}
+
+
+// EXPORTS //
+
+module.exports = get;

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/enter/properties.js

@@ -0,0 +1,33 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var property2object = require( '@stdlib/plot/vega/base/property2object' );
+
+
+// MAIN //
+
+var obj = property2object( 'enter' );
+
+
+// EXPORTS //
+
+module.exports = obj;

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/enter/set.js

@@ -0,0 +1,66 @@
+/**
+* @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 isRuleEncodingSet = require( '@stdlib/plot/vega/base/assert/is-rule-mark-encoding-set' );
+var isUndefined = require( '@stdlib/assert/is-undefined' );
+var format = require( '@stdlib/string/format' );
+var changeEvent = require( './../change_event.js' );
+var prop = require( './properties.js' );
+
+
+// VARIABLES //
+
+var debug = logger( 'vega:mark:rule:encoding:set:'+prop.name );
+
+
+// MAIN //
+
+/**
+* Sets the encoding set specifying visual encoding properties when marks are newly added to a visualization scene.
+*
+* ## Notes
+*
+* -   Providing `undefined` "unsets" the configured value.
+*
+* @private
+* @param {(RuleEncodingSet|void)} value - input value
+* @throws {TypeError} must be a rule mark encoding set
+* @returns {void}
+*/
+function set( value ) {
+	if ( !isRuleEncodingSet( value ) && !isUndefined( value ) ) {
+		throw new TypeError( format( 'invalid assignment. `%s` must be a rule mark encoding set. Value: `%s`.', prop.name, 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;

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/exit/get.js

@@ -0,0 +1,43 @@
+/**
+* @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 prop = require( './properties.js' );
+
+
+// MAIN //
+
+/**
+* Returns an encoding set specifying visual encoding properties when marks are removed from a visualization scene.
+*
+* @private
+* @returns {(RuleEncodingSet|void)} encoding set
+*/
+function get() {
+	return this[ prop.private ];
+}
+
+
+// EXPORTS //
+
+module.exports = get;

lib/node_modules/@stdlib/plot/vega/mark/rule/encoding/lib/exit/properties.js

@@ -0,0 +1,33 @@
+/**
+* @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.
+*/
+
+'use strict';
+
+// MODULES //
+
+var property2object = require( '@stdlib/plot/vega/base/property2object' );
+
+
+// MAIN //
+
+var obj = property2object( 'exit' );
+
+
+// EXPORTS //
+
+module.exports = obj;