module:baja/ord/OrdTarget

module:baja/ord/OrdTarget

new (require("baja/ord/OrdTarget"))(baseopt)

Description:

  • ORD Target.

    This constructor shouldn't be invoked directly.

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

the base ORD Target

Extends

Methods

canWrite() → {boolean}

Description:

  • 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.

Source:
Since:
  • Niagara 4.10
Returns:
Type
boolean

equals(obj) → {Boolean}

Description:

  • Indicates whether some other object is equal to this one.

Source:
Inherited From:
Parameters:
Name Type Description
obj Object

the reference object with which to compare.
Returns:

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

Type
Boolean

getComponent() → {baja.Component}

Description:

  • Return the Component for the ORD Target.

Source:
Returns:
Type
baja.Component

getFacets() → {baja.Facets}

Source:
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() → {baja.Object}

Description:

  • 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.

Source:
Returns:
Type
baja.Object

getOrd() → {baja.Ord}

Description:

  • Return the ord used to resolve the target.

Source:
Since:
  • Niagara 4.10
Returns:
Type
baja.Ord

getSlotInComponent() → {baja.Slot|null}

Description:

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

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

valueOf() → {*}

Description:

  • Return the inner value of the object.

    By default the object's instance is returned.

Source:
Inherited From:
Returns:

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

Type
*