Skip to content

spreadsheet_formats_config.md

Latest commit

 

History

History
83 lines (67 loc) · 2.4 KB

spreadsheet_formats_config.md

File metadata and controls

83 lines (67 loc) · 2.4 KB
sidebar_label formats
title formats config
description You can learn about the formats config in the documentation of the DHTMLX JavaScript Spreadsheet library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Spreadsheet.

formats

Description

@short: Optional. Defines the list of number formats

Usage

formats?: array;

Parameters

The formats property is an array of number format objects, each of which includes a set of properties:

  • id - the id of a format that is used to set format to a cell via the method
  • mask - a mask for a number format
  • name - the name of a format displayed in the toolbar and menu drop-down lists
  • example - an example that shows how a formatted number looks like. The number 2702.31 is used as a default value for format examples

Default config

The default number formats are the following:

defaultFormats = [
    { name: "Common", id: "common", mask: "", example: "1500.31" },
    { name: "Number", id: "number", mask: "#,##0.00", example: "1,500.31" },
    { name: "Percent", id: "percent", mask: "#,##0.00%", example: "1,500.31%" },
    { name: "Currency", id: "currency", mask: "$#,##0.00", example: "$1,500.31" },
    { name: "Date", id: "date", mask: "mm-dd-yy", example: "28/12/2021" },
    { 
        name: "Time",
           id: "time",
           mask: hh:mm:ss am/pm || hh:mm:ss, // depending on the timeFormat config
           example: "13:30:00"
    },
    { name: "Text", id: "text", mask: "@", example: "'1500.31'" }
];

Example

const spreadsheet = new dhx.Spreadsheet("spreadsheet", {
    formats: [
        {
            name: "U.S. Dollar",
            id: "currency",
            mask: "$#,##0.00"
        },
        {
            name: "Euro",
            id: "euro",
            mask: "[$€]#.##0,00",
            example: "1000.50"
        },
        {
            name: "Swiss franc",
            id: "franc",
            mask: "[$CHF ]#.##0,00"
        }
    ],
    // other config parameters
});

Change log:

  • The "Time" format was added in v4.3
  • The "Date" format was added in v4.2
  • The "Text" format was added in v4.0

Related articles: