IListType
pentaho.type.spec. IListType
The spec.IListType
interface represents the specification of a list type.
Source: doc-js/pentaho/type/spec/IListType.jsdoc, line 17
Extends
Members
Name | Description |
---|---|
alias : nonEmptyString | The alias for the identifier of this type. |
application : object | The |
base : pentaho.type.spec.TypeReference | A reference to the type's base type, if any. |
category : nonEmptyString | * | The category associated with the type. |
defaultView : string | function | The default view for instances of the type. |
description : nonEmptyString | * | The description of the type. |
helpUrl : nonEmptyString | * | An URL pointing to documentation associated with the type. |
id : string | The identifier of the type's AMD module, a temporary identifier, or |
isAbstract : boolean | * | Indicates if the type is abstract. |
isAdvanced : boolean | * | Indicates if the type should be exposed only to advanced users in a user interface. |
isBrowsable : boolean | * | Indicates if the type should be exposed to users in a user interface. |
label : nonEmptyString | * | The label of the type. |
of : pentaho.type.ElementType | pentaho.type.ListType | The type of the elements that this type of list can contain. |
ordinal : number | * | The ordinal associated with the type. |
sourceId : string | The identifier of the value type's source AMD module, or |
styleClass : nonEmptyString | * | The CSS class associated with the type. |
Members Details
alias: nonEmptyString |
---|
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/IType.jsdoc, line 74 Inherited From: pentaho.type.spec.IType#alias See also: pentaho.type.spec.IType#id |
application: object |
---|
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/IType.jsdoc, line 121 Inherited From: pentaho.type.spec.IType#application See also: pentaho.type.Type#application |
base: pentaho.type.spec.TypeReference |
---|
A reference to the type's base type, if any. When the specification is used in the context of a property, it defaults to See a subtype's documentation for more information on default values. Source: doc-js/pentaho/type/spec/IType.jsdoc, line 24 Inherited From: pentaho.type.spec.IType#base |
category: nonEmptyString | * |
---|
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/IType.jsdoc, line 153 Inherited From: pentaho.type.spec.IType#category See also: pentaho.type.spec.IType#isBrowsable , pentaho.type.spec.IType#ordinal |
defaultView: string | function |
---|
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/IType.jsdoc, line 257 Inherited From: pentaho.type.spec.IType#defaultView |
description: nonEmptyString | * |
---|
The description of the type. When non- When When an empty string or Source: doc-js/pentaho/type/spec/IType.jsdoc, line 135 Inherited From: pentaho.type.spec.IType#description |
helpUrl: nonEmptyString | * |
---|
An URL pointing to documentation associated with the type. When non- When When an empty string or Source: doc-js/pentaho/type/spec/IType.jsdoc, line 175 Inherited From: pentaho.type.spec.IType#helpUrl |
id: string |
---|
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/IType.jsdoc, line 53 Inherited From: pentaho.type.spec.IType#id |
isAbstract: boolean | * |
---|
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/IType.jsdoc, line 37 Inherited From: pentaho.type.spec.IType#isAbstract Default Value: false See also: pentaho.type.spec.IType#isBrowsable |
isAdvanced: boolean | * |
---|
Indicates if the type should be exposed only to advanced users in a user interface. When non- When Source: doc-js/pentaho/type/spec/IType.jsdoc, line 208 Inherited From: pentaho.type.spec.IType#isAdvanced |
isBrowsable: boolean | * |
---|
Indicates if the type should be exposed to users in a user interface. When non- When Source: doc-js/pentaho/type/spec/IType.jsdoc, line 193 Inherited From: pentaho.type.spec.IType#isBrowsable |
label: nonEmptyString | * |
---|
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/IType.jsdoc, line 105 Inherited From: pentaho.type.spec.IType#label |
of: pentaho.type.ElementType | pentaho.type.ListType |
---|
The type of the elements that this type of list can contain. Must and can only be specified upon definition. Must be a subtype of the ancestor type's Source: doc-js/pentaho/type/spec/IListType.jsdoc, line 25 See also: pentaho.type.ListType#of |
ordinal: number | * |
---|
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/IType.jsdoc, line 240 Inherited From: pentaho.type.spec.IType#ordinal See also: pentaho.type.spec.IType#isBrowsable , pentaho.type.spec.IType#category |
sourceId: string |
---|
The identifier of the value type's source AMD module, or An empty string or When unspecified or Source: doc-js/pentaho/type/spec/IType.jsdoc, line 91 Inherited From: pentaho.type.spec.IType#sourceId |
styleClass: nonEmptyString | * |
---|
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/IType.jsdoc, line 223 Inherited From: pentaho.type.spec.IType#styleClass |