Menu
Free Trials
  1. API reference
    1. flexmonster
    2. Report Object
    3. Options Object
    4. Format Object
  2. Methods
    1. addCalculatedMeasure
    2. addCondition
    3. addJSON
    4. addMeasure
    5. addStyleToMember
    6. addUrlToMember
    7. clear
    8. clearFilter
    9. clearXMLACache
    10. closeFieldsList
    11. collapseAllData
    12. collapseData
    13. connectTo
    14. dispose
    15. embedPivotComponent
    16. expandAllData
    17. expandData
    18. exportTo
    19. fullScreen
    20. getAllConditions
    21. getAllHierarchies
    22. getAllMeasures
    23. getCell
    24. getColumns
    25. getColumnWidth
    26. getCondition
    27. getData
    28. getFilter
    29. getFilterProperties
    30. getFormat
    31. getLabels
    32. getMeasures
    33. getMembers
    34. getOptions
    35. getPages
    36. getReport
    37. getRowHeight
    38. getRows
    39. getSelectedCell
    40. getSort
    41. getValue
    42. getXMLACatalogs
    43. getXMLACubes
    44. getXMLADataSources
    45. getXMLAProviderName
    46. gridColumnCount
    47. gridRowCount
    48. load
    49. off
    50. on
    51. open
    52. openFieldsList
    53. percentZoom
    54. print
    55. refresh
    56. removeAllCalculatedMeasures
    57. removeAllConditions
    58. removeAllMeasures
    59. removeCalculatedMeasure
    60. removeCondition
    61. removeMeasure
    62. removeSelection
    63. runQuery
    64. save
    65. setBottomX
    66. setChartTitle
    67. setColumnWidth
    68. setFilter
    69. setFormat
    70. setGridTitle
    71. setHandler
    72. setLabels
    73. setOptions
    74. setReport
    75. setRowHeight
    76. setSelectedCell
    77. setSort
    78. setStyle
    79. setTopX
    80. showCharts
    81. showGrid
    82. showGridAndCharts
    83. sortValues
    84. updateData
    85. zoomTo
    86. jsCellClickHandler
    87. jsFilterOpenHandler
    88. jsFieldsListCloseHandler
    89. jsFieldsListOpenHandler
    90. jsFullScreenHandler
    91. jsPivotCreationCompleteHandler
    92. jsPivotUpdateHandler
    93. jsReportChangeHandler
    94. jsReportLoadedHandler
  3. Events
    1. cellclick
    2. celldoubleclick
    3. dataerror
    4. datafilecancelled
    5. dataloaded
    6. exportcomplete
    7. exportstart
    8. fieldslistclose
    9. fieldslistopen
    10. filteropen
    11. loadingdata
    12. loadinglocalization
    13. loadingolapstructure
    14. loadingreportfile
    15. localizationerror
    16. localizationloaded
    17. olapstructureerror
    18. olapstructureloaded
    19. openingreportfile
    20. printcomplete
    21. printstart
    22. querycomplete
    23. queryerror
    24. ready
    25. reportchange
    26. reportcomplete
    27. reportfilecancelled
    28. reportfileerror
    29. reportfileloaded
    30. runningquery
    31. update
Table of contents

Format Object

Format object contains the following number format parameters:

  • name – String. It identifies the format in the report, thus, it should be unique. The default is "", which means that this number format is a default one and it is applied to all the measures for which the specific number format is not set.
  • thousandsSeparator – String. The default is " " (space).
  • decimalSeparator – String. The default is ".".
  • decimalPlaces – Number. The exact number of decimals to show in the fractional part of a number after the decimal separator. The default is -1, which means that the number will be shown as is.
  • maxDecimalPlaces – Number. The maximum number of decimals to show in the fractional part of a number after the decimal separator. The default is -1, which means the number will be shown as is.
  • maxSymbols – Number. The maximum number of symbols in a cell. The default is 20.
  • currencySymbol – String. The symbol which is shown near the value (currency symbol, hours, percent, etc.). The default is "".
  • currencySymbolAlign – String. The alignment of the currency symbol. It can be "left" or "right". The default is "left".
  • isPercent – Boolean. It allows to format data as percentage. The behavior is the same as in Excel. The default is false. Set isPercent to true and numbers will be multiplied by 100 and % symbol will be added. For example, 0.56 will be changed to 56%. Please note, if % is set as currencySymbol, setting isPercent to true will not multiply numbers by 100.
  • nullValue – String. It defines how to show null values in the grid. The default is "".
  • infinityValue – String. It defines how to show infinity values in the grid. The default is "Infinity".
  • divideByZeroValue – String. It defines how to show divided by zero values in the grid. The default is "Infinity".
  • textAlign – String. The alignment of formatted values in cells on the grid: "right" or "left". The default is "right".