Get Free Trial
  1. API reference
Connecting to Data Source
Configuring the component
  • Documentation for older versions
  • Table of contents

    Number formatting

    The way numeric values are formatted in the component can be defined in a report.

    The default format is applied to all measures. In addition to this default format, specific number formats can be defined for certain measures. More details can be found in the following sections:

    If the component is connected to an OLAP cube wherein you have already formatted numbers, you can display these formatted values without applying any additional number formatting in the component. More information about this option below:

    To see live examples on how to format numbers, refer to our Examples page.

    Number format properties

    With number formatting you can define the following:

    • Separators for thousands and for decimals.
    • The number of decimals to show after the decimal separator.
    • The display of null and infinity values.
    • The format for currencies specifying both the currency symbol and its position – right or left of the number.

    Below is a list of all available properties:

    • name – String. It should be unique as it identifies the format in the report. Note: the format with the name property set to "" defines a default number format and it is applied to all the measures without a specific number format. Default value: "".
    • thousandsSeparator – String. Default value: " " (space).
    • decimalSeparator – String. Default value: ".".
    • decimalPlaces – Number. The exact number of decimals to show after the decimal separator. When set to -1, the entire number is shown. Note that for e-notation numbers (e.g., 5.8e+23), at least one decimal is always shown after the decimal separator, even if decimalPlaces is set to 0. Default value: -1.
    • maxDecimalPlaces – Number. The maximum number of decimals to show after the decimal separator. When set to -1, the entire number is shown. Note that for e-notation numbers (e.g., 5.8e+23), at least one decimal is always shown after the decimal separator, even if maxDecimalPlaces is set to 0. Default value: -1.
    • maxSymbols – Number. The maximum number of symbols in a cell. Default value: 20.
    • negativeNumberFormat – String. The format of the negative numbers. It can be one of the following values: "-1", "- 1", "1-", "1 -", and "(1)". Default value: "-1".
    • currencySymbol – String. The symbol which is shown to the left or the right of the value (e.g. currency symbol, hours, percent, etc.). Learn more about the ways to set the property. Default value: "".
    • positiveCurrencyFormat – String. The format of the currency symbol. It can be either "$1" or "1$". Default value: "$1".
    • negativeCurrencyFormat – String. The format of the currency symbol to display negative amounts. It can be one of the following values: "-$1", "-1$", "$-1", "$1-", "1-$", "1$-", "($1)", and "(1$)". Default value: "-$1".
    • isPercent – Boolean. When set to true, data is formatted as a percentage. The behavior is the same as in Excel. Setting isPercent to true will result in numbers being multiplied by 100 and shown with a % symbol. For example, 0.56 gets changed to 56%. Note: if % is set as currencySymbol, setting isPercent to true will not multiply numbers by 100. Default value: false.
    • nullValue – String. Defines how to show null values in the grid. Default value: "".
    • infinityValue – String. Defines how to show infinity values in the grid. Default value: "Infinity".
    • divideByZeroValue – String. Defines how to show divided by zero values in the grid. Default value: "Infinity".
    • textAlign – String. The alignment of formatted values in cells on the grid. It can have the following values: "right", "left", and "center". Default value: "right".
    • beautifyFloatingPoint – Boolean. In JavaScript the output of console.log(.1 + .2); is 0.30000000000000004. Check https://0.30000000000000004.com for more details about the problem. When the beautifyFloatingPoint property is set to true, numbers such as 0.30000000000000004 are formatted as 0.3. Setting beautifyFloatingPoint to false means that the full number will be shown. Default value: true.

    Setting a currency symbol

    The currencySymbol property can be specified in three ways: 

    • As the symbol itself (e.g., currencySymbol: "€").
    • As a numeric HTML code of the symbol (e.g., currencySymbol: "€"). 
    • As a named HTML code of the symbol (e.g., currencySymbol: "€"). 

    All the approaches are interchangeable unless you are planning to:

    In these cases, specify the currencySymbol as the symbol itself, e.g., by copy and paste. Otherwise, it will be displayed as code.

    If exporting the grid to HTML or image, you can use all available approaches to set the currencySymbol.

    Default number format

    The component has a built-in default number format that is applied to all measures by default. It is composed of the default values of the number format properties. The default format can be overridden in a report.

    To override the default number format for a report, define a number format with an empty string name property in a report, as follows:

    report: {
        dataSource: {
            filename: "data.csv" 
        }, 
        formats: [ 
            { 
                name: "", 
                thousandsSeparator: " ", 
                decimalSeparator: ".", 
                decimalPlaces: -1, 
                maxDecimalPlaces: -1, 
                maxSymbols: 20,
                negativeNumberFormat: "-1",
                currencySymbol: "", 
                negativeCurrencyFormat: "-$1", 
                positiveCurrencyFormat: "$1", 
                isPercent: false, 
                nullValue: "", 
                infinityValue: "Infinity", 
                divideByZeroValue: "Infinity", 
                textAlign: "right", 
                beautifyFloatingPoint: true 
            } 
        ], 
        slice: { 
            rows: [  
                { uniqueName: "Country" } 
            ],  
            columns: [ 
                { uniqueName: "[Measures]" } 
            ], 
            measures: [ 
                { 
                    uniqueName: "Price",
                    aggregation: "sum",
                    active: true
                }, 
                {
                    uniqueName: "Quantity",
                    aggregation: "sum", 
                    active: true
                } 
            ] 
        }
    } 

    See the example on JSFiddle.

    Number format for a specific measure

    A number format can be applied to a specific measure or measures. Each measure can have only one format, but a format can be applied to multiple measures.

    For example, if you are visualizing financial data, you may want to apply currency formatting to some of the measures in addition to the default format. To apply a format to a specific measure:

    1. Name a format.
    2. Define the format name for the measure(s) in a default slice.

    Properties defined in the default format get applied to all other formats. In the following example each measure with number formats "currency" and "amount" will have thousandsSeparator: ",", since it was defined in the default format:

    report: {
        dataSource: {
            filename: "https://cdn.flexmonster.com/data/data.csv"
        },
        formats: [
            {   
                name: "",
                thousandsSeparator: ","
            },
            {
                name: "currency",
                currencySymbol: "$"
            },
            {
                name: "amount",
                decimalPlaces: 0,
                currencySymbol: " pcs.",
                positiveCurrencyFormat: "1$"
            }
        ],
        slice: {
            rows: [ { uniqueName: "Category" } ], 
            measures: [ 
                { 
                    uniqueName: "Price",
                    aggregation: "sum",
                    active: true,
                    format: "currency"
                }, 
                {
                    uniqueName: "Discount",
                    aggregation: "sum",
                    active: false,
                    format: "currency"
                },
                {
                    uniqueName: "Quantity",
                    aggregation: "sum",
                    active: true,
                    format: "amount"
                }
            ]
        }
    } 

    Open the example on JSFiddle.

    Note A format can be defined for measure(s) even if they are not active (active property is false) in a default slice.

    Change number formatting using the Toolbar

    Use Format > Format cells in the Toolbar to change/define number formatting for measures at runtime.

    number formatting

    The number format will be applied to the measures and will be saved within the report.

    Starting from version 2.8.22, you can apply formatting to several measures simultaneously. Just choose the needed values in the corresponding dropdown menu:

    Number formatting via API

    The API calls setFormat() and getFormat() can be used to manipulate number formatting at runtime.

    Number formatting from an OLAP cube

    If you have already defined formats for measures in an OLAP cube and you want to use those formatted values, set the useOlapFormatting report property to true (it is turned off by default), as follows:

    report: {
        dataSource: {
            type: "microsoft analysis services",
            proxyUrl: "https://olap.flexmonster.com/olap/msmdpump.dll",
            cube: "Adventure Works",
            catalog: "Adventure Works DW Standard Edition"
        },
        slice: {
            rows: [ 
                {uniqueName: "[Product].[Category]"},
                {uniqueName: "[Reseller].[Business Type]"}
            ],
            columns: [{uniqueName: "[Measures]"}], 
            measures: [ {uniqueName: "[Measures].[Reseller Order Count]"}]
        },
        options: {
            useOlapFormatting: true
        }
    } 

    Check out on JSFiddle.

    Note The useOlapFormatting property is supported for Microsoft Analysis Services via both Flexmonster Accelerator and XMLA.