Add render methods

kgryte · kgryte · commit b39fb4e0d1d1 · 2018-04-10T21:45:28.000+01:00
diff --git a/lib/node_modules/@stdlib/plot/base/ctor/lib/main.js b/lib/node_modules/@stdlib/plot/base/ctor/lib/main.js
@@ -676,6 +676,42 @@ Object.defineProperty( Plot.prototype, 'paddingTop', {
 	'get': require( './props/padding-top/get.js' )
 });
 
+/**
+* Renders a plot.
+*
+* @name render
+* @memberof Plot.prototype
+* @type {Function}
+* @param {string} [format] - render format
+* @throws {TypeError} must provide a recognized format
+* @returns {(VTree|string)} virtual tree or string
+*
+* @example
+* var plot = new Plot();
+* var out = plot.render();
+*
+* @example
+* var plot = new Plot();
+* var out = plot.render( 'html' );
+*/
+setReadOnly( Plot.prototype, 'render', require( './render' ) );
+
+/**
+* Renders a plot.
+*
+* ## Notes
+*
+* -   This method **should** be implemented by descendants.
+*
+* @private
+* @name _render
+* @memberof Plot.prototype
+* @type {Function}
+* @param {string} [format] - render format
+* @returns {(VTree|string)} rendered plot
+*/
+setReadOnly( Plot.prototype, '_render', require( './render/stub.js' ) );
+
 /**
 * Render format.
 *
diff --git a/lib/node_modules/@stdlib/plot/base/ctor/lib/render/index.js b/lib/node_modules/@stdlib/plot/base/ctor/lib/render/index.js
@@ -0,0 +1,70 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 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 logger = require( 'debug' );
+
+
+// VARIABLES //
+
+var debug = logger( 'plot:base:render' );
+
+
+// MAIN //
+
+/**
+* Renders a plot.
+*
+* @private
+* @param {string} [format] - render format
+* @returns {(VTree|string)} virtual tree or a string
+*/
+function render( format ) {
+	/* eslint-disable no-invalid-this, no-underscore-dangle */
+	var out;
+	var tmp;
+	var fmt;
+
+	tmp = this.renderFormat;
+	if ( arguments.length ) {
+		// Temporarily set the render format:
+		this.renderFormat = format;
+		fmt = format;
+	} else {
+		fmt = tmp;
+	}
+	debug( 'Render format: %s.', this.renderFormat );
+
+	debug( 'Rendering...' );
+	out = this._render( fmt );
+	this.emit( 'render', out );
+
+	if ( arguments.length ) {
+		// Restore the render format:
+		this.renderFormat = tmp;
+	}
+	return out;
+}
+
+
+// EXPORTS //
+
+module.exports = render;
diff --git a/lib/node_modules/@stdlib/plot/base/ctor/lib/render/stub.js b/lib/node_modules/@stdlib/plot/base/ctor/lib/render/stub.js
@@ -0,0 +1,35 @@
+/**
+* @license Apache-2.0
+*
+* Copyright (c) 2018 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';
+
+/**
+* Placeholder `render` function.
+*
+* @private
+* @param {string} fmt - render format
+* @throws {Error} must be implemented by descendant classes
+*/
+function render() {
+	throw new Error( 'method not implemented.' );
+}
+
+
+// EXPORTS //
+
+module.exports = render;
