Interface PresentableAttributes

Feature attributes that have been formatted for display.

interface PresentableAttributes {
    _originalMap: ObservableMap<string, string>;
    [toStringTag]: "ObservableMap";
    get size(): number;
    [iterator](): MapIterator<[string, string]>;
    clear(): void;
    delete(key: string): boolean;
    emit(type: string, event?: unknown): boolean;
    entries(): MapIterator<[string, string]>;
    forEach(callbackfn: ((value: string, key: string, map: Map<string, string>) => void), thisArg?: unknown): void;
    get(key: string): string;
    has(key: string): boolean;
    keys(): MapIterator<string>;
    on(name: "change", callback: ((event: MapChangeEvent<string, string>) => void)): IHandle;
    on(name: "after-add", callback: ((event: AfterItemChangeEvent<ObservableMap<string, string>, [string, string]>) => void)): IHandle;
    on(name: "after-remove", callback: ((event: AfterItemChangeEvent<ObservableMap<string, string>, [string, string]>) => void)): IHandle;
    on(name: string, callback: EventHandler): IHandle;
    set(key: string, value: string): this;
    toJSON(): unknown;
    values(): MapIterator<string>;
}

Hierarchy (view full)

Properties

_originalMap [toStringTag]

Accessors

size

Methods

[iterator] clear delete emit entries forEach get has keys on set toJSON values

Properties

Protected Readonly_originalMap

_originalMap: ObservableMap<string, string>

The underlying map that this object is delegating to.

Readonly[toStringTag]

[toStringTag] = "ObservableMap"

Used by Object.toString().

Accessors

size

  • get size(): number

  • The number of elements.

    Returns number

Methods

[iterator]

  • [iterator](): MapIterator<[string, string]>

  • Returns the [key, value] pairs for each element in the map in insertion order.

    Returns MapIterator<[string, string]>

clear

delete

  • delete(key): boolean

  • Removes the specified element.

    Parameters

    • key: string

      The element's key.

    Returns boolean

    True if an element was deleted, otherwise false.

emit

  • emit(type, event?): boolean

  • Emits an event on the instance.

    Parameters

    • type: string

      The name of the event.

    • Optionalevent: unknown

      The event payload.

      Read more...

    Returns boolean

entries

  • entries(): MapIterator<[string, string]>

  • Returns the [key, value] pairs for each element in the map in insertion order.

    Returns MapIterator<[string, string]>

forEach

  • forEach(callbackfn, thisArg?): void

  • Executes a provided function once per each key/value pair in the map.

    Parameters

    • callbackfn: ((value: string, key: string, map: Map<string, string>) => void)

      Function to execute for each element.

        • (value, key, map): void

        • Parameters

          • value: string
          • key: string
          • map: Map<string, string>

          Returns void

    • OptionalthisArg: unknown

      Value to use as this when executing callback.

    Returns void

get

  • get(key): string

  • Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

    Parameters

    • key: string

    Returns string

    Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.

has

  • has(key): boolean

  • Indicates whether or not an element with the specified key exists.

    Parameters

    • key: string

      The key to test for.

    Returns boolean

keys

  • keys(): MapIterator<string>

  • Returns the keys for each element in the map in insertion order.

    Returns MapIterator<string>

on

set

  • set(key, value): this

  • Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.

    Parameters

    • key: string
    • value: string

    Returns this

toJSON

  • toJSON(): unknown

  • Returns a serializable representation of the map.

    Returns unknown

values

  • values(): MapIterator<string>

  • Returns the values for each element in the map in insertion order.

    Returns MapIterator<string>

Settings

Member Visibility

On This Page

Properties
Accessors
Methods