Class: ProfileClass

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:223

Represents a profile with various properties and inputs.

Extended by

• ProfileLayoutClass

Constructors

Constructor

new ProfileClass(id, displayLabel, description?, labelTemplate?, required?, multiple?, example?, refs?, input?): ProfileClass

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:240

Parameters

id

string

displayLabel

string

description?

string

labelTemplate?

string

required?

boolean

multiple?

boolean

example?

string

refs?

ProfileClassRef[] = []

input?

ProfileClassInput[] = []

Returns

ProfileClass

Properties

description?

readonly optional description: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:226

---

displayLabel

readonly displayLabel: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:225

---

example?

readonly optional example: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:230

---

id

readonly id: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:224

---

input

readonly input: ProfileClassInput[]

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:238

---

labelTemplate?

readonly optional labelTemplate: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:227

---

multiple?

readonly optional multiple: boolean

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:229

---

refs

readonly refs: ProfileClassRef[]

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:234

---

required?

optional required: boolean

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:228

Methods

getDescription()

getDescription(): undefined | string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:303

Retrieves the description of the property class.

Returns

undefined | string

The description of the property class.

---

getDisplayLabel()

getDisplayLabel(): string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:294

Retrieves the displayLabel of the ProfileClass.

Returns

string

The displayLabel of the ProfileClass.

---

getExample()

getExample(): undefined | string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:312

Retrieves an example for the property class.

Returns

undefined | string

The current value of the example class.

---

getId()

getId(): string

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:285

Retrieves the unique identifier of the ProfileClass.

Returns

string

The unique identifier of the ProfileClass.

---

getInputs()

getInputs(): ProfileClassInput[]

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:267

Retrieves the inputs of the ProfileClass.

Returns

ProfileClassInput[]

The input property.

---

getRefTypes()

getRefTypes(): ProfileClassRef[]

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:276

Retrieves the types that the ProfileClass can reference.

Returns

ProfileClassRef[]

The types of the ProfileClass.

---

isRequired()

isRequired(): undefined | boolean

Defined in: src/common/web/ui/components/propertyeditor/PropertyProfile.ts:321

Checks if the property is required.

Returns

undefined | boolean

True if the property is required, otherwise false.