API Reference › ecschema-Metadata › Metadata › PrimitiveProperty

PrimitiveProperty Class

Extends

Methods

Name Description
constructor(ecClass: ECClass, name: string, primitiveType: PrimitiveType = PrimitiveType.Integer): PrimitiveProperty    
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
addCustomAttribute(customAttribute: CustomAttribute): void Protected PrimitiveOrEnumPropertyBase  
getCategorySync(): undefined | PropertyCategory PrimitiveOrEnumPropertyBase  
getCustomAttributes(): Promise<> PrimitiveOrEnumPropertyBase Retrieve all custom attributes in the current property and its base
getCustomAttributesSync(): PrimitiveOrEnumPropertyBase Retrieve all custom attributes in the current property and its base.
getKindOfQuantitySync(): undefined | KindOfQuantity PrimitiveOrEnumPropertyBase  
isArray(): this is AnyArrayProperty PrimitiveOrEnumPropertyBase  
isEnumeration(): this is AnyEnumerationProperty PrimitiveOrEnumPropertyBase  
isNavigation(): this is NavigationProperty PrimitiveOrEnumPropertyBase  
isPrimitive(): this is AnyPrimitiveProperty PrimitiveOrEnumPropertyBase  
isStruct(): this is AnyStructProperty PrimitiveOrEnumPropertyBase  
setName(name: ECName): void Protected PrimitiveOrEnumPropertyBase  

Properties

Name Type Description
primitiveType Accessor ReadOnly PrimitiveType    

Inherited properties

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

Defined in

Last Updated: 16 April, 2024