Icon

baja. Icon

new Icon()

Description:

  • A BajaScript Icon.

    A BajaScript Icon may contain multiple Image references.

    For maximum efficiency, all icons in BajaScript are completely interned.

    This Constructor shouldn't be invoked directly. Please use the make()
    methods to create an instance of an Icon.

Source:

Extends

Members

(static) DEFAULT :baja.Icon

Description:

  • Default Icon instance.

Source:

Default Icon instance.

Type:

Methods

decodeAsync(str, batchopt) → {baja.Simple|Promise.<baja.Simple>}

Description:

  • The string encoding of certain Simples may include Type information, or
    other data that may be require asynchronous operations to decode. BOX is
    designed to handle these situations when decoding data from the station,
    but when user code needs to decode string-encoded Simples directly, prefer
    this method as it gives the individual Simple a chance to import Types,
    etc. to ensure that the decoded Simple is fully correct.

    The default implementation just returns decodeFromString directly.

Source:
Inherited From:
Parameters:
Name Type Attributes Description
str string
batch baja.comm.Batch <optional>

optional batch to use
Returns:

may return the Simple instance
directly, or a Promise resolving to same - so wrap in Promise.resolve()
if unsure.

Type
baja.Simple | Promise.<baja.Simple>

decodeFromString(str) → {baja.Icon}

Description:

  • Decode a String to an Icon.

Source:
Overrides:
Parameters:
Name Type Description
str String
Returns:
Type
baja.Icon

encodeToString() → {String}

Description:

  • Encode Icon to a String.

Source:
Overrides:
Returns:
Type
String

equals(obj) → {Boolean}

Description:

  • Equality test.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

equivalent(obj) → {Boolean}

Description:

  • Equivalence test.

    equivalent() is used to compare if two Objects have equivalent
    state, but might not want to return true for equals since it
    it has implied semantics for many operations. The default
    implementation returns the result of baja.Object#equals.

Source:
Inherited From:
Parameters:
Name Type Description
obj
Returns:
Type
Boolean

getAgents(isopt, batchopt) → {Promise}

Description:

  • Returns a promise that resolves to the agent list for this Object.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
is Array.<String> <optional>

An optional array of filters to add to the
agent query.
batch baja.comm.Batch <optional>

An optional object used to batch network
calls together.
Returns:

A promise that will resolve with the Agent Info.

Type
Promise

getIcon() → {baja.Icon}

Description:

  • Return the Object's Icon.

Source:
Inherited From:
Returns:
Type
baja.Icon

getImageOrds() → {Array.<baja.Ord>}

Description:

  • Return a copy of the image ORDs Array.

    Please note, this is a copy of the Image ORDs and not the URIs to access the images.

Source:
See:
Returns:

an array of ORDs to the images.

Type
Array.<baja.Ord>

getImageUris() → {Array.<String>}

Description:

  • Return an array of URIs to the images.

Source:
Returns:

an array of URI Strings to the images.

Type
Array.<String>

getType() → {Type}

Description:

  • Get the type of this instance.

Source:
Inherited From:
Returns:
Type
Type

getTypeDisplayName(cxopt) → {Promise.<string>|string}

Description:

  • Gets the friendly type display name for this object.

Source:
Since:
  • Niagara 4.10
Inherited From:
See:
  • baja.Type#getDisplayName
Parameters:
Name Type Attributes Description
cx Object <optional>

a context to be passed down to Type
Returns:

If no context is provided, the type
display name is returned synchronously as a string. If context provided,
the type display name is resolved via a promise as a string.

Type
Promise.<string> | string

make(ordsopt) → {baja.Icon}

Description:

  • Make an Icon.

Source:
Overrides:
Parameters:
Name Type Attributes Description
ords Array.<(String|baja.Ord)> | String <optional>

an array of Image ORDs or
Strings or just a single ORD or String
Returns:
Type
baja.Icon

newCopy(exactopt)

Description:

  • Every value may be cloned using the newCopy method.

    Please note that Simples are immutable so they don't
    allocate a new instance.

Source:
Inherited From:
See:
Parameters:
Name Type Attributes Description
exact Boolean <optional>

true if an exact copy of the value should be
made (only valid in the Component architecture).
Returns:

a copy of the value (or the same instance if the value is a
Simple).

toString() → {String}

Description:

  • Return a String representation of the Icon.

Source:
Overrides:
Returns:
Type
String

valueOf() → {String}

Description:

  • Return the inner value of the Icon.

Source:
Overrides:
Returns:
Type
String

(static) getStdObjectIcon() → {baja.Icon}

Description:

  • Return the standard Object Icon.

Source:
Returns:
Type
baja.Icon

(static) make(ordsopt) → {baja.Icon}

Description:

  • Make an Icon.

Source:
Parameters:
Name Type Attributes Description
ords Array.<(String|baja.Ord)> | String <optional>

an array of Image ORDs or
Strings or just a single ORD or String
Returns:
Type
baja.Icon