API Reference › ecschema-Metadata› Metadata › PrimitiveProperty

PrimitiveProperty Class @preview

Extends

Methods

Name Description
fromJSON(primitivePropertyProps: PrimitivePropertyProps): Promise<void>    
fromJSONSync(primitivePropertyProps: PrimitivePropertyProps): void    
toJSON(): PrimitivePropertyProps Save this PrimitiveProperty's properties to an object for serializing to JSON.  

Inherited methods

Name Inherited from Description
getCategorySync(): PropertyCategory | undefined Inherited PrimitiveOrEnumPropertyBase  
getCustomAttributes(): Promise<CustomAttributeSet> Inherited PrimitiveOrEnumPropertyBase Retrieve all custom attributes in the current property and its base
getCustomAttributesSync(): CustomAttributeSet Inherited PrimitiveOrEnumPropertyBase Retrieve all custom attributes in the current property and its base.
getKindOfQuantitySync(): KindOfQuantity | undefined Inherited PrimitiveOrEnumPropertyBase  
isArray(): this is AnyArrayProperty Inherited PrimitiveOrEnumPropertyBase  
isEnumeration(): this is AnyEnumerationProperty Inherited PrimitiveOrEnumPropertyBase  
isNavigation(): this is NavigationProperty Inherited PrimitiveOrEnumPropertyBase  
isPrimitive(): this is AnyPrimitiveProperty Inherited PrimitiveOrEnumPropertyBase  
isStruct(): this is AnyStructProperty Inherited PrimitiveOrEnumPropertyBase  

Properties

Name Type Description
primitiveType Accessor ReadOnly PrimitiveType    

Inherited properties

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

Defined in

Last Updated: 28 April, 2026