Mode
pentaho.visual.role. Mode
The Mode
class describes a specific operating mode of a visual role in terms of the data type
of its value and of the type of scale
, continuous or categorical, used to encode it.
The Mode
type is an entity
type.
AMD Module
require(["pentaho/visual/role/Mode"], function(Mode) { /* code goes here */ });
Extends
Constructor
Name | Description |
---|---|
new Mode(spec) | Creates a visual role operating mode instance. |
Members
Name | Description |
---|---|
$changeset : | Gets the changeset of this instance in the ambient transaction, if any, or |
$hasChanges : | Gets a value that indicates if this instance has any changes in the ambient transaction. |
$isValid : | Determines if this value is a valid. |
$key : | Gets the key of the complex value. |
$references : | Gets the references to this container, or |
$type : | Gets the type of this instance. |
$uid : | Gets the unique identifier of the instance. |
$version : | Gets the current version of the instance. |
base : Protected | If a method has been overridden, then the base method provides access to the overridden method. |
dataType : | Gets the data type of the visual role value when operating in this mode. |
isContinuous : | Gets the type of scale, continuous or categorical, used by the associated visual role to encode values when operating in this mode. |
Methods
Name | Description |
---|---|
_compare(other) : number Protected | Compares this element to a distinct, non-equal element of the same type according to its relative order. |
_configure(config) Protected | Configures this value with a given distinct and non- |
_configureOrCreate(config) : pentaho.type.Element Protected | Configures this value with a given distinct and non- |
_configureProperty(propType, valueConfig) Protected | Configures a property with a given value specification. |
_createChangeset(transaction) : pentaho.type.changes.Changeset Protected | Creates a changeset with this container as owner and returns it. |
_emit(event) : pentaho.lang.Event Protected | Emits an unstructured event and returns it, unless it was canceled. |
_emitGeneric(source, eventArgs, type, phase, keyArgs) : boolean Protected | Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. |
_emitGenericAllAsync(source, eventArgs, type, phase, keyArgs) : Promise.< Protected | Emits an event asynchronously, given an arbitrary payload object, its type and phase, and succeeding if every listener succeeds. |
_emitSafe(event) : pentaho.lang.Event Protected | Variation of the |
_equals(other) : boolean Protected | Gets a value that indicates if a given distinct, non-null value of the same type represents the same entity. |
_hasListeners(type, phase) : boolean Protected | Determines if there are any registrations for a given event type and, optionally, phase. |
_initClone(clone) Protected | Initializes a shallow clone of this container. |
_initContainer() Protected | Initializes a container instance. |
_initProperties(spec) Protected | Initializes the properties of the complex instance from a the given specification. |
_onChangeDid(changeset) Protected | Called after a changeset has been committed. |
_onChangeRejected(changeset, reason) Protected | Called after a changeset has been rejected. |
_onChangeWill(changeset, keyArgs) : pentaho.lang.UserError Protected | Called before a changeset is committed. |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
canApplyToFieldTypes(fieldTypes) : boolean | Gets a value that indicates this operation mode is applicable to a given list of field types. |
clone() : pentaho.type.Value Abstract | Creates a shallow clone of this value. |
compare(other) : number | Compares this element to another according to its relative order. |
configure(config) | Configures this value with a given configuration. |
configureOrCreate(config) : pentaho.type.Element | Configures this value with a given configuration, if it is possible. Otherwise creates and returns a new value based on this one, but with the configuration applied. |
countOf(name, sloppy) : number | Gets the number of values of a given property. |
countRangeOf(name) : pentaho.IRange | Gets the current valid count range of values of a given property. |
domainOf(name) : Array.< | Gets the current list of valid values of a given property. |
equals(other) : boolean | Determines if a given value represents the same entity. |
equalsContent(other) : boolean | Gets a value that indicates if a given equal value has the same content as this one. |
extend(source, keyArgs) : Object | Extend an object with the properties of another. |
get(name, sloppy) : pentaho.type.Value | Nully | Gets the value of a property. |
getf(name, sloppy) : string | Gets the string representation of the value of a property. |
getv(name, sloppy) : any | pentaho.type.Complex | pentaho.type.List | Nully | Gets the primitive value of the value of a property. |
isApplicableOf(name) : boolean | Gets a value that indicates if a given property is currently applicable. |
isDefaultedOf(name) : boolean | Gets a value that indicates if a given property has assumed a default value. |
isEnabledOf(name) : boolean | Gets a value that indicates if a given property is currently enabled. |
isRequiredOf(name) : boolean | Gets a value that indicates if a given property is currently required. |
off(typeOrHandle, observer) | Removes one registration given its handle, or all registrations of a given event type (or types) and observer (or listener function). |
on(type, observer, keyArgs) : pentaho.lang.IEventRegistrationHandle | Registers an observer (or listener function) for an event(s) of a given type(s). |
set(name, valueSpec) | Sets the value of a property. |
toJSON() : JsonValue | Creates a top-level JSON specification that describes this instance. |
toSpec(keyArgs) : pentaho.type.spec.Instance | Creates a specification that describes this value. |
toSpecInContext(keyArgs) : any | Creates a specification that describes this instance. |
validate() : Array.< | Determines if this value is valid. |
Constructor Details
new Mode(spec) | ||||||
---|---|---|---|---|---|---|
Creates a visual role operating mode instance. Source: javascript/web/pentaho/visual/role/Mode.js, line 32
|
Members Details
$changeset: |
---|
Gets the changeset of this instance in the ambient transaction, if any, or Source: javascript/web/pentaho/type/mixins/Container.js, line 194 Inherited From: pentaho.type.mixins.Container#$changeset |
$hasChanges: |
---|
Gets a value that indicates if this instance has any changes in the ambient transaction. Source: javascript/web/pentaho/type/mixins/Container.js, line 204 Inherited From: pentaho.type.mixins.Container#$hasChanges |
$isValid: |
---|
Determines if this value is a valid. This attribute calls Source: javascript/web/pentaho/type/Value.js, line 168 Inherited From: pentaho.type.Value#$isValid |
$key: |
---|
Gets the key of the complex value. The default complex implementation returns the value of the Source: javascript/web/pentaho/type/Complex.js, line 188 Overrides: pentaho.type.Complex#$key |
$references: |
---|
Gets the references to this container, or Note that the returned array may be empty. Do NOT change the returned array or its elements in any way. Source: javascript/web/pentaho/type/mixins/Container.js, line 137 Inherited From: pentaho.type.mixins.Container#$references |
$type: |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/Value.js, line 334 Overrides: pentaho.type.Complex#$type |
$uid: |
---|
Gets the unique identifier of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 56 Inherited From: pentaho.type.mixins.Container#$uid |
$version: |
---|
Gets the current version of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 168 Inherited From: pentaho.type.mixins.Container#$version |
base: Protected |
---|
If a method has been overridden, then the base method provides access to the overridden method. Can also be called from within a constructor function. Source: javascript/web/pentaho/lang/Base.js, line 299 Inherited From: pentaho.lang.Base#base |
dataType: |
---|
Gets the data type of the visual role value when operating in this mode. This property is immutable and can only be specified at construction time. When unspecified, or specified as Source: javascript/web/pentaho/visual/role/Mode.js, line 140 See also: pentaho.visual.role.spec.IMode#dataType |
isContinuous: |
---|
Gets the type of scale, continuous or categorical, used by the associated visual role to encode values when operating in this mode. This property is immutable and can only be specified at construction time. Typically, the value of this property is consistent with that of When unspecified, or specified as The types Source: javascript/web/pentaho/visual/role/Mode.js, line 166 See also: pentaho.visual.role.spec.IMode#isContinuous , pentaho.type.Type#elementType , pentaho.visual.role.Mode#dataType |
Methods Details
_compare(other) : number Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Compares this element to a distinct, non-equal element of the same type according to its relative order. The default implementation does a lexicographical comparison of the elements' Source: javascript/web/pentaho/type/Element.js, line 105 Inherited From: pentaho.type.Element#_compare
See also: pentaho.type.Element#compare , pentaho.type.Value#equals |
_configure(config) Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given distinct and non- This method can only be called when there is an ambient transaction. The default implementation throws an error if this value's type is Source: javascript/web/pentaho/type/Value.js, line 264 Inherited From: pentaho.type.Value#_configure
See also: pentaho.type.Value#configure , pentaho.type.Complex#_configure , pentaho.type.List#_configure |
_configureOrCreate(config) : pentaho.type.Element Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given distinct and non- This method can only be called when there is an ambient transaction. Source: javascript/web/pentaho/type/Element.js, line 175 Inherited From: pentaho.type.Element#_configureOrCreate
See also: pentaho.type.Element#configureOrCreate , pentaho.type.Value#configure |
_configureProperty(propType, valueConfig) Protected | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Configures a property with a given value specification. Execution proceeds as follows:
If in any of the described steps, an error is thrown if a change would result to the property's value and the property is Source: javascript/web/pentaho/type/Complex.js, line 487 Inherited From: pentaho.type.Complex#_configureProperty
|
_createChangeset(transaction) : pentaho.type.changes.Changeset Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a changeset with this container as owner and returns it. Source: javascript/web/pentaho/type/mixins/Container.js, line 229 Inherited From: pentaho.type.mixins.Container#_createChangeset
|
_emit(event) : pentaho.lang.Event Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Emits an unstructured event and returns it, unless it was canceled. When this method is called, the listeners of existing registrations are notified synchronously, by priority order and then registration order, until either the event is canceled or all of the listeners have been notified. It is safe to register or unregister to/from an event type while it is being emitted. However, changes are only taken into account in subsequent emissions. If a listener function throws an error, the event processing is interrupted. No more registrations are processed and the error is passed to the caller. Source: javascript/web/pentaho/lang/EventSource.js, line 269 Inherited From: pentaho.lang.EventSource#_emit
See also: pentaho.lang.EventSource#_emitSafe , pentaho.lang.EventSource#_emitGeneric |
_emitGeneric(source, eventArgs, type, phase, keyArgs) : boolean Protected | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Emits an event given an arbitrary payload object, its type and phase. Returns the event payload object, unless the event is canceled. Source: javascript/web/pentaho/lang/EventSource.js, line 325 Inherited From: pentaho.lang.EventSource#_emitGeneric
|
_emitGenericAllAsync(source, eventArgs, type, phase, keyArgs) : Promise.< Protected | ||||||||||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Emits an event asynchronously, given an arbitrary payload object, its type and phase, and succeeding if every listener succeeds. Listeners are called in parallel. Returns a promise that is fulfilled or rejected with the event payload object. If any listener throws or rejects, the returned promise is rejected as well. Source: javascript/web/pentaho/lang/EventSource.js, line 454 Inherited From: pentaho.lang.EventSource#_emitGenericAllAsync
|
_emitSafe(event) : pentaho.lang.Event Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Variation of the If an event listener throws an error, the following event listeners are still processed. Source: javascript/web/pentaho/lang/EventSource.js, line 291 Inherited From: pentaho.lang.EventSource#_emitSafe
See also: pentaho.lang.EventSource#_emit , pentaho.lang.EventSource#_emitGeneric |
_equals(other) : boolean Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given distinct, non-null value of the same type represents the same entity. The default implementation considers two values equal if they have the equal keys. Source: javascript/web/pentaho/type/Value.js, line 135 Inherited From: pentaho.type.Value#_equals
See also: pentaho.type.Value#equals , pentaho.type.Value#$key |
_hasListeners(type, phase) : boolean Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Determines if there are any registrations for a given event type and, optionally, phase. This method can be used to avoid creating expensive event objects for an event type and, optionally, phase, that don't have registrations. Source: javascript/web/pentaho/lang/EventSource.js, line 218 Inherited From: pentaho.lang.EventSource#_hasListeners
Examples if(this._hasListeners("click")) { var event = new Event("click", this, true); if(this._emit(event)) { // ... } } if(this._hasListeners("select")) { var event = new Event("select"); if(this._emitGeneric(this, [event], "select", "will")) { // Select ... this._emitGeneric(this, [event], "select", "finally"); } } |
_initClone(clone) Protected | ||||||
---|---|---|---|---|---|---|
Initializes a shallow clone of this container. The default implementation calls Source: javascript/web/pentaho/type/mixins/Container.js, line 121 Inherited From: pentaho.type.mixins.Container#_initClone
|
_initContainer() Protected |
---|
Initializes a container instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 55 Inherited From: pentaho.type.mixins.Container#_initContainer |
_initProperties(spec) Protected | ||||||
---|---|---|---|---|---|---|
Initializes the properties of the complex instance from a the given specification. Source: javascript/web/pentaho/type/Complex.js, line 121 Inherited From: pentaho.type.Complex#_initProperties
|
_onChangeDid(changeset) Protected | ||||||
---|---|---|---|---|---|---|
Called after a changeset has been committed. The default implementation emits the "did:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/mixins/Container.js, line 300 Inherited From: pentaho.type.mixins.Container#_onChangeDid
|
_onChangeRejected(changeset, reason) Protected | |||||||||
---|---|---|---|---|---|---|---|---|---|
Called after a changeset has been rejected. The default implementation emits the "rejected:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/mixins/Container.js, line 321 Inherited From: pentaho.type.mixins.Container#_onChangeRejected
|
_onChangeWill(changeset, keyArgs) : pentaho.lang.UserError Protected | |||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Called before a changeset is committed. The default implementation emits the "will:change" event for the given changeset, if there are any listeners. When overriding, be sure to call the base implementation. Source: javascript/web/pentaho/type/mixins/Container.js, line 262 Inherited From: pentaho.type.mixins.Container#_onChangeWill
|
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 202 Inherited From: pentaho.type.Value#assertValid
|
canApplyToFieldTypes(fieldTypes) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates this operation mode is applicable to a given list of field types. Source: javascript/web/pentaho/visual/role/Mode.js, line 79
|
clone() : pentaho.type.Value Abstract | ||||
---|---|---|---|---|
Creates a shallow clone of this value. Source: javascript/web/pentaho/type/Value.js, line 93 Inherited From: pentaho.type.Value#clone
|
compare(other) : number | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Compares this element to another according to its relative order. Execution proceeds as follows:
Source: javascript/web/pentaho/type/Element.js, line 76 Inherited From: pentaho.type.Element#compare
See also: pentaho.type.Element#_compare , pentaho.type.Value#equals |
configure(config) | ||
---|---|---|
Configures this value with a given configuration. This method ensures a transaction exists and then delegates to For more information on the semantics of configuration, see Source: javascript/web/pentaho/type/Value.js, line 232 Inherited From: pentaho.type.Value#configure |
Name | Default Value | Summary |
---|---|---|
config : any | The value configuration. |
Name | Description |
---|---|
TypeError | When the value would be changed and its type is |
See also: pentaho.type.Element#configureOrCreate , pentaho.type.Complex#_configure , pentaho.type.List#_configure
configureOrCreate(config) : pentaho.type.Element | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Configures this value with a given configuration, if it is possible. Otherwise creates and returns a new value based on this one, but with the configuration applied. If the given configuration is This method considers configuration to not be possible in the following situations:
If configuration is considered possible, the actual configuration is delegated to the Source: javascript/web/pentaho/type/Element.js, line 141 Inherited From: pentaho.type.Element#configureOrCreate
|
countOf(name, sloppy) : number | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the number of values of a given property. When the specified property is a list property, its When the specified property is not a list property, Source: javascript/web/pentaho/type/Complex.js, line 528 Inherited From: pentaho.type.Complex#countOf
|
countRangeOf(name) : pentaho.IRange | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the current valid count range of values of a given property. Source: javascript/web/pentaho/type/Complex.js, line 578 Inherited From: pentaho.type.Complex#countRangeOf
|
domainOf(name) : Array.< | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the current list of valid values of a given property. Source: javascript/web/pentaho/type/Complex.js, line 611 Inherited From: pentaho.type.Complex#domainOf
|
equals(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Determines if a given value represents the same entity. This method checks if the given value is identical to this one. Otherwise, if not Source: javascript/web/pentaho/type/Value.js, line 116 Inherited From: pentaho.type.Value#equals
See also: pentaho.type.Value#_equals |
equalsContent(other) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given equal value has the same content as this one. This method must only be called if the The default implementation returns Source: javascript/web/pentaho/type/Value.js, line 152 Inherited From: pentaho.type.Value#equalsContent
See also: pentaho.type.Value#equals |
extend(source, keyArgs) : Object | |||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Extend an object with the properties of another. Methods that are overridden are accessible through This object is extended, but its class doesn't change. Source: javascript/web/pentaho/lang/Base.js, line 1037 Inherited From: pentaho.lang.Base#extend
|
get(name, sloppy) : pentaho.type.Value | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the value of a property. If the specified property is not defined and A list property always has a non-null value, possibly an empty list, but never Source: javascript/web/pentaho/type/Complex.js, line 249 Inherited From: pentaho.type.Complex#get
See also: pentaho.type.Complex#getv , pentaho.type.Complex#getf |
getf(name, sloppy) : string | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the string representation of the value of a property. This method reads the value of the property by calling When the latter returns a For a Source: javascript/web/pentaho/type/Complex.js, line 340 Inherited From: pentaho.type.Complex#getf
See also: pentaho.type.Complex#get , pentaho.type.Complex#getv |
getv(name, sloppy) : any | pentaho.type.Complex | pentaho.type.List | Nully | |||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the primitive value of the value of a property. This method reads the value of the property by calling When the latter does not return a For a Source: javascript/web/pentaho/type/Complex.js, line 311 Inherited From: pentaho.type.Complex#getv
See also: pentaho.type.Complex#get , pentaho.type.Complex#getf |
isApplicableOf(name) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property is currently applicable. Source: javascript/web/pentaho/type/Complex.js, line 548 Inherited From: pentaho.type.Complex#isApplicableOf
|
isDefaultedOf(name) : boolean | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property has assumed a default value. Source: javascript/web/pentaho/type/Complex.js, line 260 Inherited From: pentaho.type.Complex#isDefaultedOf
|
isEnabledOf(name) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property is currently enabled. Source: javascript/web/pentaho/type/Complex.js, line 563 Inherited From: pentaho.type.Complex#isEnabledOf
|
isRequiredOf(name) : boolean | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets a value that indicates if a given property is currently required. A property is currently required if its current Source: javascript/web/pentaho/type/Complex.js, line 596 Inherited From: pentaho.type.Complex#isRequiredOf
|
off(typeOrHandle, observer) | ||
---|---|---|
Removes one registration given its handle, or all registrations of a given event type (or types) and observer (or listener function). To remove an event registration, it is sufficient to call the It is safe to unregister from an event type while it is being emitted. However, any registrations removed during the current emission will still execute. Specifying an event registration handle that has already been disposed of has no effect. Specifying an event type and observer (or listener function) that have no registrations has no effect. Source: doc-js/pentaho/lang/IEventSource.jsdoc, line 131 Inherited From: pentaho.lang.EventSource#off |
Name | Default Value | Summary |
---|---|---|
typeOrHandle : nonEmptyString | Array.< | pentaho.lang.IEventRegistrationHandle | The type or types of events, or an event registration handle to dispose of. When a string, it can be a comma-separated list of event types. | |
observer : pentaho.lang.IEventObserver | pentaho.lang.EventListener | pentaho.lang.EventListenerAsync | The event observer (or listener function). Required when |
See also: pentaho.lang.IEventSource#on
on(type, observer, keyArgs) : pentaho.lang.IEventRegistrationHandle | ||||||||
---|---|---|---|---|---|---|---|---|
Registers an observer (or listener function) for an event(s) of a given type(s). Optionally, a listening priority may be specified to adjust the order by which an observer is notified, relative to other listeners. Note that if an observer is registered more than once to the same event type, a new registration is created each time and its listeners will be called once per registration. It is safe to register for an event type while it is being emitted. However, new registrations are only taken into account in subsequent emissions. When This method is compatible with the dojo/on API. Source: doc-js/pentaho/lang/IEventSource.jsdoc, line 90 Inherited From: pentaho.lang.EventSource#on |
Name | Default Value | Summary | ||||||
---|---|---|---|---|---|---|---|---|
type : nonEmptyString | Array.< | The type or types of events. When a string, it can be a comma-separated list of event types. | |||||||
observer : pentaho.lang.IEventObserver | pentaho.lang.EventListener | pentaho.lang.EventListenerAsync | The event observer (or listener function). | |||||||
keyArgs : object Optional | Keyword arguments.
|
Name | Description |
---|---|
pentaho.lang.IEventRegistrationHandle | An event registration handle that can be used for later removal. |
See also: pentaho.lang.IEventSource#off
set(name, valueSpec) | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Sets the value of a property. The value of Execution proceeds as follows:
In both cases, of element and list properties, when the given value(s) is a specification, it is first constructed, before any comparison with the current value(s) is performed. Contrast this behavior with that of the For element properties, specifications are constructed having as default type the For list properties, each element's specification is constructed having as default type the Source: javascript/web/pentaho/type/Complex.js, line 417 Inherited From: pentaho.type.Complex#set
Fires: event:will:change , event:did:change , event:rejected:change
See also: pentaho.type.Value#configure , pentaho.type.Value#isReadOnly |
toJSON() : JsonValue | ||||
---|---|---|---|---|
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 197 Inherited From: pentaho.type.Instance#toJSON
See also: pentaho.type.Instance#toSpec |
toSpec(keyArgs) : pentaho.type.spec.Instance | ||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this value. If an Source: javascript/web/pentaho/type/Value.js, line 272 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.Instance | A specification of this value. |
toSpecInContext(keyArgs) : any | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/Instance.js, line 177 Overrides: pentaho.type.Complex#toSpecInContext
See also: pentaho.type.Instance#toSpec |
validate() : Array.< | ||||
---|---|---|---|---|
Determines if this value is valid. 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 187 Inherited From: pentaho.type.Value#validate
See also: pentaho.type.Value#$isValid |