Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SNavigableMapSubMap<V>

A view of a navigable map.

Type parameters

  • V

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected __mem__

__mem__: SNavigableMapSubMapMemory<V, SNavigableMapSubMap<V>>

Methods

ceilingEntry

  • ceilingEntry(key: string): SMapEntry<V> | null

ceilingKey

  • ceilingKey(key: string): string | null

clear

  • clear(): this

connector

containsKey

  • containsKey(key: string): boolean

containsValue

  • containsValue(value: unknown, comparator?: Comparator, thisArg?: unknown): boolean

descendingMap

each

  • each(iteratee: Iteratee<string, V | null, this>, thisArg?: unknown, reverse?: boolean): this

  • Iterates over elements of this map, calling the iteratee for each element. The iteratee is bound to the thisArg and invoked with three arguments: value, key and this map. The iteratee may exit iteration early by explicitly returning false.

    Parameters

    • iteratee: Iteratee<string, V | null, this>

      the function called per iteration

    • Default value thisArg: unknown = this

      the this binding of the iteratee

    • Default value reverse: boolean = false

    Returns this

    this

filter

  • filter(iteratee: Iteratee<string, V | null, this>, thisArg?: unknown): this

  • Iterates elements of this map, calling the iteratee for each element, removing all elements the iteratee does not return true. The iteratee is bound to the thisArg and invoked with three arguments: value, key and this map.

    throws

    Error if this is read-only

    Parameters

    • iteratee: Iteratee<string, V | null, this>

      the function called per iteration

    • Default value thisArg: unknown = this

      the this binding of the iteratee

    Returns this

    this

find

  • find(predicate: Iteratee<string, V | null, this>, thisArg?: unknown, reverse?: boolean): unknown

  • Returns the first field value which the specified predicate returns true, or null if there is no such field. The predicate is bound to the thisArg and invoked with three arguments: field value, field name and this map.

    Parameters

    • predicate: Iteratee<string, V | null, this>

      the function called per iteration

    • Default value thisArg: unknown = this

      the this binding of the predicate

    • Default value reverse: boolean = false

    Returns unknown

    the first field value which the specified predicate returns true, or null if there is no such field.

firstEntry

firstKey

  • firstKey(): string

floorEntry

  • floorEntry(key: string): SMapEntry<V> | null

floorKey

  • floorKey(key: string): string | null

fromJson

  • fromJson(json: unknown): this

get

  • get(key: string): V | null

headMap

  • Returns a view of the portion of this map whose keys are lower than (or equal to, if inclusive is true) the specified key toKey.

    throws

    Error toKey lies outside the bounds of this view

    Parameters

    • toKey: string

      high endpoint of the keys in the view

    • Default value inclusive: boolean = false

      true if the specified key toKey is to be included in the view

    Returns SNavigableMapSubMap<V>

    a view of the specified portion of this map

higherEntry

  • higherEntry(key: string): SMapEntry<V> | null

higherKey

  • higherKey(key: string): string | null

isEmpty

  • isEmpty(): boolean

isInitialized

  • isInitialized(): boolean

isLocked

  • isLocked(): boolean

isNonNull

  • isNonNull(): boolean

isReadOnly

  • isReadOnly(): boolean

lastEntry

lastKey

  • lastKey(): string

lock

  • lock(): void

lowerEntry

  • lowerEntry(key: string): SMapEntry<V> | null

lowerKey

  • lowerKey(key: string): string | null

off

  • off(types: string, handler?: Function): this
  • off(target: unknown, types: string, handler?: Function): this

  • Unregister the event handlers of the specified events.

    off( "success" );

// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );

// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );

// Multiple event types
off( "success fail" );

    Parameters

    • types: string

      space-separated event types

    • Optional handler: Function

      the event handler to be unregistered

    Returns this

    this

  • Unregister the event handlers of the specified events.

    off( "success" );

// Unregister all the handlers of the events with the namespace `sample`.
off( ".sample" );

// Unregister all the handlers of the `success` event with the namespace `sample`.
off( "success.sample" );

