ndb-core documentation
  1. Injectables
  2. UpdateMetadataDatatype

File

src/app/core/entity/model/update-metadata.datatype.ts

Description

Datatype for internally saved meta-data of entity edits.

Extends

SchemaEmbedDatatype

Index

Properties
Methods

Methods

transformToDatabaseFormat
transformToDatabaseFormat(value: any)
Inherited from DefaultDatatype
Defined in DefaultDatatype:42
Parameters :
Name Type Optional
value any No
Returns : any
transformToObjectFormat
transformToObjectFormat(value: any)
Inherited from DefaultDatatype
Defined in DefaultDatatype:49
Parameters :
Name Type Optional
value any 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
Default value : UpdateMetadata.DATA_TYPE
Inherited from DefaultDatatype
Defined in DefaultDatatype:11
embeddedType
Default value : UpdateMetadata as unknown as EntityConstructor
Inherited from SchemaEmbedDatatype
Defined in SchemaEmbedDatatype:13
Protected Readonly schemaService
Default value : inject(EntitySchemaService)
Inherited from SchemaEmbedDatatype
Defined in SchemaEmbedDatatype:40
editComponent
Type : string
Default value : "EditText"
Inherited from DefaultDatatype
Defined in DefaultDatatype:69
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)
Static label
Type : string
Default value : $localize`:datatype-label:any`
Inherited from DefaultDatatype
Defined in DefaultDatatype:57

The human-readable name for this dataType, used in config UIs.
viewComponent
Type : string
Default value : "DisplayText"
Inherited from DefaultDatatype
Defined in DefaultDatatype:68

The default component how this datatype should be displayed in lists and forms.

The edit component has to be a registered component. Components that are registered contain the DynamicComponent decorator

 
import { UpdateMetadata } from "./update-metadata";
import { SchemaEmbedDatatype } from "../../basic-datatypes/schema-embed/schema-embed.datatype";
import { EntityConstructor } from "./entity";
import { Injectable } from "@angular/core";

/**
 * Datatype for internally saved meta-data of entity edits.
 */
@Injectable()
export class UpdateMetadataDatatype extends SchemaEmbedDatatype {
  static override dataType = UpdateMetadata.DATA_TYPE;

  override embeddedType = UpdateMetadata as unknown as EntityConstructor;
}

results matching ""

    No results matching ""