API Reference › ecschema-Metadata› Metadata › ArrayProperty

ArrayProperty Class @preview

Extends

Inherited methods

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

Properties

Name Type Description
maxOccurs Accessor ReadOnly number | undefined    
minOccurs Accessor ReadOnly number    

Inherited properties

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

Defined in

Last Updated: 07 May, 2026