Class MatterModel

OptionalasOf

Optionaldescription

Optionaldetails

Optionalerrors

Optionalid

OptionalisSeed

OptionalisType

name

OptionaloperationalBase

Optionaltype

Optionaluntil

Optionalxref

Statictypes

allowedBaseTags

• get allowedBaseTags(): ElementTag[]

• The set of tags from which this model may derive.

  Returns ElementTag[]

base

• get base(): undefined | Model<BaseElement>

• Get a model for my base type as defined by type, if any.

  Returns undefined | Model<BaseElement>

discriminator

• get discriminator(): undefined | string

• Obtain a discriminator that differentiates different models with the same name

  Returns undefined | string

effectiveId

• get effectiveId(): undefined | number

• Allows subclasses to pull a working ID from an alternate source.

  Returns undefined | number

effectiveType

• get effectiveType(): undefined | string

• In some circumstances the base type can be inferred. This inference happens here.

  Does not recurse so only returns the direct base type.

  Returns undefined | string

effectiveXref

• get effectiveXref(): undefined | CrossReference

• A local or parent xref.

  Returns undefined | CrossReference

globalBase

• get globalBase(): undefined | Model<BaseElement>

• Get the first global base type. This may have semantic meaning more specific than the base primitive type.

  Returns undefined | Model<BaseElement>

isGlobal

• get isGlobal(): boolean

• Determine if this model resides in the global namespace.

  Returns boolean

key

• get key(): undefined | string

• Get a string that uniquely identifies this model. This is normally the effective ID but some models require a generated identifier.

  Returns undefined | string

parent

• get parent(): undefined | Model<BaseElement>

• The structural parent. This is the model for the element that contains this element's definition.

  Returns undefined | Model<BaseElement>
• set parent(parent): void

• Parameters

  • parent: undefined | Model<BaseElement>

  Returns void

path

• get path(): string

• The path ("." delimited) in the Matter tree.

  This is informational and generally tries to adhere to JS API conventions.

  Returns string

shadow

• get shadow(): undefined | Model<BaseElement>

• Get shadow model, if any. A "shadow" is an element in my parent's inheritance hierarchy that I override.

  Returns undefined | Model<BaseElement>

valid

• get valid(): boolean

• Did validation find errors?

  Returns boolean

[inspect]

• [inspect](_depth, options, inspect): string

• Parameters

  • _depth: any
  • options: any
  • inspect: any

  Returns string

all

• all<T>(type, key?): T[]

• Retrieve all models of a specific element type from local scope.

  Type Parameters

  • T extends Model<BaseElement>

  Parameters

  • type: Type<T>

    model class or a predicate object
  • Optionalkey: string | number

    filters to models matching a specific type

  Returns T[]

appliesTo

• appliesTo(revision): boolean

• Determine whether this element applies to a specific revision.

  Parameters

  • revision: `${number}.${number}`

  Returns boolean

clone

• clone<This>(this): This

• Clone the model. This deep copies all descendant child models but not other properties.

  Type Parameters

  • This extends Model<BaseElement>

  Parameters

  • this: This

  Returns This

error

• error(code, message): void

• Record a validation error for this model.

  Parameters

  • code: string
  • message: string

  Returns void

extend

• extend<This>(this, properties?): This

• Create an operational extension of the model. This creates a new model that inherits from this model for operational purposes.

  Type Parameters

  • This extends Model<BaseElement>

  Parameters

  • this: This
  • Optionalproperties: Partial<Omit<MatterElement, "tag"> & Partial<Pick<MatterElement, "tag">>>

  Returns This

freeze

• freeze(): void

• 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.

  Returns void

get

• get<T>(type, key): undefined | T

• Retrieve a specific child by ID or name.

  Type Parameters

  • T extends Model<BaseElement>

  Parameters

  • type: Type<T>
  • key: string | number

  Returns undefined | T

instanceOf

• instanceOf(other): boolean

• Does this model derive from another?

  Parameters

  • other: AnyElement | Model<BaseElement>

  Returns boolean

member

• member(key, allowedTags?): undefined | Model<BaseElement>

• Search the inheritance chain for a child property.

  Parameters

  • key: Selector
  • allowedTags: ElementTag[] = ...

  Returns undefined | Model<BaseElement>

owner

• owner<T>(constructor): undefined | T

• Retrieve a model of a specific type from the ownership hierarchy.

  Type Parameters

  • T extends Model<BaseElement>

  Parameters

  • constructor: Type<T>

  Returns undefined | T

references

• references(type): Model<BaseElement>[]

• Find all children that reference a specific type.

  Parameters

  • type: Model<BaseElement>

  Returns Model<BaseElement>[]

toJSON

• toJSON(): MatterElement

• Convert model to JSON.

  Returns MatterElement

toString

• toString(): string

• Returns string

valueOf

• valueOf(): MatterElement

• Convert to non-class structure.

  Returns MatterElement

visit

• visit(visitor): undefined | boolean

• Apply a function to all tree elements.

  Parameters

  • visitor: ((model: Model<BaseElement>) => boolean | void)
    • • (model): boolean | void

      • Parameters

        • model: Model<BaseElement>

        Returns boolean | void

  Returns undefined | boolean

Staticcreate

• create(definition): Model<BaseElement>

• Create a model for an element.

  Parameters

  • definition: AnyElement

  Returns Model<BaseElement>