bajaScript

Module: baja/ord/OrdTarget

Defines OrdTarget (not exposed on baja namespace).

new (require("baja/ord/OrdTarget"))( [base])

ORD Target.

This constructor shouldn't be invoked directly.

Extends:
Parameters:
Name Type Argument Description
base module:baja/ord/OrdTarget <optional>

the base ORD Target

Methods

canWrite()

Convenience to check if the underlying target Component is writable.
Returns false for all other case including if the target object is not a component.

Since:
  • Niagara 4.10
Returns:
Type
boolean

equals(obj)

Indicates whether some other object is equal to this one.

Parameters:
Name Type Description
obj Object

the reference object with which to compare.
Inherited From:
Returns:

true if this object is the same as the obj argument; false otherwise.

Type
Boolean

getComponent()

Return the Component for the ORD Target.

Returns:
Type
baja.Component

getFacets()

Since:
  • Niagara 4.10
Returns:

the correct slot facets, merged from the parent
component through to the target object. If no parent component or no
property path, returns baja.Facets.DEFAULT.

Type
baja.Facets

getObject()

Return the object associated with this OrdTarget.

This method will attempt to access any resolved value from its
Property. If the resolved value wasn't resolved from a Property then
the original resolved object is returned.

Returns:
Type
baja.Object

getOrd()

Return the ord used to resolve the target.

Since:
  • Niagara 4.10
Returns:
Type
baja.Ord

getSlotInComponent()

If the ord resolves to a slot within a component, then return the slot
of getComponent(). If not applicable, then return null.

Since:
  • Niagara 4.10
Returns:
Type
baja.Slot | null

valueOf()

Return the inner value of the object.

By default the object's instance is returned.

Inherited From:
Returns:

the inner value of the object or just the object's instance.

Type
*