Class: ProfileLayoutClass

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

Represents a layout class for profiles, extending the ProfileClass. This class maintains an array of profile IDs.

Extends

• ProfileClass

Constructors

Constructor

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

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

ProfileLayoutClass

Inherited from

ProfileClass.constructor

Properties

description?

readonly optional description: string

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

Inherited from

ProfileClass.description

---

displayLabel

readonly displayLabel: string

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

Inherited from

ProfileClass.displayLabel

---

example?

readonly optional example: string

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

Inherited from

ProfileClass.example

---

id

readonly id: string

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

Inherited from

ProfileClass.id

---

input

readonly input: ProfileClassInput[]

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

Inherited from

ProfileClass.input

---

labelTemplate?

readonly optional labelTemplate: string

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

Inherited from

ProfileClass.labelTemplate

---

multiple?

readonly optional multiple: boolean

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

Inherited from

ProfileClass.multiple

---

profiles

profiles: ProfileID[] = []

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

---

refs

readonly refs: ProfileClassRef[]

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

Inherited from

ProfileClass.refs

---

required?

optional required: boolean

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

Inherited from

ProfileClass.required

Methods

addProfile()

addProfile(profile): void

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

Adds a profile to the profiles array of the ProfileLayoutClass.

Parameters

profile

ProfileID

The profile ID to be added.

Returns

void

---

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.

Inherited from

ProfileClass.getDescription

---

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.

Inherited from

ProfileClass.getDisplayLabel

---

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.

Inherited from

ProfileClass.getExample

---

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.

Inherited from

ProfileClass.getId

---

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.

Inherited from

ProfileClass.getInputs

---

getProfiles()

getProfiles(): ProfileID[]

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

Retrieves the list of profiles.

Returns

ProfileID[]

An array of profiles.

---

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.

Inherited from

ProfileClass.getRefTypes

---

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.

Inherited from

ProfileClass.isRequired