README.md

gridAlignments

List of supported Vega grid alignments.

Usage

var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' );

gridAlignments()

Returns a list of grid alignments.

var out = gridAlignments();
// returns [ 'all', 'each', 'none' ]

Examples

var contains = require( '@stdlib/array/base/assert/contains' ).factory;
var gridAlignments = require( '@stdlib/plot/vega/base/grid-alignments' );

var isGridAlignment = contains( gridAlignments() );

var bool = isGridAlignment( 'all' );
// returns true

bool = isGridAlignment( 'each' );
// returns true

bool = isGridAlignment( 'beep' );
// returns false

bool = isGridAlignment( 'boop' );
// returns false