Hierarchy

Constructors

Properties

$el: any
$slider: any
attributes: Record<string, any>
cid: string
className?: string
collection: Collection<any>
displayed: Promise<WidgetView>

A promise that resolves to the parent view when a child view is displayed.

el: HTMLElement
id?: string
label: HTMLLabelElement
layoutPromise: Promise<any>
luminoWidget: Widget
model: WidgetModel
options: any
readout: HTMLDivElement
slider_container: HTMLDivElement
stylePromise: Promise<any>
tagName: string

Accessors

  • get pWidget(): Widget
  • Deprecated

    Use luminoWidget instead (Since 8.0).

    Returns Widget

Methods

  • Parameters

    • selector: string

    Returns JQuery<HTMLElement>

  • Parameters

    • tagName: string

    Returns void

  • Parameters

    • attrs: ObjectHash

    Returns void

  • Parameters

    • el: HTMLElement

    Returns void

  • Create msg callbacks for a comm msg.

    Returns ICallbacks

  • Create and promise that resolves to a child view of a given model

    Type Parameters

    • VT extends DOMWidgetView<VT> = DOMWidgetView

    Parameters

    • child_model: DOMWidgetModel
    • Optional options: any

    Returns Promise<VT>

  • Type Parameters

    • VT extends WidgetView<VT> = WidgetView

    Parameters

    • child_model: WidgetModel
    • Optional options: any

    Returns Promise<VT>

  • Events hash or a method returning the events hash that maps events/selectors to methods on your View. For assigning events as object hash, do it like this: this.events = { "event:selector": callback, ... }; That works only if you set it in the constructor or the initialize method.

    Returns {
        [e: string]: string;
    }

    • [e: string]: string
  • Handle message sent to the front end.

    Used to focus or blur the widget.

    Parameters

    • content: any

    Returns void

  • Public constructor

    Parameters

    • parameters: IInitializeParameters<WidgetModel>

    Returns void

  • For use with views as ES classes. If you define a preinitialize method, it will be invoked when the view is first created, before any instantiation logic is run.

    See

    https://backbonejs.org/#View-preinitialize

    Parameters

    • Optional options: ViewOptions<WidgetModel, HTMLElement>

    Returns void

  • Send a custom msg associated with this view.

    Parameters

    • content: {}
      • Optional buffers: ArrayBuffer[] | ArrayBufferView[]

      Returns void

    • Parameters

      • layout: LayoutModel
      • Optional oldLayout: LayoutModel

      Returns void

    • Parameters

      • style: StyleModel
      • Optional oldStyle: StyleModel

      Returns void

    • Parameters

      • class_map: Dict<string[]>
      • trait_name: string
      • Optional el: HTMLElement

      Returns void

    • Update the contents of this view

      Called when the model is changed. The model may have been changed by another view or by a state update from the back-end.

      Parameters

      • Optional options: {
            updated_view?: WidgetView;
        }
        • Optional updated_view?: WidgetView

      Returns void

    • Update the DOM classes applied to an element, default to this.el.

      Parameters

      • old_classes: string[]
      • new_classes: string[]
      • Optional el: HTMLElement

      Returns void

    • Update the DOM classes applied to the widget based on a single trait's value.

      Given a trait value classes map, this function automatically handles applying the appropriate classes to the widget element and removing classes that are no longer valid.

      Parameters

      class_map: dictionary Dictionary of trait values to class lists. Example: { success: ['alert', 'alert-success'], info: ['alert', 'alert-info'], warning: ['alert', 'alert-warning'], danger: ['alert', 'alert-danger'] }; trait_name: string Name of the trait to check the value of. el: optional DOM element handle, defaults to this.el Element that the classes are applied to.

      Parameters

      • class_map: Dict<string[]>
      • trait_name: string
      • Optional el: HTMLElement

      Returns void

    • Do not use, prefer TypeScript's extend functionality.

      Parameters

      • properties: any
      • Optional classProperties: any

      Returns any

    Generated using TypeDoc