// Multiple event types
off( "success fail" );

    Parameters

    • target: unknown

      event target

    • types: string

      space-separated event types

    • Optional handler: Function

      the event handler to be unregistered

    Returns this

    this

offoff

offon

on

  • on(types: string, handler: Function): this
  • on(target: unknown, types: string, handler: Function): this

  • Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.

    on( "success", function(){} );

// `success` event with a namespace `sample`
on( "success.sample", function(){} );

// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
on( "success fail", function(){} );

// Event target
on( eventTarget, "success", function(){} );

    Parameters

    • types: string

      space-separated event types

    • handler: Function

      the event handler to be registered

    Returns this

    this

  • Registers the specified event handler for the specified events. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.

    on( "success", function(){} );

// `success` event with a namespace `sample`
on( "success.sample", function(){} );

// Multiple namespaces
on( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
on( "success fail", function(){} );

// Event target
on( eventTarget, "success", function(){} );

    Parameters

    • target: unknown

      event target or event types

    • types: string

      space-separated event types

    • handler: Function

      the event handler to be registered

    Returns this

    this

one

  • one(types: string, handler: Function): this
  • one(target: unknown, types: string, handler: Function): this

  • Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.

    one( "success", function(){} );

// `success` event with a namespace `sample`
one( "success.sample", function(){} );

// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
one( "success fail", function(){} );

    Parameters

    • types: string

      space-separated event types

    • handler: Function

      The event handler to be registered

    Returns this

    this

  • Registers the specified event handler for the specified events. The specified event handler is invoked at most once. When the handler is invoked, the this keyword is a reference to the this class. This method supports space-separated event types and namespces.

    one( "success", function(){} );

// `success` event with a namespace `sample`
one( "success.sample", function(){} );

// Multiple namespaces
one( "success.ns1.ns2.ns3", function(){} );

// Multiple event types
one( "success fail", function(){} );

    Parameters

    • target: unknown

      event target

    • types: string

      space-separated event types

    • handler: Function

      The event handler to be registered

    Returns this

    this

onoff

  • Registers the event handler for the unregistration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are unregistered. The latter boolean gets true if this is the last handler of the event identified by Connection.type.

    onoff("eventname", function( connection, isLast ){
    // DO SOMETHING HERE
});

    Parameters

    • types: string

      space-separated event names

    • handler: OnoffHandler

      an event handler

    Returns this

    this

onon

  • Registers the event handler for the registration events of the specified events. The handler is invoked with Connection and a boolean when the event handlers of the specified events are registered. The latter boolean gets true if this is the first handler of the event identified by Connection.type.

    onon("eventname", function( connection, isFirst ){
    if( some-condition ) {
        connection.trigger( this, null, [ first-event-parameter, second-event-parameter, ... ] );
    }
});

    Parameters

    • types: string

      space-separated event types

    • handler: OnonHandler

      an event handler

    Returns this

    this

put

  • put(key: string, value: V | null): V | null

  • Associates the specified value with the specified key. If this map contained the specified key previously, the old value is replaced by the specified value.

    throws

    Error if this is read-only

    throws

    Error if the specified key is null

    throws

    Error if the specified value is null and this does not support a null value

    throws

    Error the specified key lies outside the bounds of this view

    Parameters

    • key: string

      the key with which the specified value is to be associated

    • value: V | null

    Returns V | null

    the old value or null if this map did not contain the specified key previously

putAll

  • Copies all the mappings of the specified mapping to this map.

    throws

    Error if this is read-only

    throws

    Error if the specified mappings is null

    throws

    Error if the specified mappings contains a null value and this does not support a null value

    throws

    Error the specified key lies outside the bounds of this view

    Parameters

    • mappings: PlainObject<V | null>

      mappings to be stored in this map

    Returns this

    this

remove

  • remove(key: string): V | null

reput

  • reput(key: string): V | null

  • Reassociates the value of the specified key.

    throws

    Error if this is read-only

    throws

    Error if the specified key is null

    throws

    Error the specified key lies outside the bounds of this view

    Parameters

    • key: string

      the key which is to be reassociated

    Returns V | null

    the value of the specified key or null if this map did not contain the specified key previously

retrigger

  • retrigger(originalEvent: OriginalEvent, types: string, parameters?: unknown[]): unknown[]
  • retrigger(target: Node | null, originalEvent: OriginalEvent, types: string, parameters?: unknown[]): unknown[]

  • Invokes all the handlers of the specified event.

    retrigger( originalEvent, "success" );

// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );

// Namespaced event type
retrigger( originalEvent, "success.sample" );

// Multiple event types
retrigger( originalEvent, "success fail" );

    Parameters

    • originalEvent: OriginalEvent

      the event object

    • types: string

      space-separated event types

    • Optional parameters: unknown[]

    Returns unknown[]

    the returned values of the invoked handlers

  • Invokes all the handlers of the specified event.

    retrigger( originalEvent, "success" );

// With two parameters true and 156
retrigger( originalEvent, "success", [true, 156] );

// Namespaced event type
retrigger( originalEvent, "success.sample" );

// Multiple event types
retrigger( originalEvent, "success fail" );

    Parameters

    • target: Node | null

      event target

    • originalEvent: OriginalEvent

      the event object

    • types: string

      space-separated event types

    • Optional parameters: unknown[]

      event parameters

    Returns unknown[]

    the returned values of the invoked handlers

size

  • size(): number

subMap

  • Returns a view of the portion of this map whose keys range from fromKey to toKey.

    throws

    Error if fromKey is higher than toKey

    throws

    Error fromKey or toKey lies outside the bounds of this view

    Parameters

    • fromKey: string

      low endpoint of the keys in the view

    • toKey: string

      high endpoint of the keys in the view

    Returns SNavigableMapSubMap<V>

    a view of the specified portion of this map

  • Returns a view of the portion of this map whose keys range from fromKey to toKey.

    throws

    Error if fromKey is higher than toKey

    throws

    Error fromKey or toKey lies outside the bounds of this view

    Parameters

    • fromKey: string

      low endpoint of the keys in the view

    • includeFrom: boolean

      true if the low endpoint is to be included in the view

    • toKey: string

      high endpoint of the keys in the view

    • includeTo: boolean

      true if the high endpoint is to be included in the view

    Returns SNavigableMapSubMap<V>

    a view of the specified portion of this map

tailMap

  • Returns a view of the portion of this map whose keys are higher than (or equal to, if inclusive is true) the specified key fromKey.

    throws

    Error fromKey lies outside the bounds of this view

    Parameters

    • fromKey: string

      low endpoint of the keys in the view

    • Default value inclusive: boolean = true

      true if the specified key fromKey is to be included in the view

    Returns SNavigableMapSubMap<V>

    a view of the specified portion of this map

toJson

toObject

toString

  • toString(): string

trigger

  • trigger(types: string, parameters?: unknown[]): unknown[]
  • trigger(target: Node | null, types: string, parameters?: unknown[]): unknown[]

  • Invokes all the handlers of the specified event.

    trigger( "success" );

// With two parameters true and 156
trigger( "success", [true, 156] );

// Namespaced event type
trigger( "success.sample" );

// Multiple event types
trigger( "success fail" );

    Parameters

    • types: string

      space-separated event types

    • Optional parameters: unknown[]

      event parameters

    Returns unknown[]

    the returned values of the invoked handlers

  • Invokes all the handlers of the specified event.

    trigger( "success" );

// With two parameters true and 156
trigger( "success", [true, 156] );

// Namespaced event type
trigger( "success.sample" );

// Multiple event types
trigger( "success fail" );

    Parameters

    • target: Node | null

      Event target

    • types: string

      space-separated event types

    • Optional parameters: unknown[]

      event parameters

    Returns unknown[]

    the returned values of the invoked handlers

triggerDirect

  • triggerDirect(name: string, type: string[] | null, args: unknown[] | null, results: null): null
  • triggerDirect(name: string, type: string[] | null, args: unknown[] | null, results: unknown[]): unknown[]

unlock

  • unlock(): void

values

  • values(): Array<V | null>

Static extend

Generated using TypeDoc