IInstanceMeta

Last updated
Save as PDF

pentaho .module .spec. IInstanceMeta

The spec.IInstanceMeta interface contains the metadata of an instance module.

Source: doc-js/pentaho/module/spec/IInstanceMeta.jsdoc, line 17

Extends

pentaho.module.spec.IMeta

Members

Name	Description
alias : `nonEmptyString`	The alias of the module.
ranking : `number`	The ranking of the module.
type : `nonEmptyString`	The alias or identifier of the instance's type.
value : `any \| 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

alias: nonEmptyString

The alias of the module.

Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 30

Inherited From: pentaho.module.spec.IMeta#alias

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

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

type: `nonEmptyString`
The alias or identifier of the instance's type. Source: doc-js/pentaho/module/spec/IInstanceMeta.jsdoc, line 26 Default Value: null

type: nonEmptyString

The alias or identifier of the instance's type.

Source: doc-js/pentaho/module/spec/IInstanceMeta.jsdoc, line 26

Default Value: null

value: `any \| 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 `undefined`. When a function, whatever its return value is taken as the value of the module. When a function, it is called with the module metadata object, having its configuration already loaded. Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 49 Inherited From: pentaho.module.spec.IMeta#value

value: any | 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 undefined. When a function, whatever its return value is taken as the value of the module. When a function, it is called with the module metadata object, having its configuration already loaded.

Source: doc-js/pentaho/module/spec/IMeta.jsdoc, line 49

Inherited From: pentaho.module.spec.IMeta#value