API Reference > ecschema-Metadata > Metadata > PrimitiveArrayProperty

PrimitiveArrayProperty Class

Beta  

Extends

Methods

Name Description
constructor(ecClass: ECClass, name: string, primitiveType: PrimitiveType = PrimitiveType.Integer): PrimitiveArrayProperty    
toJSON(): PrimitiveArrayPropertyProps Save this PrimitiveArrayProperty's properties to an object for serializing to JSON.  

Inherited methods

Name Inherited from Description
addCustomAttribute(customAttribute: CustomAttribute): void Protected ArrayPropertyMixin(PrimitiveProperty)  
fromJSON(primitivePropertyProps: PrimitivePropertyProps): Promise<void> ArrayPropertyMixin(PrimitiveProperty)  
fromJSON(propertyProps: PropertyProps): Promise<void> ArrayPropertyMixin(PrimitiveProperty)  
fromJSONSync(primitivePropertyProps: PrimitivePropertyProps): void ArrayPropertyMixin(PrimitiveProperty)  
fromJSONSync(propertyProps: PropertyProps): void ArrayPropertyMixin(PrimitiveProperty)  
getCategorySync(): undefined | PropertyCategory ArrayPropertyMixin(PrimitiveProperty)  
getCustomAttributes(): Promise<> ArrayPropertyMixin(PrimitiveProperty) Retrieve all custom attributes in the current property and its base
getCustomAttributesSync(): ArrayPropertyMixin(PrimitiveProperty) Retrieve all custom attributes in the current property and its base.
getKindOfQuantitySync(): undefined | KindOfQuantity ArrayPropertyMixin(PrimitiveProperty)  
isArray(): this is AnyArrayProperty ArrayPropertyMixin(PrimitiveProperty)  
isEnumeration(): this is AnyEnumerationProperty ArrayPropertyMixin(PrimitiveProperty)  
isNavigation(): this is NavigationProperty ArrayPropertyMixin(PrimitiveProperty)  
isPrimitive(): this is AnyPrimitiveProperty ArrayPropertyMixin(PrimitiveProperty)  
isStruct(): this is AnyStructProperty ArrayPropertyMixin(PrimitiveProperty)  

Inherited properties

Name Type Inherited from Description
_category Protected undefined | LazyLoadedPropertyCategory ArrayPropertyMixin(PrimitiveProperty)  
_class Protected AnyClass ArrayPropertyMixin(PrimitiveProperty)  
_description Protected undefined | string ArrayPropertyMixin(PrimitiveProperty)  
_extendedTypeName Protected undefined | string ArrayPropertyMixin(PrimitiveProperty)  
_isReadOnly Protected undefined | boolean ArrayPropertyMixin(PrimitiveProperty)  
_kindOfQuantity Protected undefined | LazyLoadedKindOfQuantity ArrayPropertyMixin(PrimitiveProperty)  
_label Protected undefined | string ArrayPropertyMixin(PrimitiveProperty)  
_maxLength Protected undefined | number ArrayPropertyMixin(PrimitiveProperty)  
_maxOccurs Protected undefined | number ArrayPropertyMixin(PrimitiveProperty)  
_maxValue Protected undefined | number ArrayPropertyMixin(PrimitiveProperty)  
_minLength Protected undefined | number ArrayPropertyMixin(PrimitiveProperty)  
_minOccurs Protected number ArrayPropertyMixin(PrimitiveProperty)  
_minValue Protected undefined | number ArrayPropertyMixin(PrimitiveProperty)  
_name Protected ECName ArrayPropertyMixin(PrimitiveProperty)  
_priority Protected undefined | number ArrayPropertyMixin(PrimitiveProperty)  
_type Protected PropertyType ArrayPropertyMixin(PrimitiveProperty)  
category Accessor ReadOnly undefined | LazyLoadedPropertyCategory ArrayPropertyMixin(PrimitiveProperty)  
class Accessor ReadOnly AnyClass ArrayPropertyMixin(PrimitiveProperty)  
customAttributes Accessor ReadOnly undefined | ArrayPropertyMixin(PrimitiveProperty)  
description Accessor ReadOnly undefined | string ArrayPropertyMixin(PrimitiveProperty)  
extendedTypeName Accessor ReadOnly undefined | string ArrayPropertyMixin(PrimitiveProperty)  
fullName Accessor ReadOnly string ArrayPropertyMixin(PrimitiveProperty) Returns the name in the format 'ClassName.PropertyName'.
isReadOnly Accessor ReadOnly boolean ArrayPropertyMixin(PrimitiveProperty)  
kindOfQuantity Accessor ReadOnly undefined | LazyLoadedKindOfQuantity ArrayPropertyMixin(PrimitiveProperty)  
label Accessor ReadOnly undefined | string ArrayPropertyMixin(PrimitiveProperty)  
maxLength Accessor ReadOnly undefined | number ArrayPropertyMixin(PrimitiveProperty)  
maxOccurs Accessor ReadOnly undefined | number ArrayPropertyMixin(PrimitiveProperty)  
maxValue Accessor ReadOnly undefined | number ArrayPropertyMixin(PrimitiveProperty)  
minLength Accessor ReadOnly undefined | number ArrayPropertyMixin(PrimitiveProperty)  
minOccurs Accessor ReadOnly number ArrayPropertyMixin(PrimitiveProperty)  
minValue Accessor ReadOnly undefined | number ArrayPropertyMixin(PrimitiveProperty)  
name Accessor ReadOnly string ArrayPropertyMixin(PrimitiveProperty)  
primitiveType Accessor ReadOnly PrimitiveType ArrayPropertyMixin(PrimitiveProperty)  
priority Accessor ReadOnly number ArrayPropertyMixin(PrimitiveProperty)  
propertyType Accessor ReadOnly PropertyType ArrayPropertyMixin(PrimitiveProperty)  
schema Accessor ReadOnly Schema ArrayPropertyMixin(PrimitiveProperty) Returns the schema of the class holding the property.

Defined in

Last Updated: 30 November, 2023