ngx-score v0.3.0

ngx-score - Utility to view (and edit) music scores written in musicXML, abc notation or Vex-style provided as an Angular module.

Demo

View all the directives in action at https://bohoffi.github.io/ngx-score

Dependencies

• Angular (requires Angular 4 or higher, tested with 4.1.0)
• vexflow (requires Angular 1.2.83 or higher, tested with 1.2.83)

Installation

Install above dependencies via npm.

Now install ngx-score via:

npm install --save ngx-score

SystemJS

Note:If you are using SystemJS, you should adjust your configuration to point to the UMD bundle. In your systemjs config file, map needs to tell the System loader where to look for ngx-score:

map: {
  'ngx-score': 'node_modules/ngx-score/bundles/ngx-score.umd.js'
}

---

Once installed you need to import the main module:

import {NgxScoreModule} from 'ngx-score';

The only remaining part is to list the imported module in your application module. The exact method will be slightly different for the root (top-level) module for which you should end up with the code similar to (notice NgxScoreModule.forRoot()):

import {NgxScoreModule} from 'ngx-score';

@NgModule({
  declarations: [AppComponent],
  imports: [NgxScoreModule.forRoot()],  
  bootstrap: [AppComponent]
})
export class AppModule {
}

Other modules in your application can simply import NgxScoreModule:

import {NgxScoreModule} from 'ngx-score';

@NgModule({
  declarations: [OtherComponent],
  imports: [NgxScoreModule], 
})
export class OtherModule {
}

Usage

Tokenizer

Initializing a tokenizer is as easy as initializing a string variable:

import {createTokenizer, ITokenizer} from 'ngx-score';

const tokenizer: ITokenizer = createTokenizer('TAB');

Methods

• parse(input: any): any: Parses the given input using the rules defined by the tokenizer type
• getType(): TokenizerType: returns the type of the tokenizer

Example

import {createTokenizer, ITokenizer, Common} from 'ngx-score';

const tokenizer: ITokenizer<Array<Common.Measure>> = createTokenizer('TAB');
const result: Array<Common.Measure> = tokenizer.parse('B:3/4 6>0 5>2 4>2|B:3/4 3>0 2>0 1>0');

Renderer

Initializing the renderer is damn easy too

import {createTokenizer, ITokenizer, createRenderer, IRenderer, Common} from 'ngx-score';

// creating the tokenizer
const tokenizer: ITokenizer<Array<Common.Measure>> = createTokenizer('TAB');

// creating the rendering container
const container = document.getElementById('main');
const canvas = document.createElement('canvas');
container.appendChild(canvas);

const renderer: IRenderer = createRendere(tokenizer, canvas);

Methods

• render(data: any): void: renders the given data in the given container

Example

import {createTokenizer, ITokenizer, createRenderer, IRenderer, Common} from 'ngx-score';

// creating the tokenizer
const tokenizer: ITokenizer<Array<Common.Measure>> = createTokenizer('TAB');

// creating the rendering container
const container = document.getElementById('main');
const canvas = document.createElement('canvas');
container.appendChild(canvas);

// creating the renderer
const renderer: IRenderer = createRendere(tokenizer, canvas);

// parsing
const result: Array<Common.Measure> = tokenizer.parse('B:3/4 6>0 5>2 4>2|B:3/4 3>0 2>0 1>0');

// rendering
renderer.render(result);

License

Copyright (c) 2017 bohoffi. Licensed under the MIT License (MIT)