NameMap

baja. NameMap

new NameMap()

Description:

  • NameMap used for managing a list of String names to Format values.

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

Source:

Extends

Members

(static) DEFAULT :baja.NameMap

Description:

  • NameMap default instance

Source:

NameMap default 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
    require asynchronous operations to decode. For instance, some Simples may function as
    "containers" for other Simples, and may include that Type information in the string encoding.
    That Simple would then need to import those Types before it could be fully decoded in the
    browser.

    baja.Facets is a great example of this. A Facets may contain FrozenEnum values that are
    defined by Types, such as baja:Weekday. For a Facets containing a Weekday to be fully
    constructed in the browser, the baja:Weekday Type must be imported first. Since importing
    a Type may require a network call, this Facets instance might not be able to be constructed
    synchronously, using only decodeFromString(). baja.Facets has itself implemented
    decodeAsync() to import any necessary Types.

    When implementing a Type Extension for a Simple, if your Simple references arbitrary Types that
    need to be imported when decoding your Simple, implement decodeAsync() and perform any Type
    imports (or other asynchronous operations) there.

    If you are writing code that decodes Simples from strings - that is, when you have a type spec
    and string encoding, and you need to be able to decode any kind of Simple - favor the use of
    decodeAsync, as it gives the individual Simple a chance to perform async operations to ensure
    that the decoded Simple is fully correct.

    The default implementation just returns decodeFromString directly.

    Prior to Niagara 4.14, decodeAsync() was only used in field editors. In 4.14 and later,
    decodeAsync() will be used by BajaScript itself to support asynchronous decoding of Simples
    when resolving ORDs and retrieving other data from the station.

    (Note: decodeAsync() cannot be used by the framework to decode frozen slots. If you
    have a frozen slot, whose definition is a Simple that would require the use of
    decodeAsync() to construct it, it will not work. The best approach would be to implement a
    Type Extension that would use the baja! plugin to preload all the types referenced by the
    default value of that frozen slot, so that decodeFromString would have all the information
    it needed to construct it synchronously.)

Source:
Inherited From:
Example
return Promise.resolve(baja.$(simpleTypeSpec).decodeAsync(stringEncoding))
  .then((simpleInstance) => {});
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() → {baja.NameMap}

Description:

  • Decode NameMap from a String.

Source:
Overrides:
Returns:
Type
baja.NameMap

encodeToString() → {String}

Description:

  • Encode NameMap 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

get() → {baja.Format|null}

Description:

  • Return a Format from the Map or null if an entry can't be found.

Source:
Returns:

or null if an entry can't be found.

Type
baja.Format | null

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

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

isNull() → {boolean}

Source:
Since:
  • Niagara 4.15
Returns:

true if the NameMap is empty

Type
boolean

list() → {Array.<string>}

Description:

  • Return a list of all the keys in the Map.

Source:
Returns:

an array of String key names.

Type
Array.<string>

make(map) → {baja.NameMap}

Description:

  • Make a NameMap object.

Source:
Overrides:
Parameters:
Name Type Description
map Object

an object containing key/value pairs.
Returns:
Type
baja.NameMap

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

toObject() → {Object.<string, baja.Format>}

Source:
Since:
  • Niagara 4.11
Returns:

an object literal, where the keys
are the NameMap keys and the values are the corresponding formats.

Type
Object.<string, baja.Format>

toString() → {String}

Description:

  • Return a String representation of the NameMap.

Source:
Overrides:
Returns:
Type
String

valueOf() → {String}

Source:
Inherited From:
Returns:

the string encoding of the Simple, by default

Type
String

(static) make(map) → {baja.NameMap}

Description:

  • Make a NameMap object.

Source:
Parameters:
Name Type Description
map Object

an object containing key/value pairs.
Returns:
Type
baja.NameMap