Skip to main content

Class: SharedPropertyObject

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:95

Represents a shared object that extends the PropertyObject class.

Extends​

Constructors​

Constructor​

new SharedPropertyObject(type, id?, value?, refs?): SharedPropertyObject

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:98

Parameters​

type​

string

id?​

string

value?​

any = {}

refs?​

string[] = []

Returns​

SharedPropertyObject

Overrides​

PropertyObject.constructor

Properties​

id​

id: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:14

Inherited from​

PropertyObject.id

refs​

refs: string[]

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:16

Inherited from​

PropertyObject.refs

type​

type: string

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:96

value​

value: object

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:15

Index Signature​

[key: string]: any

Inherited from​

PropertyObject.value

Methods​

getId()​

getId(): string

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:35

Retrieves the unique identifier of the project object.

Returns​

string

The unique identifier of the project object.

Inherited from​

PropertyObject.getId

getReferences()​

getReferences(): string[]

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:53

Retrieves the list of the references that the object holds.

Returns​

string[]

An array of reference strings.

Inherited from​

PropertyObject.getReferences

getType()​

getType(): string

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:108

Retrieves the type of the shared object.

Returns​

string

The type of the shared object.

getValues()​

getValues(): object

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:44

Retrieves the current values stored in the PropertyObject.

Returns​

object

An object where the keys are strings and the values can be of any type.

Inherited from​

PropertyObject.getValues

isEmpty()​

isEmpty(): boolean

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:75

Returns​

boolean

Inherited from​

PropertyObject.isEmpty

pushReference()​

pushReference(ref): void

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:71

Adds a reference string to the list of references.

Parameters​

ref​

string

The reference string to be added.

Returns​

void

Inherited from​

PropertyObject.pushReference

setReferences()​

setReferences(refs): void

Defined in: src/common/web/ui/components/propertyeditor/PropertyObjectStore.ts:62

Sets the references for the project object.

Parameters​

refs​

string[]

An array of reference strings to be set.

Returns​

void

Inherited from​

PropertyObject.setReferences