Interface IZMetadata

The class type of the metadata.

This is useful for icons where you need to specify which set the icon value comes from.

For example, if the value is refresh, then this value can be font-awesome to specify usage of the refresh icon from the font-awesome set.

The actual class usage is determined by the one using the metadata.

An explanation of what the field is for.

This can act like a comment. Those looking at the metadata can use this to get a better idea of what the value represents.

Whether or not this metadata can be edited.

The default value that should be used for null or undefined representations of this value.

The expected format.

The usage of this depends on the type. For example, for date fields, this can be something such as 'L LT' and for numbers this can be something such as 'currency' or 'percentage'.

The height represented as a string.

Useful for things like icons and images.

This allows for pseudo sizes such as xs, sm, lg, etc, as well as css values such as 24px, 2rem, etc.

The usage of this depends on the developer using it.

The id.

This can be a guid or a human readable value. The most important feature is that this must be unique across a collection of metadata.

Human readable name of the field data.

The field path into the entity that targets the value.

Decimal precision.

Useful for numbers.

Whether or not this metadata can be sorted.

The metadata type.

The width represented as a string.

Useful for things like icons and images.

This allows for pseudo sizes such as xs, sm, lg, etc, as well as css values such as 24px, 2rem, etc.

The usage of this depends on the developer using it.