Class ExportExcel`Abstract`

Provides Excel / spreadsheet exports of AbstractCollection card collections.

Index

Methods

cardDB cards collection collectionCategory

Methods

`Static`cardDB

cardDB(
    __namedParameters: {
        columns?: Columns;
        db: CardDB.Stream.Reader;
        sort?: ExportExcel.Options.Sort;
        theme?: "dark" | "light";
    },
): Promise<Workbook>
Parameters
- __namedParameters: {
      columns?: Columns;
      db: CardDB.Stream.Reader;
      sort?: ExportExcel.Options.Sort;
      theme?: "dark" | "light";
  }
Returns Promise<Workbook>

`Static`cards

cards(
    __namedParameters: {
        cards: Card[];
        columns?: Columns;
        meta: MetadataCommon;
        sort?: ExportExcel.Options.Sort;
        theme?: "dark" | "light";
    },
): Promise<Workbook>
Parameters
- __namedParameters: {
      cards: Card[];
      columns?: Columns;
      meta: MetadataCommon;
      sort?: ExportExcel.Options.Sort;
      theme?: "dark" | "light";
  }
Returns Promise<Workbook>

`Static`collection

collection(
    options: {
        collection: AbstractCollection;
        columns?: Columns;
        theme?: "dark" | "light";
    },
): Promise<Map<string, Workbook>>
Creates Excel / spreadsheet workbooks for all categories in a collection.
Parameters
- options: { collection: AbstractCollection; columns?: Columns; theme?: "dark" | "light" }
  Options.
  - collection: AbstractCollection
    The collection being exported.
  - Optionalcolumns?: Columns
  - Optionaltheme?: "dark" | "light"
    Theme name.
Returns Promise<Map<string, Workbook>>
Excel workbooks for each non-empty category indexed by category name.

`Static`collectionCategory

collectionCategory(
    options: {
        category: CardCategory;
        collection: AbstractCollection;
        columns?: Columns;
        theme?: "dark" | "light";
    },
): Promise<Workbook>
Creates an Excel / spreadsheet workbook for a specific collection category.
Parameters
- options: {
      category: CardCategory;
      collection: AbstractCollection;
      columns?: Columns;
      theme?: "dark" | "light";
  }
  Options.
  - category: CardCategory
    Specific category to export.
  - collection: AbstractCollection
    The collection being exported.
  - Optionalcolumns?: Columns
  - Optionaltheme?: "dark" | "light"
    Theme name.
Returns Promise<Workbook>
An Excel workbook.