API Reference › ecSchema-metadata› Schema › SchemaView › SchemaView.Property

SchemaView.Property Class @beta

Lightweight view over a property in a SchemaView. Subclasses provide type-safe access to kind-specific fields. Use isPrimitive(), isStruct(), isArray(), or isNavigation() to narrow, or the corresponding assert*() methods.

Extended by

Methods

Name Description
assertArray(): this is SchemaView.AnyArrayProperty    
assertNavigation(): this is SchemaView.NavigationProperty    
assertPrimitive(): this is SchemaView.AnyPrimitiveProperty    
assertStruct(): this is SchemaView.AnyStructProperty    
isArray(): this is SchemaView.AnyArrayProperty True for SchemaView.PrimitiveArrayProperty and SchemaView.StructArrayProperty.  
isEnumeration(): this is SchemaView.AnyPrimitiveProperty True if this property is backed by an enumeration.  
isNavigation(): this is SchemaView.NavigationProperty True for SchemaView.NavigationProperty.  
isPrimitive(): this is SchemaView.AnyPrimitiveProperty True for SchemaView.PrimitiveProperty and SchemaView.PrimitiveArrayProperty.  
isStruct(): this is SchemaView.AnyStructProperty True for SchemaView.StructProperty and SchemaView.StructArrayProperty.  

Properties

Name Type Description
_ctx Protected Readonly SchemaView    
category Accessor ReadOnly SchemaView.PropertyCategory | undefined Property category, or undefined if none assigned.  
declaringClass Accessor ReadOnly SchemaView.Class | undefined The class that declared or contributed this property through inheritance.  
description Accessor ReadOnly string    
ecInstanceId Accessor ReadOnly number Row ID from ec_Property.  
isHidden Accessor ReadOnly boolean Reflects the HiddenProperty custom attribute from CoreCustomAttributes.  
isReadOnly Accessor ReadOnly boolean    
kind Accessor ReadOnly PropertyKind    
label Accessor ReadOnly string Display label.  
name Accessor ReadOnly string    
priority Accessor ReadOnly number Display priority.  

Defined in

Last Updated: 27 May, 2026