IPropertyTypeProto
pentaho.type.spec. IPropertyTypeProto
The spec.IPropertyTypeProto
interface represents the information used to define a property of a complex
type.
It is used as part of the pentaho.type.spec.IComplexTypeProto
specification.
Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 17
Extends
Members
Name | Description |
---|---|
alias : | The alias for the identifier of this type. |
application : | The |
base : | A reference to the property type's base type, if any. |
category : | The category associated with the type. |
countMax : | The maximum number of elements that properties of this type can have. |
countMin : | The minimum number of elements that properties of this type must have. |
defaultValue : | The default value of properties of this 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 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. |
isApplicable : | Indicates if properties of this type are applicable. |
isBrowsable : | Indicates if the type should be exposed to users in a user interface. |
isEnabled : | Indicates if properties of this type can be changed by a user in a user interface. |
isRequired : | Indicates if properties of this type are required. |
label : | The label of the property type. |
name : | The name of the property type. |
nameAlias : | The alias for the name of the property 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. |
valueType : | The type of value that properties of this type can hold. |
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 property type's base type, if any. The property type's base type can only be specified on a root property of a complex type, in which case it defaults to For non-root property types, their base property type is that with the same name in the base type of the declaring type. Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 29 Overrides: 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 |
countMax: |
---|
The maximum number of elements that properties of this type can have. Note that this attribute is taken together with the This attribute is DynamicA dynamic attribute accepts a function that is evaluated to a different value for each complex instance. When the value is not a function, it applies to every instance. This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type having a This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. Other characteristicsWhen a The default (root) Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 330 See also: pentaho.type.spec.IPropertyTypeProto#countMin , pentaho.type.Property.Type#countMax |
countMin: |
---|
The minimum number of elements that properties of this type must have. Note that this attribute is taken together with the This attribute is DynamicA dynamic attribute accepts a function that is evaluated to a different value for each complex instance. When the value is not a function, it applies to every instance. This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type having a This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. Other characteristicsWhen a The default (root) Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 288 See also: pentaho.type.spec.IPropertyTypeProto#countMax , pentaho.type.Property.Type#countMin |
defaultValue: |
---|
The default value of properties of this type. The default value is the "prototype" value that properties of this type take, on complex instances, when the property is unspecified or specified as a The value The control value
Else, the value must be either a function or a valid specification for a value of the property type's current (local or inherited) When this is a Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 134 See also: pentaho.type.Property.Type#defaultValue |
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 instance classes. Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 53 Inherited From: pentaho.type.spec.ITypeProto#instance See also: pentaho.type.spec.IInstanceProto#$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 |
isApplicable: |
---|
Indicates if properties of this type are applicable. When a property is not (currently) applicable, then it does not apply; it does not make sense in a certain situation. It may only be applicable when another property of the complex type has a specific value, for example. When a property is not currently applicable, its value is not significant and, as such, any validations concerning it are not performed. This attribute is DynamicA dynamic attribute accepts a function that is evaluated to a different value for each complex instance. When the value is not a function, it applies to every instance. This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type marked as applicable can later be marked as not applicable. However, a property type marked as not applicable can no longer go back to being applicable. This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. Other characteristicsWhen a The default (root) Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 210 See also: pentaho.type.spec.IPropertyTypeProto#isRequired , pentaho.type.Property.Type#isApplicable |
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 |
isEnabled: |
---|
Indicates if properties of this type can be changed by a user in a user interface. A property should be marked disabled whenever its value is implied/imposed somehow, and thus cannot not be changed, directly, by the user in a user interface. This attribute is DynamicA dynamic attribute accepts a function that is evaluated to a different value for each complex instance. When the value is not a function, it applies to every instance. This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type marked as enabled can later be marked as not enabled. However, a property type marked as not enabled can no longer go back to being enabled. This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. Other characteristicsWhen a The default (root) Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 251 See also: pentaho.type.Property.Type#isEnabled |
isRequired: |
---|
Indicates if properties of this type are required. When a property is of a required property type, it is considered invalid if its value (in a complex instance) is Note that this attribute is taken together with the This attribute is DynamicA dynamic attribute accepts a function that is evaluated to a different value for each complex instance. When the value is not a function, it applies to every instance. This attribute is MonotonicThe value of a monotonic attribute can change, but only in some, predetermined monotonic direction. In this case, a property type marked as not required can later be marked as required. However, a property type marked as required can no longer go back to being not required. This attribute is InheritedWhen there is no local value, the effective value of the attribute is the inherited effective value. Other characteristicsWhen a The default (root) Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 164 See also: pentaho.type.spec.IPropertyTypeProto#valueType , pentaho.type.spec.IPropertyTypeProto#countMin , pentaho.type.Property.Type#isRequired , pentaho.type.Property.Type#countRangeOn |
label: |
---|
The label of the property type. When non- When an empty string or The default label of a root property type is a capitalization of its Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 88 Overrides: pentaho.type.spec.ITypeProto#label |
name: |
---|
The name of the property type. The name of a property type identifies it within its When it is a non- When the specified name is the name of an inherited property, this property specification overrides the inherited property. When the specified name is the name of an existing local property, this property specification configures the existing property. Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 46 See also: pentaho.type.Property.Type#name |
nameAlias: |
---|
The alias for the name of the property type. The alias of a property type is an alternative name for serialization purposes. SetThis attribute can only be set when defining a new property type, and cannot be changed afterwards. When set to a non- Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 68 See also: pentaho.type.Property.Type#nameAlias |
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 |
valueType: |
---|
The type of value that properties of this type can hold. If the value type is a When unspecified and When unspecified and Cannot be a When specified, the value is a The resolved value type must be a Source: doc-js/pentaho/type/spec/IPropertyTypeProto.jsdoc, line 105 See also: pentaho.type.Property.Type#valueType |