Matrix Requirements SDK Reference

This is the reference documentation for the Matrix Requirements SDK (github link, npmjs link).

To get started with the SDK, see the User's Guide. The most important classes in this auto-generated documentation are:

• StandaloneMatrixSDK - represents a Matrix Instance. Can be queried for projects and settings
• Project - represents a Matrix Project. Can be queried for Items
• Item - represents a Matrix Item within a Project of a particular type (Category). Can be examined/changed.
• Category - information about a Category within a Project.
• Field - an Item of a particular Category contains Fields of that Category.

Client SDK

If you are writing a plugin to be integrated with the Matrix application, the following functions are interesting in addition to the classes above:

• getSdkInstance
• registerPlugin

We provide a boilerplate project for writing plugins here.