Interface AttributeListModel<K, T>

A list object of attributes commonly specified for nodes, subgraphs, and edges under graph and subgraph.

interface AttributeListModel<
    K extends AttributeListKind = AttributeListKind,
    T extends AttributeKey = AttributeKey,
> {
    $$kind: K;
    $$type: "AttributeList";
    comment?: string;
    size: number;
    values: readonly [T, Attribute<T>][];
    apply(attributes: AttributesObject<T> | AttributesEntities<T>): void;
    clear(): void;
    delete(key: T): void;
    get<K extends AttributeKey>(key: K): undefined | Attribute<K>;
    set<K extends AttributeKey>(key: K, value: Attribute<K>): void;
}

Type Parameters

K extends AttributeListKind = AttributeListKind
The type of object is being specified.
T extends AttributeKey = AttributeKey
The attribute keys to set DOT object.

Hierarchy (View Summary)

Attributes<T>
HasComment
DotObjectModel<"AttributeList">
- AttributeListModel

Implemented by

AttributeList

Index

Properties

$$kind $$type comment? size values

Methods

apply clear delete get set

Properties

$$kind

$$kind: K

$$type

$$type: "AttributeList"

The type of the DotObjectType.

`Optional`comment

comment?: string

Comments to include when outputting with toDot.

`Readonly`size

size: number

Size of the set of keys and values held by the DOT object.

`Readonly`values

values: readonly [T, Attribute<T>][]

The key/value tuples of the object attributes.

Methods

apply

apply(attributes: AttributesObject<T> | AttributesEntities<T>): 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
Inherited from Attributes.apply
- Defined in models.ts:198

clear

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

Returns void
Inherited from Attributes.clear
- Defined in models.ts:202

delete

delete(key: T): void
Delete the value of an attribute from a DOT object by specifying a key.
Parameters
- key: T
Returns void
Inherited from Attributes.delete
- Defined in models.ts:200

get

get<K extends AttributeKey>(key: K): 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>
Inherited from Attributes.get
- Defined in models.ts:190

set

set<K extends AttributeKey>(key: K, value: Attribute<K>): 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
Inherited from Attributes.set
- Defined in models.ts:192