Class Langevitour

Class to create and animate a Langevin Tour widget

Emits a "changeFilter" event when a label checkbox is checked/unchecked.

Emits a "changeSelection" event when brushing occurs.

Hierarchy

  • EventTarget
    • Langevitour

Constructors

  • Create a Langevin Tour widget.

    Parameters

    • container: HTMLElement

      Element to insert widget into.

    • width: number

      Desired initial width of widget.

    • height: number

      Desired initial height of widget.

    Returns Langevitour

Methods

  • Appends an event listener for events whose type attribute value is type. The callback argument sets the callback that will be invoked when the event is dispatched.

    The options argument sets listener-specific options. For compatibility this can be a boolean, in which case the method behaves exactly as if the value was specified as options's capture.

    When set to true, options's capture prevents callback from being invoked when the event's eventPhase attribute value is BUBBLING_PHASE. When false (or not present), callback will not be invoked when event's eventPhase attribute value is CAPTURING_PHASE. Either way, callback will be invoked if event's eventPhase attribute value is AT_TARGET.

    When set to true, options's passive indicates that the callback will not cancel the event by invoking preventDefault(). This is used to enable performance optimizations described in ยง 2.8 Observing event listeners.

    When set to true, options's once indicates that the callback will only be invoked once after which the event listener will be removed.

    If an AbortSignal is passed for options's signal, then the event listener will be removed when signal is aborted.

    The event listener is appended to target's event listener list and is not appended if it has the same type, callback, and capture.

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | AddEventListenerOptions

    Returns void

  • Dispatches a synthetic event event to target and returns true if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise.

    Parameters

    • event: Event

    Returns boolean

  • Removes the event listener in target's event listener list with the same type, callback, and options.

    Parameters

    • type: string
    • callback: null | EventListenerOrEventListenerObject
    • Optional options: boolean | EventListenerOptions

    Returns void

  • Show data in the widget. Use "null" to clear the widget.

    data.X A row-major matrix, where each row represents a point and each column represents a variable.

    data.colnames A name for each column in X.

    data.group Group number for each point. Integer values starting from 0.

    data.levels Group names for each group in data.group.

    [data.scale] Scale for each column.

    [data.center] Center for each column.

    [data.rownames] A name for each point.

    [data.extraAxes] A matrix with each column defining a projection of interest.

    [data.extraAxesNames] A name for each extra axis.

    [data.lineFrom] Rows of X to draw lines from.

    [data.lineTo] Rows of X to draw lines to.

    [data.lineColors] Color for each line.

    [data.axisColors] CSS colors for each variable and then optionally for each extra axis.

    [data.levelColors] CSS colors for each level.

    [data.colorVariation] Amount of brightness variation of points, between 0 and 1.

    [data.pointSize] Radius of points in pixels either, a number or an array of numbers for each point.

    [data.state] State to be passed on to setState().

    Parameters

    • data: null | { X: number[][]; axisColors?: string[]; center?: number[]; colnames: string[]; colorVariation?: number; extraAxes?: number[][]; extraAxesNames?: string[]; group: number[]; levelColors?: string[]; levels: string[]; lineColors?: string[]; lineFrom?: number[]; lineTo?: number[]; pointSize?: number | number[]; rownames?: string[]; scale?: number[]; state?: any }

    Returns void

  • Resize the widget.

    Parameters

    • width: number

      New width.

    • height: number

      New height.

    Returns void

  • Set the widget state.

    Can be used to restore a previous state of the widget obtained with getState().

    Parameters

    • state: any

      A JSON string or an Object containing the desired state.

    Returns void

Generated using TypeDoc