API Reference › ecschema-Metadata› Metadata › PrimitiveOrEnumPropertyBase

PrimitiveOrEnumPropertyBase Class

Extends

Extended by

Methods

Name Description
constructor(ecClass: ECClass, name: string, type: PropertyType): PrimitiveOrEnumPropertyBase    
fromJSON(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): Promise<void>    
fromJSONSync(propertyBaseProps: PrimitiveOrEnumPropertyBaseProps): void    
toJSON(): PrimitiveOrEnumPropertyBaseProps Save this PrimitiveOrEnumPropertyBase's properties to an object for serializing to JSON.  

Inherited methods

Name Inherited from Description
addCustomAttribute(customAttribute: CustomAttribute): void Protected Property  
getCategorySync(): undefined | PropertyCategory Property  
getCustomAttributes(): Promise<> Property Retrieve all custom attributes in the current property and its base
getCustomAttributesSync(): Property Retrieve all custom attributes in the current property and its base.
getKindOfQuantitySync(): undefined | KindOfQuantity Property  
isArray(): this is AnyArrayProperty Property  
isEnumeration(): this is AnyEnumerationProperty Property  
isNavigation(): this is NavigationProperty Property  
isPrimitive(): this is AnyPrimitiveProperty Property  
isStruct(): this is AnyStructProperty Property  
setName(name: ECName): void Protected Property  

Properties

Name Type Description
_extendedTypeName Protected string | undefined    
_maxLength Protected number | undefined    
_maxValue Protected number | undefined    
_minLength Protected number | undefined    
_minValue Protected number | undefined    
extendedTypeName Accessor ReadOnly undefined | string    
maxLength Accessor ReadOnly undefined | number    
maxValue Accessor ReadOnly undefined | number    
minLength Accessor ReadOnly undefined | number    
minValue Accessor ReadOnly undefined | number    

Inherited properties

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

Defined in

Last Updated: 13 May, 2024