Class AttributesGroup<T>

A set of attribute values for any object.

Type Parameters

T extends AttributeKey = AttributeKey

Hierarchy (view full)

AttributesBase<T>
- AttributesGroup

Implements

AttributesGroupModel<T>

Index

Constructors

Properties

Accessors

Methods

apply clear delete get set

Constructors

constructor

new AttributesGroup<T>(attributes?): AttributesGroup<T>
Type Parameters
- T extends AttributeKey = AttributeKey
Parameters
- Optional attributes: AttributesObject<T>
Returns AttributesGroup<T>
Inherited from AttributesBase.constructor
- Defined in AttributesBase.ts:21

Properties

`Optional` comment

comment?: string

Comments to include when outputting with toDot.

Accessors

size

get size(): number
Size of the set of keys and values held by the DOT object.

Returns number
Implementation of AttributesGroupModel.size
Inherited from AttributesBase.size
- Defined in AttributesBase.ts:32

values

get values(): readonly [T, Attribute<T>][]
The key/value tuples of the object attributes.

Returns readonly [T, Attribute<T>][]
Implementation of AttributesGroupModel.values
Inherited from AttributesBase.values
- Defined in AttributesBase.ts:28

Methods

apply

apply(attributes): void
Apply keys and values that can be specified for DOT objects collectively.
Parameters
- attributes: AttributesObject<T> | AttributesEntities<T>
  An array of objects or tuples of attribute key/value pairs.
Returns void
Implementation of AttributesGroupModel.apply
Inherited from AttributesBase.apply
- Defined in AttributesBase.ts:50

clear

clear(): void
Delete all attributes specified for the DOT object.

Returns void
Implementation of AttributesGroupModel.clear
Inherited from AttributesBase.clear
- Defined in AttributesBase.ts:59

delete

delete(key): void
Delete the value of an attribute from a DOT object by specifying a key.
Parameters
- key: T
Returns void
Implementation of AttributesGroupModel.delete
Inherited from AttributesBase.delete
- Defined in AttributesBase.ts:46

get

get<K>(key): undefined | Attribute<K>
Get the value of an attribute by a DOT object by specifying its key.

If the value corresponding to the key does not exist, undefined is returned.
Type Parameters
- K extends AttributeKey
Parameters
- key: K
Returns undefined | Attribute<K>
Implementation of AttributesGroupModel.get
Inherited from AttributesBase.get
- Defined in AttributesBase.ts:36

set

set<K>(key, value): void
Set a value, by specifying the key of the attributes in the DOT object.
Type Parameters
- K extends AttributeKey
Parameters
- key: K
- value: Attribute<K>
Returns void
Implementation of AttributesGroupModel.set
Inherited from AttributesBase.set
- Defined in AttributesBase.ts:40

Generated using TypeDoc