OptionalasThe first Matter specification in which this element appears.
OptionalclassificationEncodes both classification and scope from the Matter specification.
OptionaldescriptionA short summary of the element.
OptionaldetailsA paragraph summary of the element.
OptionalerrorsThe ID of the element per Matter specification, either global or context-specific. A "machine appropriate" semantic differentiator.
OptionalisIs this a "seed" element? These are global types and cluster elements defined in the core specification, without which we are fairly incapacitated.
OptionalisIndicates that an element defines a datatype.
Indicates that an element may have type definitions as children.
The key used for storing this element. A "human appropriate" semantic differentiator.
OptionaloperationalOptionalpicsThe cluster's PICS code.
OptionaltypeIf an element derives from another element, the name of the parent element goes here.
OptionaluntilThe Matter specification revision in which this element was removed.
OptionalxrefReference to Matter specification document.
StaticTagStatictypesFactory support. Populated by derivatives upon definition.
Get attributes, commands and events whether inherited or defined directly in this model.
The set of tags from which this model may derive.
Get a model for my base type as defined by type, if any.
Obtain a discriminator that differentiates different models with the same name
Allows subclasses to pull a working ID from an alternate source.
In some circumstances the base type can be inferred. This inference happens here.
Does not recurse so only returns the direct base type.
A local or parent xref.
Get the first global base type. This may have semantic meaning more specific than the base primitive type.
Determine if this model resides in the global namespace.
Get a string that uniquely identifies this model. This is normally the effective ID but some models require a generated identifier.
The structural parent. This is the model for the element that contains this element's definition.
The path ("." delimited) in the Matter tree.
This is informational and generally tries to adhere to JS API conventions.
Other qualities.
Quality flags allowed for clusters are "I" (singleton) and "K" (diagnostics). The spec as of 1.3 does not appear to use the singleton flag, however.
Other qualities.
Quality flags allowed for clusters are "I" (singleton) and "K" (diagnostics). The spec as of 1.3 does not appear to use the singleton flag, however.
Get shadow model, if any. A "shadow" is an element in my parent's inheritance hierarchy that I override.
Did validation find errors?
Create an operational extension of the model. This creates a new model that inherits from this model for operational purposes.
Optionalproperties: Partial<Omit<ClusterElement, "tag"> & Partial<Pick<ClusterElement, "tag">>>Freeze the model hierarchy rooted at this model.
When using a model as operational schema we implement various optimizations that assume the schema is immutable. This function enforces that assumption.
To make changes to a frozen model use clone.
Retrieve a specific child by ID or name.
Does this model derive from another?
Search the inheritance chain for a child property.
OptionalallowedTags: ElementTag[]Retrieve a model of a specific type from the ownership hierarchy.
Find all children that reference a specific type.
Convert model to JSON.
Convert to non-class structure.
Apply a function to all tree elements.
StaticcreateCreate a model for an element.
A cluster describes a set of related functionality.