Sign up (with export icon)

AnnotationCollection

Api-class icon class

A collection of annotations.

It implements methods for managing annotations and creates a focus tracker for them to make it easier to manage the focus for all annotations.

AnnotationCollection fires event-focus when an annotation becomes focused and event-blur when all annotations lose focus.

Properties

  • Chevron-right icon

    first : null | T
    readonlyinherited

    Returns the first item from the collection or null when collection is empty.

  • Chevron-right icon

    isFocused : boolean
    readonly

    Equals to true when one of the annotation in the collection is focused.

  • Chevron-right icon

    last : null | T
    readonlyinherited

    Returns the last item from the collection or null when collection is empty.

  • Chevron-right icon

    length : number
    readonlyinherited

    The number of items available in the collection.

Methods

  • Chevron-right icon

    constructor( annotations )

    Parameters

    annotations : Iterable<Annotation>

    Initial annotations.

    Defaults to []

  • Chevron-right icon

    Symbol.iterator() → Iterator<Annotation>
    inherited

    Iterable interface.

    Returns

    Iterator<Annotation>
  • Chevron-right icon

    add( annotation ) → this

    Adds an annotation to the collection.

    Parameters

    annotation : Annotation

    Returns

    this
  • Chevron-right icon

    addMany( items, [ index ] ) → this
    inherited

    Adds multiple items into the collection.

    Any item not containing an id will get an automatically generated one.

    Parameters

    items : Iterable<Annotation>
    [ index ] : number

    The position of the insertion. Items will be appended if no index is specified.

    Returns

    this

    Fires

  • Chevron-right icon

    bindTo( externalCollection ) → CollectionBindToChain<S, Annotation>
    inherited

    Binds and synchronizes the collection with another one.

    The binding can be a simple factory:

    class FactoryClass {
    	public label: string;
    
    	constructor( data: { label: string } ) {
    		this.label = data.label;
    	}
    }
    
    const source = new Collection<{ label: string }>( { idProperty: 'label' } );
    const target = new Collection<FactoryClass>();
    
    target.bindTo( source ).as( FactoryClass );
    
    source.add( { label: 'foo' } );
    source.add( { label: 'bar' } );
    
    console.log( target.length ); // 2
    console.log( target.get( 1 ).label ); // 'bar'
    
    source.remove( 0 );
    console.log( target.length ); // 1
    console.log( target.get( 0 ).label ); // 'bar'
    
    Copy code

    or the factory driven by a custom callback:

    class FooClass {
    	public label: string;
    
    	constructor( data: { label: string } ) {
    		this.label = data.label;
    	}
    }
    
    class BarClass {
    	public label: string;
    
    	constructor( data: { label: string } ) {
    		this.label = data.label;
    	}
    }
    
    const source = new Collection<{ label: string }>( { idProperty: 'label' } );
    const target = new Collection<FooClass | BarClass>();
    
    target.bindTo( source ).using( ( item ) => {
    	if ( item.label == 'foo' ) {
    		return new FooClass( item );
    	} else {
    		return new BarClass( item );
    	}
    } );
    
    source.add( { label: 'foo' } );
    source.add( { label: 'bar' } );
    
    console.log( target.length ); // 2
    console.log( target.get( 0 ) instanceof FooClass ); // true
    console.log( target.get( 1 ) instanceof BarClass ); // true
    
    Copy code

    or the factory out of property name:

    const source = new Collection<{ nested: { value: string } }>();
    const target = new Collection<{ value: string }>();
    
    target.bindTo( source ).using( 'nested' );
    
    source.add( { nested: { value: 'foo' } } );
    source.add( { nested: { value: 'bar' } } );
    
    console.log( target.length ); // 2
    console.log( target.get( 0 ).value ); // 'foo'
    console.log( target.get( 1 ).value ); // 'bar'
    
    Copy code

    It's possible to skip specified items by returning null value:

    const source = new Collection<{ hidden: boolean }>();
    const target = new Collection<{ hidden: boolean }>();
    
    target.bindTo( source ).using( item => {
    	if ( item.hidden ) {
    		return null;
    	}
    
    	return item;
    } );
    
    source.add( { hidden: true } );
    source.add( { hidden: false } );
    
    console.log( source.length ); // 2
    console.log( target.length ); // 1
    
    Copy code

    Note: clear can be used to break the binding.

    Type parameters

    S : extends Record<string, any>

    The type of externalCollection element.

    Parameters

    externalCollection : Collection<S>

    A collection to be bound.

    Returns

    CollectionBindToChain<S, Annotation>

    The binding chain object.

  • Chevron-right icon

    clear() → void
    inherited

    Removes all items from the collection and destroys the binding created using bindTo.

    Returns

    void

    Fires

  • Chevron-right icon

    delegate( events ) → EmitterMixinDelegateChain
    inherited

    Delegates selected events to another Emitter. For instance:

    emitterA.delegate( 'eventX' ).to( emitterB );
    emitterA.delegate( 'eventX', 'eventY' ).to( emitterC );
    
    Copy code

    then eventX is delegated (fired by) emitterB and emitterC along with data:

    emitterA.fire( 'eventX', data );
    
    Copy code

    and eventY is delegated (fired by) emitterC along with data:

    emitterA.fire( 'eventY', data );
    
    Copy code

    Parameters

    events : Array<string>

    Event names that will be delegated to another emitter.

    Returns

    EmitterMixinDelegateChain
  • Chevron-right icon

    destroy() → void

    Destroys all bindings and clears the collection.

    Returns

    void
  • Chevron-right icon

    filter( callback, [ ctx ] ) → Array<Annotation>
    inherited

    Returns an array with items for which the callback returned a true value.

    Parameters

    callback : ( item: Annotation, index: number ) => boolean
    [ ctx ] : any

    Context in which the callback will be called.

    Returns

    Array<Annotation>

    The array with matching items.

  • Chevron-right icon

    find( callback, [ ctx ] ) → undefined | Annotation
    inherited

    Finds the first item in the collection for which the callback returns a true value.

    Parameters

    callback : ( item: Annotation, index: number ) => boolean
    [ ctx ] : any

    Context in which the callback will be called.

    Returns

    undefined | Annotation

    The item for which callback returned a true value.

  • Chevron-right icon

    fire( eventOrInfo, args ) → GetEventInfo<TEvent>[ 'return' ]
    inherited

    Fires an event, executing all callbacks registered for it.

    The first parameter passed to callbacks is an EventInfo object, followed by the optional args provided in the fire() method call.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    eventOrInfo : GetNameOrEventInfo<TEvent>

    The name of the event or EventInfo object if event is delegated.

    args : TEvent[ 'args' ]

    Additional arguments to be passed to the callbacks.

    Returns

    GetEventInfo<TEvent>[ 'return' ]

    By default the method returns undefined. However, the return value can be changed by listeners through modification of the evt.return's property (the event info is the first param of every callback).

  • Chevron-right icon

    forEach( callback, [ ctx ] ) → void
    inherited

    Performs the specified action for each item in the collection.

    Parameters

    callback : ( item: Annotation, index: number ) => unknown
    [ ctx ] : any

    Context in which the callback will be called.

    Returns

    void
  • Chevron-right icon

    get( idOrIndex ) → null | Annotation
    inherited

    Gets an item by its ID or index.

    Parameters

    idOrIndex : string | number

    The item ID or index in the collection.

    Returns

    null | Annotation

    The requested item or null if such item does not exist.

  • Chevron-right icon

    getByInnerView( innerView ) → undefined | Annotation

    Gets the annotation for a given annotation view's inner view.

    Parameters

    innerView : View

    Returns

    undefined | Annotation
  • Chevron-right icon

    getByView( view ) → undefined | Annotation

    Gets the annotation for a given annotation view.

    Parameters

    view : View

    Returns

    undefined | Annotation
  • Chevron-right icon

    getIndex( itemOrId ) → number
    inherited

    Gets an index of an item in the collection. When an item is not defined in the collection, the index will equal -1.

    Parameters

    itemOrId : string | Annotation

    The item or its ID in the collection.

    Returns

    number

    The index of a given item.

  • Chevron-right icon

    has( itemOrId ) → boolean
    inherited

    Returns a Boolean indicating whether the collection contains an item.

    Parameters

    itemOrId : string | Annotation

    The item or its ID in the collection.

    Returns

    boolean

    true if the collection contains the item, false otherwise.

  • Chevron-right icon

    listenTo( emitter, event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed when an event is fired in a specific (emitter) object.

    Events can be grouped in namespaces using :. When namespaced event is fired, it additionally fires all callbacks for that namespace.

    // myEmitter.on( ... ) is a shorthand for myEmitter.listenTo( myEmitter, ... ).
    myEmitter.on( 'myGroup', genericCallback );
    myEmitter.on( 'myGroup:myEvent', specificCallback );
    
    // genericCallback is fired.
    myEmitter.fire( 'myGroup' );
    // both genericCallback and specificCallback are fired.
    myEmitter.fire( 'myGroup:myEvent' );
    // genericCallback is fired even though there are no callbacks for "foo".
    myEmitter.fire( 'myGroup:foo' );
    
    Copy code

    An event callback can stop the event and set the return value of the fire method.

    Type parameters

    TEvent : extends BaseEvent

    The type describing the event. See BaseEvent.

    Parameters

    emitter : Emitter

    The object that fires the event.

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void
  • Chevron-right icon

    map( callback, [ ctx ] ) → Array<U>
    inherited

    Executes the callback for each item in the collection and composes an array or values returned by this callback.

    Type parameters

    U

    The result type of the callback.

    Parameters

    callback : ( item: Annotation, index: number ) => U
    [ ctx ] : any

    Context in which the callback will be called.

    Returns

    Array<U>

    The result of mapping.

  • Chevron-right icon

    off( event, callback ) → void
    inherited

    Stops executing the callback on the given event. Shorthand for this.stopListening( this, event, callback ).

    Parameters

    event : string

    The name of the event.

    callback : Function

    The function to stop being called.

    Returns

    void
  • Chevron-right icon

    on( event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed when an event is fired.

    Shorthand for this.listenTo( this, event, callback, options ) (it makes the emitter listen on itself).

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void
  • Chevron-right icon

    once( event, callback, [ options ] ) → void
    inherited

    Registers a callback function to be executed on the next time the event is fired only. This is similar to calling on followed by off in the callback.

    Type parameters

    TEvent : extends BaseEvent

    The type descibing the event. See BaseEvent.

    Parameters

    event : TEvent[ 'name' ]

    The name of the event.

    callback : GetCallback<TEvent>

    The function to be called on event.

    [ options ] : GetCallbackOptions<TEvent>

    Additional options.

    Returns

    void
  • Chevron-right icon

    refreshPositioning() → void

    Refreshes the positioning of all annotations and sorts them topmost and leftmost.

    Returns

    void
  • Chevron-right icon

    remove( annotation ) → Annotation

    Removes the annotation from the collection.

    Parameters

    annotation : Annotation

    Returns

    Annotation
  • Chevron-right icon

    stopDelegating( [ event ], [ emitter ] ) → void
    inherited

    Stops delegating events. It can be used at different levels:

    • To stop delegating all events.
    • To stop delegating a specific event to all emitters.
    • To stop delegating a specific event to a specific emitter.

    Parameters

    [ event ] : string

    The name of the event to stop delegating. If omitted, stops it all delegations.

    [ emitter ] : Emitter

    (requires event) The object to stop delegating a particular event to. If omitted, stops delegation of event to all emitters.

    Returns

    void
  • Chevron-right icon

    stopListening( [ emitter ], [ event ], [ callback ] ) → void
    inherited

    Stops listening for events. It can be used at different levels:

    • To stop listening to a specific callback.
    • To stop listening to a specific event.
    • To stop listening to all events fired by a specific object.
    • To stop listening to all events fired by all objects.

    Parameters

    [ emitter ] : Emitter

    The object to stop listening to. If omitted, stops it for all objects.

    [ event ] : string

    (Requires the emitter) The name of the event to stop listening to. If omitted, stops it for all events from emitter.

    [ callback ] : Function

    (Requires the event) The function to be removed from the call list for the given event.

    Returns

    void

Events

  • Chevron-right icon

    add( eventInfo, item, index )
    inherited

    Fired when an item is added to the collection.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    item : T

    The added item.

    index : number

    An index where the addition occurred.

  • Chevron-right icon

    blur( eventInfo )

    Fired when all annotations become blurred.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

  • Chevron-right icon

    change( eventInfo, data )
    inherited

    Fired when the collection was changed due to adding or removing items.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    data : CollectionChangeEventData<T>

    Changed items.

  • Chevron-right icon

    focus( eventInfo, annotation )

    Fired when an annotation becomes active.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    annotation : Annotation

    An annotation that was focused.

  • Chevron-right icon

    remove( eventInfo, item, index )
    inherited

    Fired when an item is removed from the collection.

    Parameters

    eventInfo : EventInfo

    An object containing information about the fired event.

    item : T

    The removed item.

    index : number

    Index from which item was removed.