@quartic/bokehjs/src/coffee/models/tools/tool.coffee

Interactive, novel data visualization

import {logger} from "core/logging"
import * as p from "core/properties"
import {BokehView} from "core/bokeh_view"
import {min, max} from "core/util/array"
import {Model} from "../../model"

export class ToolView extends BokehView

  initialize: (options) ->
    super(options)
    @plot_view = options.plot_view

  @getters {
    plot_model: () -> @plot_view.model
  }

  bind_bokeh_events: () ->
    @listenTo(@model, 'change:active', () =>
      if @model.active
        @activate()
      else
        @deactivate()
    )

  # activate is triggered by toolbar ui actions
  activate: () ->

  # deactivate is triggered by toolbar ui actions
  deactivate: () ->

export class Tool extends Model

  @getters {
    synthetic_renderers: () -> []
  }

  @define {
    plot: [ p.Instance ]
  }

  @internal {
    active: [ p.Boolean, false ]
  }

  # utility function to return a tool name, modified
  # by the active dimenions. Used by tools that have dimensions
  _get_dim_tooltip: (name, dims) ->
    switch dims
      when 'width'  then "#{name} (x-axis)"
      when 'height' then "#{name} (y-axis)"
      when 'both'   then name

  # utility function to get limits along both dimensions, given
  # optional dimensional constraints
  _get_dim_limits: ([vx0, vy0], [vx1, vy1], frame, dims) ->
    hr = frame.h_range
    if dims == 'width' or dims == 'both'
      vxlim = [min([vx0, vx1]),         max([vx0, vx1])]
      vxlim = [max([vxlim[0], hr.min]), min([vxlim[1], hr.max])]
    else
      vxlim = [hr.min, hr.max]

    vr = frame.v_range
    if dims == 'height' or dims == 'both'
      vylim = [min([vy0, vy1]),         max([vy0, vy1])]
      vylim = [max([vylim[0], vr.min]), min([vylim[1], vr.max])]
    else
      vylim = [vr.min, vr.max]

    return [vxlim, vylim]