Skip to main content

Pentaho+ documentation is moving!

The new product documentation portal is here. Check it out now at docs.hitachivantara.com

 

Hitachi Vantara Lumada and Pentaho Documentation

Positioned

Positioned

The visual.action.mixins.Positioned class is a mixin class for visual actions which are triggered at a specific user interface position.

The position is given by the position property.

The mixin adds spec.IPositioned to the specification of an action.

AMD Module

require(["pentaho/visual/action/mixins/Positioned"], function(Positioned) { /* code goes here */ });

Extends

Constructor

Name Description
new Positioned()
Static
Abstract

This class was not designed to be constructed directly. It was designed to be used as a mixin.

Members

Name Description
base :  function
Protected

If a method has been overridden, then the base method provides access to the overridden method.

eventName :  string

Gets the event name of the action.

position :  pentaho.visual.spec.IPoint

Gets or sets the position where the action took place, in screen coordinates.

Methods

Name Description
clone() : pentaho.action.Base

Creates a shallow clone of this action.

extend(source, keyArgs) : object

Extend an object with the properties of another.

validate() : Array.<pentaho.lang.UserError>

Determines if the given action is valid.

Constructor Details

new Positioned()
Static
Abstract

This class was not designed to be constructed directly. It was designed to be used as a mixin.

Source: javascript/web/pentaho/visual/action/mixins/Positioned.js, line 23

Members Details

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

eventName:  string

Gets the event name of the action.

The default implementation returns the value of pentaho.action.Base.id.

Source: javascript/web/pentaho/action/Base.js, line 82

Inherited From: pentaho.action.Base#eventName

position:  pentaho.visual.spec.IPoint

Gets or sets the position where the action took place, in screen coordinates.

Source: javascript/web/pentaho/visual/action/mixins/Positioned.js, line 61

Methods Details

clone() : pentaho.action.Base

Creates a shallow clone of this action.

Source: javascript/web/pentaho/action/Base.js, line 103

Inherited From: pentaho.action.Base#clone

Returns:
Name Description
pentaho.action.Base

The action clone.

extend(source, keyArgs) : object

Extend an object with the properties of another.

Methods that are overridden are accessible through this.base.

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

Parameters:
Name Default Value Summary
source : object

The instance specification.

keyArgs : object
Optional

The keyword arguments.

Parameters:
Name Default Value Summary
exclude : object
Optional

A map of property names to exclude from source.

Returns:
Name Description
object

This object.

validate() : Array.<pentaho.lang.UserError>

Determines if the given action is valid.

The default implementation does nothing and considers the instance valid. Override to implement an action's specific validation logic.

Source: javascript/web/pentaho/action/Base.js, line 94

Inherited From: pentaho.action.Base#validate

Returns:
Name Description
Array.<pentaho.lang.UserError> | null

A non-empty array of errors or null.