Model
pentaho.visual. Model
The Model
class is the required, base class of visualization models.
All registered visual filter types are pre-loaded with the model classes and can thus be safely loaded synchronously.
AMD Module
require(["pentaho/visual/Model"], function(Model) { /* code goes here */ });
See also: pentaho.visual.IView , pentaho.visual.action.Select , pentaho.visual.action.Execute , pentaho.visual.action.Update
Extends
Constructor
Name | Description |
---|---|
new Model(modelSpec) Abstract | Creates a model instance, given its specification. |
Members
Name | Description |
---|---|
$changeset : pentaho.type.action.Changeset | Gets the changeset of this instance in the ambient transaction, if any, or |
$hasChanges : boolean | Gets a value that indicates if this instance has any changes in the ambient transaction. |
$isValid : boolean | Determines if this value is a valid. |
$key : string | Gets the key of the complex value. |
$references : Array.<object> | Gets the references to this container, or |
$type : pentaho.type.ValueType | Gets the type of this instance. |
$uid : string | Gets the unique identifier of the instance. |
$version : number | Gets the current version of the instance. |
application : pentaho.visual.Application | Gets or sets the visual application object. |
base : function Protected | If a method has been overridden, then the base method provides access to the overridden method. |
data : pentaho.data.ITable | Gets or sets the data of the visualization. |
height : number | Gets or sets the height that the container application has allocated to display the visualization without horizontal or vertical scrolling, in pixels. |
isAutoUpdate : boolean | Gets a value that indicates if automatic updates are enabled. |
isDirty : boolean | Gets a value that indicates if the model is in a dirty state. |
isDirtyNew : boolean | Gets a value that indicates if the model has been changed since the last update execution started. |
isUpdating : boolean | Gets a value that indicates if an update execution is in progress. |
keyFieldNames : Array.<string> | Gets an array of the names of fields which are mapped to effective key visual roles. |
measureFieldNames : Array.<string> | Gets an array of the names of fields which are mapped to effective measure visual roles and which are not mapped to any effective key visual roles. |
selectionFilter : pentaho.data.filter.Abstract | Gets or sets the current data selection filter. |
width : number | Gets or sets the width that the container application has allocated to display the visualization without horizontal or vertical scrolling, in pixels. |
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. |
_createActionExecution(action) : pentaho.action.Execution Protected | Creates an action execution for a given action. |
_createChangeset(transaction) : pentaho.type.action.Changeset Protected | Creates a changeset with this container as target and returns it. |
_emit(event) : pentaho.lang.Event Protected | Emits an unstructured event and returns it, unless it was canceled. |
_emitActionPhaseDoEvent(actionExecution) : Promise Protected | Emits the |
_emitActionPhaseFinallyEvent(actionExecution) Protected | Emits the |
_emitActionPhaseInitEvent(actionExecution) Protected | Emits the |
_emitActionPhaseWillEvent(actionExecution) Protected | Emits the |
_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.<object> 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. |
_init(modelSpec) Protected | Called when the model is constructed. |
_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. |
_onAutoUpdate() Protected | Called when a change is made and |
_onChangeFinally(transaction) Protected | Emits the |
_onChangeInit(actionExecution, keyArgs) Protected | Emits the |
_onChangeWill(actionExecution) Protected | Emits the |
_onDataOrMappingsChanged() Protected | Called when the data property or any of the visual role properties has changed, but before notifying any |
act(action) : pentaho.action.Execution | Executes or starts execution of a given action in this target and returns the corresponding action execution instance. |
assertValid() | Ensures that the value is valid, and throws the first validation error if it is not. |
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.<pentaho.type.Element> | Gets the current list of valid values of a given property. |
equals(other) : boolean | Determines if a given value represents the same entity. |
execute(actionOrSpec) : pentaho.action.Execution | Performs an execute action, given its specification. |
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) : * | 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). |
select(actionOrSpec) : pentaho.action.Execution | Performs a select action, given its specification. |
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) : * | Creates a specification that describes this instance. |
update() : Promise | Updates the model to match the latest changes. |
Constructor Details
new Model(modelSpec) Abstract | ||||||
---|---|---|---|---|---|---|
Creates a model instance, given its specification. Source: javascript/web/pentaho/visual/Model.js, line 116
See also: pentaho.visual.IView , pentaho.visual.action.Select , pentaho.visual.action.Execute , pentaho.visual.action.Update |
Members Details
$changeset: pentaho.type.action.Changeset |
---|
Gets the changeset of this instance in the ambient transaction, if any, or Source: javascript/web/pentaho/type/mixins/Container.js, line 213 Inherited From: pentaho.type.mixins.Container#$changeset |
$hasChanges: boolean |
---|
Gets a value that indicates if this instance has any changes in the ambient transaction. Source: javascript/web/pentaho/type/mixins/Container.js, line 223 Inherited From: pentaho.type.mixins.Container#$hasChanges |
$isValid: boolean |
---|
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: string |
---|
Gets the key of the complex value. The default complex implementation returns the value of the Source: javascript/web/pentaho/type/Complex.js, line 187 Inherited From: pentaho.type.Complex#$key |
$references: Array.<object> |
---|
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 156 Inherited From: pentaho.type.mixins.Container#$references |
$type: pentaho.type.ValueType |
---|
Gets the type of this instance. Source: javascript/web/pentaho/type/Value.js, line 334 Overrides: pentaho.visual.AbstractModel#$type |
$uid: string |
---|
Gets the unique identifier of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 75 Inherited From: pentaho.type.mixins.Container#$uid |
$version: number |
---|
Gets the current version of the instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 187 Inherited From: pentaho.type.mixins.Container#$version |
application: pentaho.visual.Application |
---|
Gets or sets the visual application object. The application object represents the relevant state and interface of the application in which a model is being used. By default, this property is not included when serializing to JSON. To serialize it, specify the argument Source: javascript/web/pentaho/visual/AbstractModel.js, line 234 Inherited From: pentaho.visual.AbstractModel#application |
base: function 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 |
data: pentaho.data.ITable |
---|
Gets or sets the data of the visualization. By default, this property is not included when serializing to JSON. To serialize it, specify the argument Source: javascript/web/pentaho/visual/AbstractModel.js, line 253 Inherited From: pentaho.visual.AbstractModel#data |
height: number |
---|
Gets or sets the height that the container application has allocated to display the visualization without horizontal or vertical scrolling, in pixels. This property is required and non-browsable. Source: javascript/web/pentaho/visual/Model.js, line 627 Default Value: 300 See also: pentaho.visual.Model#width |
isAutoUpdate: boolean |
---|
Gets a value that indicates if automatic updates are enabled. When When |
isDirty: boolean |
---|
Gets a value that indicates if the model is in a dirty state. A model is considered dirty from the time it is changed to the time it is updated. This includes the entirety of the update execution. Contrast this with the During the dirty period, the model should not handle any user interaction actions, as the user could be acting on an outdated representation of it. Source: javascript/web/pentaho/visual/Model.js, line 238 See also: pentaho.visual.Model#isDirtyNew , pentaho.visual.Model#isUpdating |
isDirtyNew: boolean |
---|
Gets a value that indicates if the model has been changed since the last update execution started. A model is dirty if changes exist which were not captured by a past or ongoing update execution. This property yields the correct result even if called before the local Contrast this property with the Source: javascript/web/pentaho/visual/Model.js, line 262 See also: pentaho.visual.Model#isDirty , pentaho.visual.Model#isUpdating |
isUpdating: boolean |
---|
Gets a value that indicates if an update execution is in progress. Source: javascript/web/pentaho/visual/Model.js, line 350 See also: pentaho.visual.Model#update |
keyFieldNames: Array.<string> |
---|
Gets an array of the names of fields which are mapped to effective key visual roles. Source: javascript/web/pentaho/visual/AbstractModel.js, line 146 Inherited From: pentaho.visual.AbstractModel#keyFieldNames See also: pentaho.visual.role.AbstractPropertyType#isVisualKeyEffective |
measureFieldNames: Array.<string> |
---|
Gets an array of the names of fields which are mapped to effective measure visual roles and which are not mapped to any effective key visual roles. Source: javascript/web/pentaho/visual/AbstractModel.js, line 178 Inherited From: pentaho.visual.AbstractModel#measureFieldNames See also: pentaho.visual.role.AbstractPropertyType#isVisualKeyEffective |
selectionFilter: pentaho.data.filter.Abstract |
---|
Gets or sets the current data selection filter. This property is required. By default, this property is not included when serializing to JSON. To serialize it, specify the argument When set to a filter specification, ATTENTION: The current implementation only supports filters that can be converted to Source: javascript/web/pentaho/visual/AbstractModel.js, line 289 Inherited From: pentaho.visual.AbstractModel#selectionFilter |
width: number |
---|
Gets or sets the width that the container application has allocated to display the visualization without horizontal or vertical scrolling, in pixels. This property is required and non-browsable. Source: javascript/web/pentaho/visual/Model.js, line 607 Default Value: 300 See also: pentaho.visual.Model#height |
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 483 Inherited From: pentaho.type.Complex#_configureProperty
|
_createActionExecution(action) : pentaho.action.Execution Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates an action execution for a given action. Source: javascript/web/pentaho/action/impl/Target.js, line 196 Overrides: pentaho.action.impl.Target#_createActionExecution
See also: pentaho.action.ITarget#act |
_createChangeset(transaction) : pentaho.type.action.Changeset Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a changeset with this container as target and returns it. Source: javascript/web/pentaho/type/mixins/Container.js, line 248 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 Overrides: pentaho.action.impl.Target#_emit
See also: pentaho.lang.EventSource#_emitSafe , pentaho.lang.EventSource#_emitGeneric |
_emitActionPhaseDoEvent(actionExecution) : Promise Protected | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Emits the The default implementation delegates to Source: javascript/web/pentaho/action/impl/Target.js, line 254 Inherited From: pentaho.action.impl.Target#_emitActionPhaseDoEvent
|
_emitActionPhaseFinallyEvent(actionExecution) Protected | ||||||
---|---|---|---|---|---|---|
Emits the The default implementation delegates to Source: javascript/web/pentaho/action/impl/Target.js, line 279 Inherited From: pentaho.action.impl.Target#_emitActionPhaseFinallyEvent
|
_emitActionPhaseInitEvent(actionExecution) Protected | ||||||
---|---|---|---|---|---|---|
Emits the The default implementation delegates to Source: javascript/web/pentaho/action/impl/Target.js, line 212 Inherited From: pentaho.action.impl.Target#_emitActionPhaseInitEvent
|
_emitActionPhaseWillEvent(actionExecution) Protected | ||||||
---|---|---|---|---|---|---|
Emits the The default implementation delegates to Source: javascript/web/pentaho/action/impl/Target.js, line 230 Inherited From: pentaho.action.impl.Target#_emitActionPhaseWillEvent
|
_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 Overrides: pentaho.action.impl.Target#_emitGeneric
|
_emitGenericAllAsync(source, eventArgs, type, phase, keyArgs) : Promise.<object> 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 Overrides: pentaho.action.impl.Target#_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 Overrides: pentaho.action.impl.Target#_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 Overrides: pentaho.action.impl.Target#_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"); } } |
_init(modelSpec) Protected | ||||||
---|---|---|---|---|---|---|
Called when the model is constructed. Override this method, from a subclass or configuration mixin class, to perform the initialization of a model instance. In principle, you should call the base implementation before settings any properties in Source: javascript/web/pentaho/visual/Model.js, line 160
|
_initClone(clone) Protected | ||||||
---|---|---|---|---|---|---|
Initializes a shallow clone of this container. The default implementation calls Source: javascript/web/pentaho/type/mixins/Container.js, line 140 Inherited From: pentaho.type.mixins.Container#_initClone
|
_initContainer() Protected |
---|
Initializes a container instance. Source: javascript/web/pentaho/type/mixins/Container.js, line 74 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 120 Inherited From: pentaho.type.Complex#_initProperties
|
_onAutoUpdate() Protected |
---|
Called when a change is made and The default implementation calls the Source: javascript/web/pentaho/visual/Model.js, line 329 See also: pentaho.visual.Model#_onChangeFinally |
_onChangeFinally(transaction) Protected | ||||||
---|---|---|---|---|---|---|
Emits the The default implementation proceeds like:
Source: javascript/web/pentaho/visual/Model.js, line 302 Overrides: pentaho.visual.AbstractModel#_onChangeFinally
|
_onChangeInit(actionExecution, keyArgs) Protected | |||||||||
---|---|---|---|---|---|---|---|---|---|
Emits the The default implementation delegates to Source: javascript/web/pentaho/type/mixins/Container.js, line 274 Inherited From: pentaho.type.mixins.Container#_onChangeInit
|
_onChangeWill(actionExecution) Protected | ||||||
---|---|---|---|---|---|---|
Emits the The default implementation delegates to Source: javascript/web/pentaho/type/mixins/Container.js, line 297 Inherited From: pentaho.type.mixins.Container#_onChangeWill
|
_onDataOrMappingsChanged() Protected |
---|
Called when the data property or any of the visual role properties has changed, but before notifying any The default implementation calls the Source: javascript/web/pentaho/visual/AbstractModel.js, line 132 Inherited From: pentaho.visual.AbstractModel#_onDataOrMappingsChanged |
act(action) : pentaho.action.Execution | ||
---|---|---|
Executes or starts execution of a given action in this target and returns the corresponding action execution instance. This method can be given Source: doc-js/pentaho/action/ITarget.jsdoc, line 37 Inherited From: pentaho.action.impl.Target#act |
Name | Default Value | Summary |
---|---|---|
action : pentaho.action.Base | pentaho.action.spec.IBase | The action or action specification to execute. |
Name | Description |
---|---|
pentaho.action.Execution | The resulting action execution. |
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
|
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 : * | 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 524 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 574 Inherited From: pentaho.type.Complex#countRangeOf
|
domainOf(name) : Array.<pentaho.type.Element> | ||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
Gets the current list of valid values of a given property. Source: javascript/web/pentaho/type/Complex.js, line 607 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 |
execute(actionOrSpec) : pentaho.action.Execution | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Performs an execute action, given its specification. An execute action can only be performed if the model is not Source: javascript/web/pentaho/visual/Model.js, line 597
See also: pentaho.visual.action.Execute |
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 1040 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 248 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 339 Inherited From: pentaho.type.Complex#getf
See also: pentaho.type.Complex#get , pentaho.type.Complex#getv |
getv(name, sloppy) : * | 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 310 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 544 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 259 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 559 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 592 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 Overrides: pentaho.action.impl.Target#off |
Name | Default Value | Summary |
---|---|---|
typeOrHandle : nonEmptyString | Array.<nonEmptyString> | 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 Overrides: pentaho.action.impl.Target#on |
Name | Default Value | Summary | ||||||
---|---|---|---|---|---|---|---|---|
type : nonEmptyString | Array.<nonEmptyString> | 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
select(actionOrSpec) : pentaho.action.Execution | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Performs a select action, given its specification. A select action can only be performed if the model is not Source: javascript/web/pentaho/visual/Model.js, line 580
See also: pentaho.visual.action.Select |
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 413 Inherited From: pentaho.type.Complex#set
See also: pentaho.type.Value#configure , pentaho.type.Value#isReadOnly , pentaho.action.Execution |
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 198 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 | null | A specification of this value. |
toSpecInContext(keyArgs) : * | ||||||||||
---|---|---|---|---|---|---|---|---|---|---|
Creates a specification that describes this instance. Source: javascript/web/pentaho/type/Instance.js, line 178 Inherited From: pentaho.type.Instance#toSpecInContext
See also: pentaho.type.Instance#toSpec |
update() : Promise | ||||
---|---|---|---|---|
Updates the model to match the latest changes. Models are created in a However, when The update action is asynchronous. This is true even if all listeners handle the update synchronously. Action completion is only ever advertised asynchronously, through the emission of the action execution's When this method is called, the model may be in four different states, depending on the current values of the properties
The Listeners of the Some well-known causes for an update action to be rejected are standardized and included in the Source: javascript/web/pentaho/visual/Model.js, line 410 Fires: event:pentaho/visual/action/Update:{init} , event:pentaho/visual/action/Update:{will} , event:pentaho/visual/action/Update:{do} , event:pentaho/visual/action/Update:{finally}
See also: pentaho.visual.action.Update , pentaho.visual.action.UpdateExecution , pentaho.visual.Model#isAutoUpdate , pentaho.visual.Model#isDirtyNew , pentaho.visual.Model#isDirty , pentaho.visual.Model#isUpdating , pentaho.visual.action.WellKnownErrorNames |