ndb-core documentation
  1. Injectables
  2. TemplateExportFileDatatype

File

src/app/features/template-export/template-export-file-datatype/template-export-file.datatype.ts

Description

Datatype for managing template files of the PDF Generator API.

Only a string templateId of the API is stored on the entity itself.

Extends

StringDatatype

Index

Properties
Methods

Methods

transformToDatabaseFormat
transformToDatabaseFormat(value)
Inherited from DefaultDatatype
Defined in DefaultDatatype:38
Parameters :
Name Optional
value No
Returns : any
transformToObjectFormat
transformToObjectFormat(value)
Inherited from DefaultDatatype
Defined in DefaultDatatype:42
Parameters :
Name Optional
value No
Returns : any
Async anonymize
anonymize(value: EntityType, schemaField: EntitySchemaField, parent: any)
Inherited from DefaultDatatype
Defined in DefaultDatatype:148

(Partially) anonymize to "retain-anonymized" for reporting purposes without personal identifiable information.

Parameters :
Name Type Optional Description
value EntityType No

The original value to be anonymized
schemaField EntitySchemaField No
parent any No
Returns : Promise<any>
importIncompleteAdditionalConfigBadge
importIncompleteAdditionalConfigBadge(col: ColumnMapping)
Inherited from DefaultDatatype
Defined in DefaultDatatype:140

Output a label indicating whether the given column mapping needs user configuration for the "additional" config or has a valid, complete "additional" config. returns "undefined" if no user action is required.

Parameters :
Name Type Optional
col ColumnMapping No
Returns : string
Async importMapFunction
importMapFunction(val: any, schemaField: EntitySchemaField, additional?: any, importProcessingContext?: any)
Inherited from DefaultDatatype
Defined in DefaultDatatype:113

The function used to map values from the import data to values in the entities to be created. to share information across processing of multiple columns and rows.

Parameters :
Name Type Optional Description
val any No

The value from an imported cell to be mapped
schemaField EntitySchemaField No

The schema field definition for the target property into which the value is mapped
additional any Yes

config as returned by the configComponent
importProcessingContext any Yes

an object that the datatype can use to store any relevant context across multiple calls to share information across processing of multiple columns and rows.
Returns : Promise<EntityType | []>

Properties

Static dataType
Type : string
Default value : "template-export-file"
Inherited from DefaultDatatype
Defined in DefaultDatatype:11
editComponent
Type : string
Default value : "EditTemplateExportFile"
Inherited from DefaultDatatype
Defined in DefaultDatatype:15
Static label
Type : string
Default value : undefined
Inherited from DefaultDatatype
Defined in DefaultDatatype:12
viewComponent
Type : string
Default value : "ViewFile"
Inherited from DefaultDatatype
Defined in DefaultDatatype:14
Readonly importAllowsMultiMapping
Type : boolean
Default value : false
Inherited from DefaultDatatype
Defined in DefaultDatatype:48

Whether this datatype allows multiple values to be mapped to the same entity field during import.
Optional importConfigComponent
Type : string
Inherited from DefaultDatatype
Defined in DefaultDatatype:132

A component to be display as a dialog to configure the transformation function (e.g. defining a format or mapping)

 
import { Injectable } from "@angular/core";
import { StringDatatype } from "../../../core/basic-datatypes/string/string.datatype";

/**
 * Datatype for managing template files of the PDF Generator API.
 *
 * Only a string templateId of the API is stored on the entity itself.
 */
@Injectable()
export class TemplateExportFileDatatype extends StringDatatype {
  static override dataType = "template-export-file";
  static override label: string = undefined; // only used internally, not offered to users in Admin UI

  override viewComponent = "ViewFile";
  override editComponent = "EditTemplateExportFile";
}

results matching ""

    No results matching ""