IRefinementTypeProto

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 null.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 84

Inherited From: pentaho.type.spec.ITypeProto#alias

See also:  pentaho.type.spec.ITypeProto#id

The application property of the type.

The application property serves as a bag of properties specific to the container application, that can be modified via the Configuration Service.

Nully values will be ignored by the application property.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 131

Inherited From: pentaho.type.spec.ITypeProto#application

See also:  pentaho.type.Type#application

A reference to the type's base type, if any.

When the specification is used in the context of property, it defaults to "property". Otherwise, when absent or undefined, it defaults to "complex".

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

The category associated with the type.

The category is used primarily to group similar types (or instances of) in a user interface.

When non-Nully and not a string, it is taken instead to be the result of calling its toString method.

When undefined, the category is inherited from the base type.

When an empty string or null, the category is forced to be null, ignoring any inherited value.

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

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 sourceId.

When undefined, the view is inherited from the base type, if any. The root view is null.

When falsy (like if null or an empty string), the value is forced to be null, ignoring any inherited value.

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

The description of the type.

When non-Nully and not a string, it is taken instead to be the result of calling its toString method.

When undefined, the description is inherited from the base type.

When an empty string or null, the description is forced to be null, ignoring any inherited value.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 145

Inherited From: pentaho.type.spec.ITypeProto#description

The refinement facet identifiers or classes.

The specified facet identifiers are added to the refinement type, adding to any already present.

The attributes defined by the added refinement facets become available for extension/configuration on the refinement type.

Source: doc-js/pentaho/type/spec/IRefinementTypeProto.jsdoc, line 25

See also:  pentaho.type.Refinement.Type#facets

An URL pointing to documentation associated with the type.

When non-Nully and not a string, it is taken instead to be the result of calling its toString method.

When undefined, the help url is inherited from the base type.

When an empty string or null, the help url is forced to be null, ignoring any inherited value.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 185

Inherited From: pentaho.type.spec.ITypeProto#helpUrl

The identifier of the type's AMD module, a temporary identifier, or null.

An empty string or undefined value is interpreted as null.

For serialization purposes, a temporary identifier can be assigned to an anonymous type. An identifier is temporary if it starts with idTemporaryPrefix.

Temporary identifiers are ignored upon type construction.

When unspecified or null, it defaults to sourceId.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 63

Inherited From: pentaho.type.spec.ITypeProto#id

See also:  pentaho.type.SpecificationContext.isIdTemporary

The extensible/configurable members of the prototype of value instance classes.

Source: doc-js/pentaho/type/spec/IValueTypeProto.jsdoc, line 25

Inherited From: pentaho.type.spec.IValueTypeProto#instance

See also:  pentaho.type.spec.IValueProto#type

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 Boolean function.

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

Indicates if the type should be exposed only to advanced users in a user interface.

When non-Nully and not a boolean, it is taken instead to be the result of passing it to the Boolean function.

When Nully, the attribute value is inherited from the base type, if any. The root value is false.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 218

Inherited From: pentaho.type.spec.ITypeProto#isAdvanced

Indicates if the type should be exposed to users in a user interface.

When non-Nully and not a boolean, it is taken instead to be the result of passing it to the Boolean function.

When Nully, the attribute value is inherited from the base type, if any. The root value is true.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 203

Inherited From: pentaho.type.spec.ITypeProto#isBrowsable

The label of the type.

When non-Nully and not a string, it is taken instead to be the result of calling its toString method.

When an empty string or Nully, the label is inherited from the base type.

The initial value of this attribute, on the top-root type, is "instance".

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 115

Inherited From: pentaho.type.spec.ITypeProto#label

The representation type refined by this refinement type.

Must and can only be specified at a top-refinement type, upon definition.

Source: doc-js/pentaho/type/spec/IRefinementTypeProto.jsdoc, line 41

See also:  pentaho.type.Refinement.Type#of

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 Nully, the ordinal is inherited from the base type, if any. The root value is 0.

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

The identifier of the value type's source AMD module, or null.

An empty string or undefined value is interpreted as null.

When unspecified or null, it defaults to id.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 101

Inherited From: pentaho.type.spec.ITypeProto#sourceId

See also:  pentaho.type.SpecificationContext.isIdTemporary

The CSS class associated with the type.

This attribute is typically used to associate an icon with a type.

When null or an empty string, the attribute value is set to null.

When unspecified, or undefined, the attribute value defaults to the type's id, in snake-case, if it has one; or, null, if not.

Source: doc-js/pentaho/type/spec/ITypeProto.jsdoc, line 233

Inherited From: pentaho.type.spec.ITypeProto#styleClass

Determines if a value of the type is valid.

Although not limited to, this method is used mostly for refinement types, to perform additional validations on values, besides that which is performed by their type's instance-side validate method.

If you override this method, be sure to call the base implementation, and return any errors it reports.

Source: doc-js/pentaho/type/spec/IValueTypeProto.jsdoc, line 35

Inherited From: pentaho.type.spec.IValueTypeProto#validateInstance

See also:  pentaho.type.Value.Type#validateInstance