API Reference > ecschema-Metadata > Metadata > StructArrayProperty

StructArrayProperty Class

Beta  

Extends

Methods

Name Description
constructor(ecClass: ECClass, name: string, type: StructClass): StructArrayProperty    

Inherited methods

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

Inherited properties

Name Type Inherited from Description
_category Protected undefined | LazyLoadedPropertyCategory ArrayPropertyMixin(StructProperty)  
_class Protected AnyClass ArrayPropertyMixin(StructProperty)  
_description Protected undefined | string ArrayPropertyMixin(StructProperty)  
_isReadOnly Protected undefined | boolean ArrayPropertyMixin(StructProperty)  
_kindOfQuantity Protected undefined | LazyLoadedKindOfQuantity ArrayPropertyMixin(StructProperty)  
_label Protected undefined | string ArrayPropertyMixin(StructProperty)  
_maxOccurs Protected undefined | number ArrayPropertyMixin(StructProperty)  
_minOccurs Protected number ArrayPropertyMixin(StructProperty)  
_name Protected ECName ArrayPropertyMixin(StructProperty)  
_priority Protected undefined | number ArrayPropertyMixin(StructProperty)  
_structClass Protected StructClass ArrayPropertyMixin(StructProperty)  
_type Protected PropertyType ArrayPropertyMixin(StructProperty)  
category Accessor ReadOnly undefined | LazyLoadedPropertyCategory ArrayPropertyMixin(StructProperty)  
class Accessor ReadOnly AnyClass ArrayPropertyMixin(StructProperty)  
customAttributes Accessor ReadOnly undefined | ArrayPropertyMixin(StructProperty)  
description Accessor ReadOnly undefined | string ArrayPropertyMixin(StructProperty)  
fullName Accessor ReadOnly string ArrayPropertyMixin(StructProperty) Returns the name in the format 'ClassName.PropertyName'.
isReadOnly Accessor ReadOnly boolean ArrayPropertyMixin(StructProperty)  
kindOfQuantity Accessor ReadOnly undefined | LazyLoadedKindOfQuantity ArrayPropertyMixin(StructProperty)  
label Accessor ReadOnly undefined | string ArrayPropertyMixin(StructProperty)  
maxOccurs Accessor ReadOnly undefined | number ArrayPropertyMixin(StructProperty)  
minOccurs Accessor ReadOnly number ArrayPropertyMixin(StructProperty)  
name Accessor ReadOnly string ArrayPropertyMixin(StructProperty)  
priority Accessor ReadOnly number ArrayPropertyMixin(StructProperty)  
propertyType Accessor ReadOnly PropertyType ArrayPropertyMixin(StructProperty)  
schema Accessor ReadOnly Schema ArrayPropertyMixin(StructProperty) Returns the schema of the class holding the property.
structClass Accessor ReadOnly StructClass ArrayPropertyMixin(StructProperty)  

Defined in

Last Updated: 30 November, 2023