Object
pentaho.type.Object
The class that represents primitive, JavaScript object
values.
AMD Module
require(["pentaho/type/object"], function(Object) { /* code goes here */ });
Extends
Constructor
Name | Description |
---|---|
new Object() | Creates an object instance. |
Members
Name | Description |
---|---|
configure | Configures this simple value with a given configuration. |
formatted : | Gets or sets the formatted value of the property. |
isValid : | Determines if this value is a valid instance of its type. |
key : | Gets the unique key of the native object. |
type : | Gets the type of this instance. |
value : | Gets the underlying object value of the value. |
Methods
Name | Description |
---|---|
_configure(config) Protected | Configures this value with a given non-nully configuration. |
_toJSONValue(keyArgs) : UJsonValue Protected | Converts the |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
clone() : pentaho.type.Simple | Creates a clone of the simple value. |
equals(other) : boolean | Determines if a given value, of the same type, represents the same entity. |
equalsContent(other) : boolean | Determines if a given value, of the same type, represents the same entity with the same content. |
toJSON() : UJsonValue | Creates a top-level JSON specification that describes this instance. |
toSpec(keyArgs) : pentaho.type.spec.UInstance | Creates a specification that describes this value. |
toSpecInContext(keyArgs) : any | Creates a specification that describes this instance. |
toString() : String | Returns a string that represents the current simple value. |
validate() : Array.< | Determines if this value is a valid instance of its type. |
valueOf() : * | Gets the underlying primitive value of the simple value. |
Constructor Details
new Object() |
---|
Creates an object instance. |
Members Details
configure: |
---|
Configures this simple value with a given configuration. Source: javascript/web/pentaho/type/simple.js, line 222 Inherited From: pentaho.type.Simple#configure |
formatted: |
---|
Gets or sets the formatted value of the property. Source: javascript/web/pentaho/type/simple.js, line 142 Inherited From: pentaho.type.Simple#formatted |
isValid: |
---|
Determines if this value is a valid instance of its type. This attribute calls Source: javascript/web/pentaho/type/value.js, line 137 Inherited From: pentaho.type.Value#isValid |
key: |
---|
Gets the unique key of the native object. The key of a value identifies it among its peers. Source: javascript/web/pentaho/type/object.js, line 75 Overrides: pentaho.type.Simple#key |
type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/value.js, line 262 Overrides: pentaho.type.Simple#type |
value: |
---|
Gets the underlying object value of the value. Source: javascript/web/pentaho/type/object.js, line 79 Overrides: pentaho.type.Simple#value |
Methods Details
_configure(config) Protected | ||||||
---|---|---|---|---|---|---|
Configures this value with a given non-nully configuration. The default implementation does nothing. Source: javascript/web/pentaho/type/simple.js, line 243 Inherited From: pentaho.type.Simple#_configure
|
_toJSONValue(keyArgs) : UJsonValue Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Converts the The default implementation returns Source: javascript/web/pentaho/type/simple.js, line 352 Inherited From: pentaho.type.Simple#_toJSONValue
|
assertValid() | ||||
---|---|---|---|---|
Ensures that the value is valid, and throws the first validation error if it is not. This method calls the Source: javascript/web/pentaho/type/value.js, line 168 Inherited From: pentaho.type.Value#assertValid
|
clone() : pentaho.type.Simple | ||||
---|---|---|---|---|
Creates a clone of the simple value. Source: javascript/web/pentaho/type/simple.js, line 90 Inherited From: pentaho.type.Simple#clone
|
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value, of the same type, represents the same entity. The given value must be of the same concrete type (or the result is undefined). To test equality for any two arbitrary values, in a robust way, use If two values are equal, they must have an equal The default implementation returns Source: javascript/web/pentaho/type/value.js, line 122 Inherited From: pentaho.type.Value#equals
|
equalsContent(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value, of the same type, represents the same entity with the same content. The given value must be of the same concrete type (or the result is undefined). If two values are equal, they must have an equal Source: javascript/web/pentaho/type/simple.js, line 214 Inherited From: pentaho.type.Simple#equalsContent
|
toJSON() : UJsonValue | ||||
---|---|---|---|---|
Creates a top-level JSON specification that describes this instance. Attributes which do not have a JSON-compatible specification are omitted. Specifically, for inline types, attributes with a function value are not supported. This method simply calls Source: javascript/web/pentaho/type/instance.js, line 206 Inherited From: pentaho.type.Instance#toJSON
See also: pentaho.type.Instance#toSpec |
toSpec(keyArgs) : pentaho.type.spec.UInstance | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this value. If an Source: javascript/web/pentaho/type/value.js, line 200 Inherited From: pentaho.type.Value#toSpec |
Name | Default Value | Summary | ||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
keyArgs : Object Optional | The keyword arguments object. Passed to every value and type serialized within this scope. Please see the documentation of value subclasses for information on additional, supported keyword arguments.
|
Name | Description |
---|---|
pentaho.type.spec.UInstance | A specification of this value. |
toSpecInContext(keyArgs) : any | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/instance.js, line 186 Inherited From: pentaho.type.Instance#toSpecInContext
See also: pentaho.type.Instance#toSpec |
toString() : String | ||||
---|---|---|---|---|
Returns a string that represents the current simple value. Source: javascript/web/pentaho/type/simple.js, line 175 Inherited From: pentaho.type.Simple#toString
|
validate() : Array.< | ||||
---|---|---|---|---|
Determines if this value is a valid instance of its type. The default implementation does nothing and considers the instance valid. Override to implement a type's specific validation logic. You can use the error utilities in Source: javascript/web/pentaho/type/value.js, line 154 Inherited From: pentaho.type.Value#validate
See also: pentaho.type.Value#isValid |
valueOf() : * | ||||
---|---|---|---|---|
Gets the underlying primitive value of the simple value. Source: javascript/web/pentaho/type/simple.js, line 166 Inherited From: pentaho.type.Simple#valueOf
|