IValueTypeProto
pentaho.type.spec. IValueTypeProto
The spec.IValueTypeProto
interface represents the specification of a value type.
Source: doc-js/pentaho/type/spec/IValueTypeProto.jsdoc, line 17
Extends
Members
Name | Description |
---|---|
alias : | The alias for the identifier of this type. |
application : | The |
base : | A reference to the type's base type, if any. |
category : | The category associated with the type. |
defaultView : | The default view for instances of the type. |
description : | The description of the type. |
helpUrl : | An URL pointing to documentation associated with the type. |
id : | The identifier of the type's AMD module, a temporary identifier, or |
instance : | The extensible/configurable members of the prototype of value instance classes. |
isAbstract : | Indicates if the type is abstract. |
isAdvanced : | Indicates if the type should be exposed only to advanced users in a user interface. |
isBrowsable : | Indicates if the type should be exposed to users in a user interface. |
label : | The label of the type. |
ordinal : | The ordinal associated with the type. |
sourceId : | The identifier of the value type's source AMD module, or |
styleClass : | The CSS class associated with the type. |
Members Details
alias: |
---|
The alias for the identifier of this type. The alias of a type can only be specified when extending the ancestor type. This attribute is not inherited. When unspecified, defaults to Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 84 Inherited From: pentaho.type.spec.ITypeProto#alias See also: pentaho.type.spec.ITypeProto#id |
application: |
---|
The The application property serves as a bag of properties specific to the container application, that can be modified via the
Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 131 Inherited From: pentaho.type.spec.ITypeProto#application See also: pentaho.type.Type#application |
base: |
---|
A reference to the type's base type, if any. When the specification is used in the context of property, it defaults to See a subtype's documentation for more information on default values. Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 24 Inherited From: pentaho.type.spec.ITypeProto#base |
category: |
---|
The category associated with the type. The category is used primarily to group similar types (or instances of) in a user interface. When non- When When an empty string or Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 163 Inherited From: pentaho.type.spec.ITypeProto#category See also: pentaho.type.spec.ITypeProto#isBrowsable , pentaho.type.spec.ITypeProto#ordinal |
defaultView: |
---|
The default view for instances of the type. When a string, it is the identifier of the view's AMD module. If the identifier is relative, it is relative to When When falsy (like if When a function, it is the class or factory of the view. Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 267 Inherited From: pentaho.type.spec.ITypeProto#defaultView |
description: |
---|
The description of the type. When non- When When an empty string or Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 145 Inherited From: pentaho.type.spec.ITypeProto#description |
helpUrl: |
---|
An URL pointing to documentation associated with the type. When non- When When an empty string or Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 185 Inherited From: pentaho.type.spec.ITypeProto#helpUrl |
id: |
---|
The identifier of the type's AMD module, a temporary identifier, or An empty string or For serialization purposes, a temporary identifier can be assigned to an anonymous type. An identifier is temporary if it starts with Temporary identifiers are ignored upon type construction. When unspecified or Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 63 Inherited From: pentaho.type.spec.ITypeProto#id |
instance: |
---|
The extensible/configurable members of the prototype of value instance classes. Source: doc-js/pentaho/type/spec/IValueTypeProto.jsdoc, line 25 Overrides: pentaho.type.spec.ITypeProto#instance See also: pentaho.type.spec.IValueProto#$type |
isAbstract: |
---|
Indicates if the type is abstract. An abstract type cannot be used directly to create an instance and, as such, it is not usually exposed to users in a user interface. When not a boolean, it is taken instead to be the result of passing it to the Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 37 Inherited From: pentaho.type.spec.ITypeProto#isAbstract Default Value: false See also: pentaho.type.spec.ITypeProto#isBrowsable |
isAdvanced: |
---|
Indicates if the type should be exposed only to advanced users in a user interface. When non- When Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 218 Inherited From: pentaho.type.spec.ITypeProto#isAdvanced |
isBrowsable: |
---|
Indicates if the type should be exposed to users in a user interface. When non- When Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 203 Inherited From: pentaho.type.spec.ITypeProto#isBrowsable |
label: |
---|
The label of the type. When non- When an empty string or The initial value of this attribute, on the top-root type, is Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 115 Inherited From: pentaho.type.spec.ITypeProto#label |
ordinal: |
---|
The ordinal associated with the type. The ordinal is used to disambiguate the order with which a type (or an instance of it) is shown in a user interface. When Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 250 Inherited From: pentaho.type.spec.ITypeProto#ordinal See also: pentaho.type.spec.ITypeProto#isBrowsable , pentaho.type.spec.ITypeProto#category |
sourceId: |
---|
The identifier of the value type's source AMD module, or An empty string or When unspecified or Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 101 Inherited From: pentaho.type.spec.ITypeProto#sourceId |
styleClass: |
---|
The CSS class associated with the type. This attribute is typically used to associate an icon with a type. When When unspecified, or Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 233 Inherited From: pentaho.type.spec.ITypeProto#styleClass |