Configuration

Configuration Reference

The ExportDataConfig interface provides the following options:

Column Definitions

• header (string): The column header to display.

• key (string): The key to map the data value.

• width (number): The column width (default: 20).

Example:

const columnDefinitions = [
    { header: 'Username', key: 'name', width: 30 },
    { header: 'Phone Number', key: 'phone', width: 15 },
];

Cell Style

Customize the appearance of individual cells:

const cellStyle = {
    name: 'Arial',
    size: 12,
    ARGBColor: 'FF0000FF',
    bold: true,
    horizontalAlignment: 'center',
    verticalAlignment: 'middle',
};

UtilsService: Field Conversion

You need to inject the UtilsService

The UtilsService provides a method for optional field conversion:

convertFieldsToStrings

Convert object fields to string representations using a provided configuration. This operation does not happen automatically and must be invoked explicitly.

import { UtilsService } from 'data-export-package';

constructor(private readonly utilsService: UtilsService) {}

const users = [
    { id: 1, name: 'Alice', age: 25, registered: new Date(), active: true },
    { id: 2, name: 'Bob', age: null, registered: undefined, active: false },
];

const formattedUsers = this.utilsService.convertFieldsToStrings(users, {
    numberFormatter: (value) => `$${value.toFixed(2)}`,
    dateFormatter: (value) => value.toLocaleDateString(),
    booleanFormatter: (value) => (value ? 'Yes' : 'No'),
});

console.log(formattedUsers);

Titles (Horizontal and Vertical)

Add titles to the worksheet for better presentation.

Horizontal Title

config.horizontalTitle = {
    text: 'User Report',
    style: { bold: true, size: 14, ARGBColor: 'FF00FF00' },
};

Vertical Title

config.verticalTitle = {
    text: 'Data Export',
    style: { bold: true, size: 14, ARGBColor: 'FFFF0000' },
};

Example Usage

Export Data to Excel

import { ExportDataService } from 'data-export-package';

constructor(private readonly exportDataService: ExportDataService) {}

const data = [
    { name: 'Alice', phone: '1234567890' },
    { name: 'Bob', phone: '0987654321' },
];

const config = {
    columns: [
        { header: 'Username', key: 'name', width: 20 },
        { header: 'Phone Number', key: 'phone', width: 15 },
    ],
    horizontalTitle: {
        text: 'User Report',
        style: { bold: true, size: 14 },
    },
};

this.exportDataService.exportData(config, data);

Export Data to CSV

import { ExportDataService } from 'data-export-package';

constructor(private readonly exportDataService: ExportDataService) {}

const data = [
    { name: 'Charlie', email: '[e-mail]' },
    { name: 'Diana', email: '[e-mail]' },
];

const config = {
    columns: [
        { header: 'Name', key: 'name' },
        { header: 'Email', key: 'email' },
    ],
};

this.exportDataService.exportData(config, data, 'csv');