1. API reference
    1. Introduction
    2. Flexmonster()
  2. Objects
    1. All objects
    2. Report Object
    3. Slice Object
    4. Options Object
    5. Format Object
    6. Conditional Format Object
    7. Cell Data Object
  3. Methods
    1. All methods
    2. addCalculatedMeasure
    3. addCondition
    4. clear
    5. clearFilter
    6. clearXMLACache
    7. closeFieldsList
    8. collapseAllData
    9. collapseData
    10. connectTo
    11. customizeCell
    12. dispose
    13. expandAllData
    14. expandData
    15. exportTo
    16. getAllConditions
    17. getAllHierarchies
    18. getAllMeasures
    19. getCell
    20. getColumns
    21. getCondition
    22. getData
    23. getFilter
    24. getFilterProperties
    25. getFormat
    26. getMeasures
    27. getMembers
    28. getOptions
    29. getReport
    30. getReportFilters
    31. getRows
    32. getSelectedCell
    33. getSort
    34. getXMLACatalogs
    35. getXMLACubes
    36. getXMLADataSources
    37. getXMLAProviderName
    38. load
    39. off
    40. on
    41. open
    42. openFieldsList
    43. print
    44. refresh
    45. removeAllCalculatedMeasures
    46. removeAllConditions
    47. removeCalculatedMeasure
    48. removeCondition
    49. removeSelection
    50. runQuery
    51. save
    52. setBottomX
    53. setFilter
    54. setFormat
    55. setOptions
    56. setReport
    57. setSort
    58. setTopX
    59. showCharts
    60. showGrid
    61. showGridAndCharts
    62. sortValues
    63. updateData
  4. Events
    1. All events
    2. aftergriddraw
    3. beforegriddraw
    4. beforetoolbarcreated
    5. cellclick
    6. celldoubleclick
    7. datachanged
    8. dataerror
    9. datafilecancelled
    10. dataloaded
    11. exportcomplete
    12. exportstart
    13. fieldslistclose
    14. fieldslistopen
    15. filteropen
    16. loadingdata
    17. loadinglocalization
    18. loadingolapstructure
    19. loadingreportfile
    20. localizationerror
    21. localizationloaded
    22. olapstructureerror
    23. olapstructureloaded
    24. openingreportfile
    25. printcomplete
    26. printstart
    27. querycomplete
    28. queryerror
    29. ready
    30. reportchange
    31. reportcomplete
    32. reportfilecancelled
    33. reportfileerror
    34. runningquery
    35. update
Table of contents

getFormat

getFormat(measureName:String):Format Object

[starting from version: 1.4]

Returns Format Object of a default number format or the number format for the specified measure. The number format can be defined via report or via setFormat() API method. Each measure has only one format but a format can be applied to more than one measure.

Parameters

  • measureName (optional) – the unique name of the measure. If measure’s unique name is not specified or it is not found, the default number format will be returned.

Examples

1) How to get a precision:

var format = flexmonster.getFormat();
alert("Precision: " + format.decimalPlaces);

Try on JSFiddle.

2) How to change a currency symbol:

var format = flexmonster.getFormat("Price");
format.currencySymbol = "$";
//format.currencySymbol = "£" // pound sterling
//format.currencySymbol = "€" // euro
//format.currencySymbol = "¥" // yen
flexmonster.setFormat(format, "Price");
flexmonster.refresh();

Open the example on JSFiddle.

See also

setFormat
Format Object