ITypeMeta
pentaho.module.spec. ITypeMeta
The spec.ITypeMeta
interface contains the metadata of a type module.
Source: doc-js/pentaho/module/spec/ITypeMeta.jsdoc, line 17
Extends
Members
Name | Description |
---|---|
alias : nonEmptyString | The alias of the module. |
ancestor : nonEmptyString | The alias or identifier of the type's base type. |
annotations : Object.<string, (null | object | boolean)> | The map of global module annotations' configurations. |
base : nonEmptyString | The alias or identifier of the type's base type. |
config : object | The module's global configuration object. |
isVirtual : boolean | Indicates if the module is virtual. |
ranking : number | The ranking of the module. |
value : * | function | The value of the module or a function that creates it. |
Members Details
alias: nonEmptyString |
---|
The alias of the module. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 30 Inherited From: pentaho.module.spec.IMeta#alias |
ancestor: nonEmptyString |
---|
The alias or identifier of the type's base type. When This property is a synonym for |
annotations: Object.<string, (null | object | boolean)> |
---|
The map of global module annotations' configurations. A map whose keys are annotation module identifiers and whose values are global annotation configurations. Annotations can be further configured, conditionally, using the configuration rules' Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 75 Inherited From: pentaho.module.spec.IMeta#annotations |
base: nonEmptyString |
---|
The alias or identifier of the type's base type. When This property is a synonym for |
config: object |
---|
The module's global configuration object. Modules can be further configured, conditionally, using the configuration rules' Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 90 Inherited From: pentaho.module.spec.IMeta#config |
isVirtual: boolean |
---|
Indicates if the module is virtual. A virtual module does not have a corresponding file or implementation. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 49 Inherited From: pentaho.module.spec.IMeta#isVirtual Default Value: false |
ranking: number |
---|
The ranking of the module. The ranking determines the order of the module amongst other modules. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 38 Inherited From: pentaho.module.spec.IMeta#ranking Default Value: 0 |
value: * | function |
---|
The value of the module or a function that creates it. When specified, an AMD/RequireJS module with this module's id is dynamically defined. Only considered specified when different from Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 60 Inherited From: pentaho.module.spec.IMeta#value |