Class MLVPanel

Constructors

constructor

Properties

__doc__ _display_order bpPerPixel buffer_level call_update_listener canvas chr config ctx drmdListener drmmListener drmuListener end fcListener foListener force_redraw foto groups height highlighted_regions is_dragging isMouseDown lastMouseX lastMouseY legend listeners loadingIcon messageAlert moto mouse_over_feature mouseDownX new_layout retries rsmdListener rsmmListener rsmuListener scale_canvas scale_ctx select_div show_scale start start_dragging start_select tile track_order trackDialogs trackDiv trackLabels tracks width xOffset yOffset zmListener

Methods

_addTrackLabel _callListeners _getCoords _openTrackDialog _parseConfig _tracksChanged addListener addRulerTrack addScaleCanvas addTrack allowUserDrag allowUserFeatureClick allowUserFeatureOver allowUserRangeSelection allowUserZoom autoScale calculateMaxScale changeBaseDocument closeAllDialogs disableUserZoom drawHighlightedRegion getAllFeatures getAllTrackConfigs getBpStart getCurrentTrackFeatures getDiv getFeatureAt getImage getTrack getTrackConfig getTracksHeight paintImage redrawTile removeAllHighlightedRegions removeAllowSelection removeAllTracks removeDragHandler removeFeatureClickHandler removeFeatureOverHandler removeHighlightedRegion removeListener removeTrack repaint setBufferLevel setHighlightedRegion setSize setTrackAttribute setTrackAttributes setTrackColorFunction setTrackFeatureFilter setTrackLabelFunction update

Constructors

constructor

  • new MLVPanel(div: any, config?: object, tracks?: array): MLVPanel

  • Creates a panel

    Parameters

    • div: any
    • config: object = {}

      A config with the panel settings

    • tracks: array = []

      a list of config objects describing each track

    Returns MLVPanel

Properties

__doc__

__doc__: Document

_display_order

_display_order: undefined | any[]

bpPerPixel

bpPerPixel: any

buffer_level

buffer_level: number

call_update_listener

call_update_listener: any

canvas

canvas: HTMLCanvasElement

chr

chr: undefined | string

config

config: object

ctx

ctx: null | CanvasRenderingContext2D

drmdListener

drmdListener: undefined | null | (e: any) => void

drmmListener

drmmListener: undefined | null | (e: any) => void

drmuListener

drmuListener: undefined | null | (e: any) => void

end

end: any

fcListener

fcListener: undefined | null | (e: any) => void

foListener

foListener: undefined | null | (e: any) => void

force_redraw

force_redraw: undefined | boolean

foto

foto: undefined | Timeout

groups

groups: {}

height

height: any

highlighted_regions

highlighted_regions: {}

is_dragging

is_dragging: boolean

isMouseDown

isMouseDown: boolean

lastMouseX

lastMouseX: undefined | number

lastMouseY

lastMouseY: undefined | number

legend

legend: any

listeners

listeners: {}

loadingIcon

loadingIcon: HTMLElement

messageAlert

messageAlert: HTMLDivElement

moto

moto: undefined | Timeout

mouse_over_feature

mouse_over_feature: undefined | null | object

mouseDownX

mouseDownX: undefined | number

new_layout

new_layout: undefined | boolean

retries

retries: number

rsmdListener

rsmdListener: undefined | null | (e: any) => void

rsmmListener

rsmmListener: undefined | null | (e: any) => void

rsmuListener

rsmuListener: undefined | null | (e: any) => void

scale_canvas

scale_canvas: undefined | HTMLCanvasElement

scale_ctx

scale_ctx: undefined | null | CanvasRenderingContext2D

select_div

select_div: undefined | HTMLDivElement

show_scale

show_scale: undefined | boolean

start

start: any

start_dragging

start_dragging: undefined | boolean

start_select

start_select: undefined | null | number

tile

tile: any

track_order

track_order: any[]

trackDialogs

trackDialogs: {}

trackDiv

trackDiv: any

trackLabels

trackLabels: {}

tracks

tracks: {}

width

width: any

xOffset

xOffset: undefined | number

yOffset

yOffset: number

zmListener

zmListener: undefined | (e: any) => void

Methods

_addTrackLabel

_callListeners

  • _callListeners(type: any, data: any, e: any): void

  • Parameters

    • type: any
    • data: any
    • e: any

    Returns void

_getCoords

  • _getCoords(e: any): { x: number; y: number }

  • Parameters

    • e: any

    Returns { x: number; y: number }

_openTrackDialog

_parseConfig

_tracksChanged

addListener

  • addListener(id: string, func: Function): string

  • Adds a listener to the panel

    Parameters

    • id: string

      The id of the handler (can be used to remove the handler) Optional - an id will be assigned (and returned) if not supplied @returns{string} The id of the handler or null if the type did not exist

    • func: Function

      The function to call

    Returns string

addRulerTrack

addScaleCanvas

