Opened 8 years ago

Closed 8 years ago

#13257 closed enhancement (fixed)

dojox.charting axis labelFunc should be fully documented

Reported by: cjolif Owned by: cjolif
Priority: high Milestone: 1.8
Component: Charting Version: 1.7.0b1
Keywords: Cc: Chris Mitchell, cjolif
Blocked By: Blocking:

Description

For example document does not state which parameters the labelFunc takes. This should be improved.

Change History (3)

comment:1 Changed 8 years ago by cschanz

On the mailinglist I was answered a similar question. Maybe something like the following can could be added to the documentation:

labelFunc

With labelFunc it is possible to create custom labels. The function has two parameters:

  • The first parameter is the preformatted label that the chart would create automatically. If dojo.number is imported the formatting is localised, for example with a german localisation "1323790000000" becomes "1.323.790.000.000".
  • The second parameter is optional and contains the raw value without preformatting.

Example:

labelFunc: function(ft, n){
   var preformatted = "Preformatted value: " + ft;
   var raw = "Raw value: " + n;
   console.log(preformatted);
   console.log(raw);
   return raw
}

comment:2 Changed 8 years ago by cjolif

Owner: changed from Eugene Lazutkin to cjolif

Partially done here: http://livedocs.dojotoolkit.org/dojox/charting#axis-labels will be done in the API doc later.

comment:3 Changed 8 years ago by cjolif

Resolution: fixed
Status: newclosed

In [27523]:

fixes #13180, #13257, #10962. As the new more costly drop labels mechanism does not hurt performance (because it also contains optimizations compare to previous version). I've kept it by default. !strict.

Note: See TracTickets for help on using tickets.