[]

PivotFieldBinding Class

PivotFieldBinding Class

Provides binding for PivotField class

Heirarchy

Binding
- PivotFieldBinding

Constructors

constructor

Properties

path

Methods

Constructors

constructor

new PivotFieldBinding(field: PivotField, path: string): PivotFieldBinding

Overrides Binding.constructor

Initializes a new instance of the PivotFieldBinding class.

Parameters
- field: PivotField
  
  bound PivotField.
- path: string
  
  Name of the property to bind to.
Returns PivotFieldBinding

Properties

path

path: string

Gets or sets the path for the binding.

In the simplest case, the path is the name of the property of the source object to use for the binding (e.g. 'street').

Sub-properties of a property can be specified by a syntax similar to that used in JavaScript (e.g. 'address.street').

Methods

getValue

getValue(object: any): any

Overrides Binding.getValue

Gets the binding value for a given object. Takes into consideration getValue prop of PivotField class

If the object does not contain the property specified by the binding path, the method returns null.

Parameters
- object: any
  
  The object that contains the data to be retrieved.
Returns any

setValue

setValue(object: any, value: any): boolean

Inherited from Binding.setValue

Sets the binding value on a given object.

If the object does not contain the property specified by the binding path, the value is not set.

Parameters
- object: any
  
  The object that contains the data to be set.
- value: any
  
  Data value to set.
Returns boolean

True if the value was assigned correctly, false otherwise.