Class Metadata<T>

Struct for describing a region's metadata.

Type parameters: T - The type of this region's layout properties

Type parameters

T: IDashboardLayoutProperties

Hierarchy

Metadata

Index

Constructors

constructor

Properties

Methods

Object literals

defaultData

Constructors

constructor

new Metadata(__namedParameters: object): Metadata

- Defined in DashboardLayoutRegion.ts:830
Parameters
- __namedParameters: object
Returns Metadata

Properties

description

description: string = ""

iconClass

iconClass: string

iconText

iconText: string

name

name: string = ""

remarks

remarks: string = ""

Methods

addMetadata

addMetadata<K>(propertyName: K, metadata: Partial<IPropertyMetadata<T[K]>>): void

- Defined in DashboardLayoutRegion.ts:839
Type parameters
- K: keyof T
Parameters
- propertyName: K
- metadata: Partial<IPropertyMetadata<T[K]>>
Returns void

getAllProperties

getAllProperties(): IterableIterator<[keyof T, IPropertyMetadata<T[keyof T]>]>

- Defined in DashboardLayoutRegion.ts:857
Returns IterableIterator<[keyof T, IPropertyMetadata<T[keyof T]>]>

getMetadata

getMetadata<K>(propertyName: K): undefined | IPropertyMetadata<T[keyof T]>

- Defined in DashboardLayoutRegion.ts:851
Type parameters
- K: keyof T
Parameters
- propertyName: K
Returns undefined | IPropertyMetadata<T[keyof T]>

Object literals

Static Protected defaultData

defaultData: object

default

default: null = null

documentation

documentation: string = ""

type

type: Type = Types.Any

Generated using TypeDoc