Skip to content

Latest commit

 

History

History
187 lines (127 loc) · 9.01 KB

README.md

File metadata and controls

187 lines (127 loc) · 9.01 KB
Raw

jquery.flot.tooltip

tooltip plugin for wonderful Flot plotting library

For information about Flot library go here.

Works also with Time series data and supports Date formatting in the same way as Flot itself. You can fully define content of tip (with values precision) and you can use HTML tags too. Flot Tooltip can be easily customized with CSS. Just do what you want with #flotTip in your stylesheet.

Check examples folder for details of how to use it.

How to use

Download and include on your page after main jquery.flot library:

Important! You need to set flot option hoverable to true if you want flot.tooltip plugin to work.

grid: {
  hoverable: true 
}

Plugin Options (latest version)

In comments there are default values

tooltip:            boolean                 //false
tooltipOpts: {
    content:        string or function      //"%s | X: %x | Y: %y"
    xDateFormat:    string                  //null
    yDateFormat:    string                  //null
    monthNames:     string                  // null
    dayNames:       string                  // null
    shifts: {
        x:          int                     //10
        y:          int                     //20
    },
    defaultTheme:   boolean                 //true
    onHover:        function(flotItem, $tooltipEl)
}
  • tooltip : set to true to turn on this plugin (if grid.hoverable is also set to true)
  • content : content of your tooltip, HTML tags are also allowed; use %s for series label, %x for X value, %y for Y value and %p for percentage value (useful with pie charts using flot.pie plugin)
    With %x, %y and %p values you can also use .precision, for example %x.2 means that value of X will be rounded to 2 digits after the decimal point.
    If no precision or dateFormat is set then plugin uses tickFormatter to format values displayed on tooltip.
    If you require even more control over how the tooltip is generated you can pass a callback function(label, xval, yval, flotItem) that must return a string with the format described.
  • xDateFormat : you can use the same specifiers as in Flot, for time mode data
  • yDateFormat : you can use the same specifiers as in Flot, for time mode data
  • monthNames : check #28
  • dayNames : check #28
  • shifts : shift tooltip position regarding mouse pointer for x and y, negative values are ok
  • defaultTheme : plugin have default theme build-in but here you can switch it off and adjust look of tip styling #flotTip in your CSS
  • onHover : callback that allows you i.e. change color of the border of the tooltip according to the currently hovered serie

Depreciated in v0.5:

  • dateFormat

Depreciated in v0.3:

  • xValText : you can change text displayed on tooltip related to X value of hovered item
  • yValText : the same as above but regarding Y value
  • series : determine if name of series should be displayed in tooltip (if label exists)

For developers/contributors

In v0.5 I added grunt.js as easy to use build tool. During development you should work with js/jquery.flot.tooltip.source.js file. You can have grunt watch running or run grunt build every time you want.

Changelog

What's new in v0.6.6?

  • added support for custom tick label on y axis, thanks to @LoicUV

v0.6.5

  • added support for threshold.plugin with new example, fixed #57, thanks to @juerkkil

v0.6.4

  • great job by @Lukindo, fixed a few issues:
    • precision in x or y value #50
    • concerning $ escaping #16
    • use custom ticks if given #18
    • remove %s if series label is undefined #41

v0.6.3

  • enable Flot original ability to change both dayNames and monthNames, fix #28, thanks to @Jako

v0.6.2

  • events are properly unbinded on shutdown, thanks to @maplemuse
  • hide empty tooltip div on init, thanks to @ulipollo

v0.6 and v0.6.1

  • nothing from user perspective :)
  • another refactoring, FlotTooltip object structure changed to allow many instances to fix issue #13 (regression after v0.5 refactoring)

v0.5.1

  • content can be a function (thx to @fmsf for pull request)

v0.5

  • refactoring + fixed few issues (#7 and #11)
  • dateFormat option replaced with xDateFormat and yDateFormat to support both axes
  • changed string formatter logic:
    • if any axis has mode == time then format value according to axis date format (if defined) or tick format
    • if value has set precision, use it
    • in the end use tick formatter for the axis

v0.4.4

  • add jquery.flot.pie plugin support, you can display percentage value on tooltip (thx to @ismyrnow for pull request)

v0.4.3

  • add jquery.flot.stack plugin support, values in tooltip are now displayed correctly (issue #3)

v0.4.2

  • tooltip is appended to body, not placeholder of graph
  • changed default values of tip's shifts
  • time is formatted when first axis of flot's multi-axes is in time mode (issue #2) (full multi-axes support maybe in the future)
  • #flotTip container is initialized only if it does not exist (see new multiple-axes example and re-initialize plot)

v0.4.1

  • default theme with new option to disable it if you like to add your own styles

v0.4

Now you can easily set precision of values displayed on tip thanks to enhanced string formatter. Just put your desired precision after value in format like this %x.precision, where precision is a number of digits to appear after the decimal point. It uses number.toFixed(precision) function internally.

What is more string formatter was rewritten and now is RegExp based.

Examples:

content: "value of X is %x.1 and value of Y is %y.4 and they belong to '%s' series"
content: "<h4>%s</h4><ul><li>X is %x</li><li>Y is %y.2</li></ul>"

v0.3

I'd like to introduce string formatter. Now you can easily define how content of your flot.tooltip should look like. You can also use HTML tags!

Just use new option called content. The following specifiers are supported:

  • %x: for X value
  • %y: for Y value
  • %s: for series label

From now on also minified version is available.

v0.2

  • many series support with series name on the tooltip
  • date and time formatting can be defined when in time mode (using internal plot function)
  • tooltip position shift can be defined

Contributors

  • @ismyrnow - add jquery.flot.pie plugin support
  • @fmsf - content can be a function
  • @pdelanauze - upgrade to gruntjs v0.4 + memory usage optimization
  • @grrowl - fix tooltip position for touch devices
  • @Athanasius - fix issue #17, Tooltip is outside the window
  • @erezmazor - added label to the signature of content function to allow for fully custom label drawing
  • @maplemuse - pull request #39
  • @ulipollo - pull request #42
  • @Augi - pull request #36
  • @eunomie - pull request #52
  • @Jako - pull request #55, fix for issue #28
  • @Lukindo - pull request #56, fix for issues: #50, #16, #18 and #41
  • @LoicUV - pull request #62, added support for custom tick label on y axis.

Copyright (c) 2011-2013 Krzysztof Urbas (@krzysu).

jquery.flot.tooltip is available under the MIT license.