Class LabelOverlay<E>

An overlay that draws some text. By default this overlay will use an HTML element, and that element's parent will be the surface canvas. You can set useHTMLElement:false in the options if you want the overlay to use an SVG element instead - this is a choice you might make if you had a UI that you wanted to export to SVG.

Type Parameters

  • E = any

Hierarchy (view full)

Methods

bind fire getListener isSuspendEvents setSuspendEvents silently unbind

Methods

bind

  • bind<T>(event, listener, insertAtStart?): EventGenerator

  • Bind an event listener. This method can be used with a type parameter by call sites; although it's not necessary it can be helpful to use this to ensure you've thought about what the payload to your event handler is going to be.

    Type Parameters

    • T = any

    Parameters

    • event: string

      Name of the event(s) to bind to.

    • listener: ((a: T, e?: any) => any)

      Function to bind to the given event(s)

        • (a, e?): any

        • Parameters

          • a: T
          • Optionale: any

          Returns any

    • OptionalinsertAtStart: boolean

      Whether or not to insert this listener at the head of the listener queue. Defaults to false.

    Returns EventGenerator

fire

  • fire<T>(event, value?, originalEvent?): any

  • Fire the named event.

    Type Parameters

    • T

    Parameters

    • event: string

      Event to fire

    • Optionalvalue: T

      Value to pass to event handlers

    • OptionaloriginalEvent: Event

      Optional original event that caused this event to be fired.

    Returns any

getListener

  • getListener(forEvent): any[]

  • Gets all listeners for the given named event.

    Parameters

    • forEvent: string

    Returns any[]

isSuspendEvents

  • isSuspendEvents(): boolean

  • Returns whether not event firing is currently suspended

    Returns boolean

setSuspendEvents

  • setSuspendEvents(val): void

  • Sets whether not event firing is currently suspended

    Parameters

    • val: boolean

    Returns void

silently

  • silently(fn): void

  • Run the given function without firing any events.

    Parameters

    • fn: Function

    Returns void

unbind

  • unbind(eventOrListener?, listener?): EventGenerator

  • Unbind the given event listener, or all listeners. If you call this method with no arguments then all event listeners are unbound.

    Parameters

    • OptionaleventOrListener: string | Function

      Either an event name, or an event handler function

    • Optionallistener: Function

      If eventOrListener is defined, this is the event handler to unbind.

    Returns EventGenerator

Settings

Member Visibility

On This Page

Methods
Version :