Index

src/app/core/import/additional-actions/additional-import-action.ts

AdditionalImportAction

Definition of an additional generic import action, e.g. linking imported records to an existing group entity.

AdditonalDirectLinkAction | AdditionalIndirectLinkAction

src/app/dynamic-components.ts

AsyncComponent
function
ComponentTuple
[string, AsyncComponent]

src/app/core/common-components/entity-form/dynamic-form-validators/validator-types.ts

AsyncPromiseValidatorFn
function

src/app/core/common-components/entity-form/FormConfig.ts

ColumnConfig

Type for the definition of a single column in the EntitySubrecord

string | FormFieldConfig

src/app/core/basic-datatypes/configurable-enum/configurable-enum-ordering.ts

Config
Array<>
EnumValue

src/app/core/config/config-migration.ts

ConfigMigration

A ConfigMigration is checked during a full JSON.parse using a reviver function. If the migration does not apply to the given configPart, make sure to return it unchanged. Multiple migrations are chained and can transform the same config part one after the other.

function

src/app/core/basic-datatypes/configurable-enum/configurable-enum.types.ts

ConfigurableEnumConfig

Interface specifying overall object representing an enum with all its options as stored in the config database

Array<T>

src/app/core/dashboard/dashboard-widget/dashboard-widget.component.ts

DashboardTheme
"general" | "child" | "attendance" | "note" | "class" | "school"

src/app/core/permissions/permission-types.ts

DatabaseRule

The format that the JSON defined rules need to have. In the JSON object the Entities can be specified by using their ENTITY_TYPE string representation.

RawRuleOf<Ability<>>
EntityActionPermission

The type which defines which actions can be used for permissions. The type allows all strings defined in the actions array. E.g. "read" or "manage"

EntitySubject

The type which defines which subjects can be used for permissions. This matches any entity classes, entity objects and the wildcard string "all" E.g. Child, new Note() or all

EntityConstructor | Entity | string

src/app/core/filter/filters/filters.ts

DataFilter

This filter can be used to filter an array of entities. It has to follow the MongoDB Query Syntax ://www.mongodb.com/docs/manual/reference/operator/query/{@link https}.

The filter is parsed using ucast ://github.com/stalniy/ucast/tree/master/packages/mongo2jshttps

MongoQuery<T> | literal type

src/app/core/default-values/default-value-service/default-value.service.ts

DefaultValueHint
FullDefaultValueHint | EmptyDefaultValueHint

src/app/core/default-values/default-value-config.ts

DefaultValueMode
"inherited-from-referenced-entity" | "static" | "dynamic" | "updated-from-referencing-entity"

src/app/core/common-components/entity-form/dynamic-form-validators/form-validator-config.ts

DynamicValidator

Available validators that can be used to display errors to the user when a form is invalid

"min" | "max" | "required" | "validEmail" | "uniqueId" | "readonlyAfterSet" | "pattern"
FormValidatorConfig

the validators config. This is an object where the key must be one of the DynamicValidators. The value to that key is specific to that validator. For example, the max validator requires a number while the pattern validator requires a string or regex. Compliant examples:

{
  min: 5,
  pattern: "[a-z]*",
}

Non-compliant examples:

{
  min: "abc",
  rabbit: true
}

src/app/core/entity-details/entity-actions-menu/entity-actions-menu.service.ts

EntityActionsFactory
function

src/app/core/entity/model/entity.ts

EntityConstructor

This represents a static class of type . It can be used for passing a class from which new objects should be created. It can also be used to check the ENTITY_TYPE of a class For example usage check the EntityMapperService.

src/app/core/common-components/entity-form/entity-form.service.ts

EntityFormGroup
TypedFormGroup<Partial<T>>
TypedFormGroup

These are utility types that allow to define the type of FormGroup the way it is returned by EntityFormService.create

FormGroup<ɵElement< | >>

src/app/core/basic-datatypes/entity/entity-reference-role.ts

EntityReferenceRole

Specifies the role of an entity reference where "aggregate" = "has a" relationship where both entities have meaning independent of each other; "composite" = "part of" relationship where the referenced entity should not exist without the referenced entity.

Default is treated as "aggregate".

(role names following the UML association types)

"aggregate" | "composite"

src/app/core/entity/schema/entity-schema.ts

EntitySchema

Complete schema of an Entity containing multiple EntitySchemaFields.

This is generated from all @DatabaseField() of a class and then defines the transformation for that whole entity type.

Map<string | EntitySchemaField>

src/app/core/export/download-service/download.service.ts

FileDownloadFormat
"csv" | "json" | "pdf"

src/app/core/entity-list/EntityListConfig.ts

FilterConfig
BasicFilterConfig | BooleanFilterConfig | PrebuiltFilterConfig<T> | ConfigurableEnumFilterConfig<T>

src/app/features/config-setup/config-import-parser.service.ts

GeneratedConfig
literal type

src/app/core/database/database.ts

GetAllOptions

Basic database read options supported by Database.

also see https://pouchdb.com/api.html#fetch_document

PouchDB.Core.AllDocsWithKeyOptions | PouchDB.Core.AllDocsWithKeysOptions | PouchDB.Core.AllDocsWithinRangeOptions | PouchDB.Core.AllDocsOptions
GetOptions

Basic database read options supported by Database.

also see https://pouchdb.com/api.html#fetch_document

PouchDB.Core.GetOptions
QueryOptions

Basic query options supported by Database.

also see https://pouchdb.com/guides/queries.html

PouchDB.Query.Options<any | any>

src/app/utils/media/screen-size-observer.service.ts

IsDesktop

A type that is used to document the return type of the platform observable. A variable that has this type shall only have two values that are encoded in a boolean way:

  • true: the variable represents that the width of something is considered 'desktop width'
  • false: the variable represents that the width of something is considered 'mobile width'
boolean

src/app/features/location/map/map-properties-popup/map-properties-popup.component.ts

LocationProperties

A map of entity types and the (selected) location properties of this type

literal type

src/app/child-dev-project/attendance/add-day-attendance/roll-call-setup/roll-call-setup.component.ts

NoteForActivitySetup

src/app/features/notification/model/notification-config.ts

NotificationChannel

Defines allowed notification channels.

Note: "push" is handled via individual device registrations and not part of this config currently.

NotificationType

Base type of notification rule.

src/app/features/location/geo.service.ts

OpenStreetMapsSearchResult

src/app/child-dev-project/attendance/add-day-attendance/roll-call/roll-call-tab/roll-call-tab.component.ts

PositionState

These position states are used internally as animation states for the tab body. Setting the position state to left, right, or center will transition the tab body from its current position to its respective state. If there is no current position (void, in the case of a new tab body), then there will be no transition animation to its state.

In the case of a new tab body that should immediately be centered with an animating transition, then left-origin-center or right-origin-center can be used, which will use left or right as its pseudo-prior state.

"left" | "center" | "right"

src/app/features/reporting/report-config.ts

ReportEntity

Union type to enable type safety for report configs. Use this instead of the {@class ReportConfig}

AggregationReport | ExportingReport | SqlReport

src/app/child-dev-project/children/demo-data-generators/aser/skill-levels.ts

SkillLevel

src/app/features/reporting/sql-report/sqs-schema.ts

SqlOptions
literal type
SqlTables
literal type
SqlType
"TEXT" | "INTEGER" | "REAL"

src/app/core/database/pouchdb/synced-pouch-database.ts

SyncResult
PouchDB.Replication.SyncResultComplete<any>

results matching ""

    No results matching ""