API Reference › ecschema-Metadata› Metadata › StructArrayProperty

StructArrayProperty Class @preview

Extends

Inherited methods

Name Inherited from Description
fromJSON(structPropertyProps: StructPropertyProps): Promise<void> Inherited ArrayPropertyMixin(StructProperty)  
fromJSON(propertyProps: PropertyProps): Promise<void> Inherited ArrayPropertyMixin(StructProperty)  
fromJSONSync(structPropertyProps: StructPropertyProps): void Inherited ArrayPropertyMixin(StructProperty)  
fromJSONSync(propertyProps: PropertyProps): void Inherited ArrayPropertyMixin(StructProperty)  
getCategorySync(): undefined | PropertyCategory Inherited ArrayPropertyMixin(StructProperty)  
getCustomAttributes(): Promise<CustomAttributeSet> Inherited ArrayPropertyMixin(StructProperty) Retrieve all custom attributes in the current property and its base
getCustomAttributesSync(): CustomAttributeSet Inherited ArrayPropertyMixin(StructProperty) Retrieve all custom attributes in the current property and its base.
getKindOfQuantitySync(): undefined | KindOfQuantity Inherited ArrayPropertyMixin(StructProperty)  
isArray(): this is AnyArrayProperty Inherited ArrayPropertyMixin(StructProperty)  
isEnumeration(): this is AnyEnumerationProperty Inherited ArrayPropertyMixin(StructProperty)  
isNavigation(): this is NavigationProperty Inherited ArrayPropertyMixin(StructProperty)  
isPrimitive(): this is AnyPrimitiveProperty Inherited ArrayPropertyMixin(StructProperty)  
isStruct(): this is AnyStructProperty Inherited ArrayPropertyMixin(StructProperty)  
toJSON(): StructPropertyProps Inherited ArrayPropertyMixin(StructProperty)  
toJSON(): PropertyProps Inherited ArrayPropertyMixin(StructProperty) Save this Property's properties to an object for serializing to JSON.

Inherited properties

Name Type Inherited from Description
category Accessor Inherited ReadOnly undefined | LazyLoadedPropertyCategory ArrayPropertyMixin(StructProperty)  
class Accessor Inherited ReadOnly AnyClass ArrayPropertyMixin(StructProperty)  
customAttributes Accessor Inherited ReadOnly undefined | CustomAttributeSet ArrayPropertyMixin(StructProperty)  
description Accessor Inherited ReadOnly undefined | string ArrayPropertyMixin(StructProperty)  
fullName Accessor Inherited ReadOnly string ArrayPropertyMixin(StructProperty) Returns the name in the format 'ClassName.PropertyName'.
isReadOnly Accessor Inherited ReadOnly boolean ArrayPropertyMixin(StructProperty)  
kindOfQuantity Accessor Inherited ReadOnly undefined | LazyLoadedKindOfQuantity ArrayPropertyMixin(StructProperty)  
label Accessor Inherited ReadOnly undefined | string ArrayPropertyMixin(StructProperty)  
maxOccurs Accessor Inherited ReadOnly undefined | number ArrayPropertyMixin(StructProperty)  
minOccurs Accessor Inherited ReadOnly number ArrayPropertyMixin(StructProperty)  
name Accessor Inherited ReadOnly string ArrayPropertyMixin(StructProperty)  
priority Accessor Inherited ReadOnly number ArrayPropertyMixin(StructProperty)  
propertyType Accessor Inherited ReadOnly PropertyType ArrayPropertyMixin(StructProperty)  
schema Accessor Inherited ReadOnly Schema ArrayPropertyMixin(StructProperty) Returns the schema of the class holding the property.
structClass Accessor Inherited ReadOnly StructClass ArrayPropertyMixin(StructProperty)  

Defined in

Last Updated: 28 October, 2025