addTrack

  • addTrack(config: object, index: integer, no_propagate: any): void

  • Removes a listener to the panel

    Parameters

    • config: object

      The config of the track to addTrack

    • index: integer

      Optional, the vertical order of the track

    • no_propagate: any

    Returns void

allowUserDrag

allowUserFeatureClick

allowUserFeatureOver

allowUserRangeSelection

allowUserZoom

autoScale

  • autoScale(features: any, min: any, max: any): { max: any; min: any }

  • Parameters

    • features: any
    • min: any
    • max: any

    Returns { max: any; min: any }

calculateMaxScale

changeBaseDocument

closeAllDialogs

disableUserZoom

drawHighlightedRegion

  • drawHighlightedRegion(region: any, options: any): void

  • Parameters

    • region: any
    • options: any

    Returns void

getAllFeatures

  • getAllFeatures(bpStart: any, bpEnd: any, force: any, data: any): Promise<any>

  • Parameters

    • bpStart: any
    • bpEnd: any
    • force: any
    • data: any

    Returns Promise<any>

getAllTrackConfigs

getBpStart

getCurrentTrackFeatures

getDiv

  • getDiv(): integer

  • Returns the element that houses the panel

    Returns integer

    level - The type of listener - track_empty

getFeatureAt

  • getFeatureAt(e: any): object

  • Gets the feature that was clicked

    Parameters

    • e: any

      Can be any object- all that is required is pageX and PageY

    Returns object

    An object with track - the track config at the event position(or null) and feature - the feature at the postition (or null).

getImage

getTrack

getTrackConfig

getTracksHeight

paintImage

redrawTile

removeAllHighlightedRegions

removeAllowSelection

removeAllTracks

removeDragHandler

removeFeatureClickHandler

removeFeatureOverHandler

removeHighlightedRegion

  • removeHighlightedRegion(name: string): void

  • Removes the highlighted region from the panel

    Parameters

    • name: string

      The name of the highlighted region that was given when it was created.

    Returns void

removeListener

  • removeListener(id: string): boolean

  • Removes a listener to the panel

    Parameters

    • id: string

      The id of the handler to remove @returns{boolean} true if the listener was removed, otherwise false

    Returns boolean

removeTrack

  • removeTrack(track_id: integer, not_repaint: any, not_propagate: any): any

  • Removes a listener to the panel

    Parameters

    • track_id: integer
    • not_repaint: any
    • not_propagate: any

    Returns any

repaint

  • repaint(force: boolean, range_from_tile: boolean, svg?: Function): void

  • Repaint the view, using a cached image if available.

    Parameters

    • force: boolean

      If true then a cached image will not be used

    • range_from_tile: boolean

      Redraw the tile

    • Optionalsvg: Function

      if a callback is supplied , then the actual browser will not repaint but a serialises svg string of the browser's contents will be passed to the function

    Returns void

setBufferLevel

  • setBufferLevel(level: integer): void

  • sets the extra amount of track to draw each side of the view. A value of 1 will retrieve 1 x the view width each side i.e. 3 x the visible window

    Parameters

    • level: integer

      The type of listener - track_empty

    Returns void

setHighlightedRegion

  • setHighlightedRegion(location: Object, name: string, color: string): void

  • Sets the highlighted region

    Parameters

    • location: Object

      An object containing chr, start and end

    • name: string

      The name(id) of the region (used to remove the region)

    • color: string

      The color to give the highlighted region

    Returns void

setSize

setTrackAttribute

  • setTrackAttribute(track_id: any, key: any, value: any): void

  • Parameters

    • track_id: any
    • key: any
    • value: any

    Returns void

setTrackAttributes

  • setTrackAttributes(track_id: any, attributes: any): void

  • Parameters

    • track_id: any
    • attributes: any

    Returns void

setTrackColorFunction

  • setTrackColorFunction(track_id: string, func: string): void

  • Sets the filter function for track

    Parameters

    • track_id: string

      The id of the track

    • func: string

      The color function. It should accept the feature and return the feature color. Use null to go back to default colors

    Returns void

setTrackFeatureFilter

  • setTrackFeatureFilter(track_id: string, func: string): void

  • Sets the filter function for track.

    Parameters

    • track_id: string

      The id of the track

    • func: string

      The filter function. It should accept the feature and return true to dispaly the feature and false to hide it. Use null to cancel the filter

    Returns void

setTrackLabelFunction

  • setTrackLabelFunction(track_id: any, func: any): void

  • Parameters

    • track_id: any
    • func: any

    Returns void

update

  • update(chr: string, start: integer, end: integer, no_propagation: any): void

  • Updated the panel view, if chromosome start and end are supplied it will go to this location. If no parameters are given the panel will be redrawn at the same location e.g after the color, scale or another paramter has been set

    Parameters

    • chr: string
    • start: integer

      of the region to draw

    • end: integer

      of the region to draw

    • no_propagation: any

    Returns void

Settings

Member Visibility

On This Page

Constructors
Properties
Methods