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

SchemaView.NavigationProperty Class @beta

A navigation property. relationshipClass is non-nullable - the binary parser drops properties whose relationship class can't be resolved.

Extends

Inherited methods

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

Properties

Name Type Description
direction Accessor ReadOnly StrengthDirection    
relationshipClass Accessor ReadOnly SchemaView.RelationshipClass    

Inherited properties

Name Type Inherited from Description
_ctx Protected Readonly Inherited SchemaView SchemaView.Property  
category Accessor Inherited ReadOnly SchemaView.PropertyCategory | undefined SchemaView.Property Property category, or undefined if none assigned. Available on all property kinds.
declaringClass Accessor Inherited ReadOnly SchemaView.Class | undefined SchemaView.Property The class that declared or contributed this property through inheritance.
For own properties, returns the class itself. For inherited properties, returns the
base class or mixin that introduced it. Returns undefined for view properties.
This is the class array index, not the ec_Class.Id from the database.
description Accessor Inherited ReadOnly string SchemaView.Property  
ecInstanceId Accessor Inherited ReadOnly number SchemaView.Property Row ID from ec_Property. Matches ECInstanceId in ECDbMeta views, e.g.
SELECT * FROM meta.ECPropertyDef WHERE ECInstanceId = ?.

Stored per-reference (not per-definition) because each class-property pair has a unique
ec_Property row even when the structural definition is deduplicated.
isHidden Accessor Inherited ReadOnly boolean SchemaView.Property Reflects the HiddenProperty custom attribute from CoreCustomAttributes.
Properties marked hidden are typically excluded from UI display but remain accessible programmatically.
isReadOnly Accessor Inherited ReadOnly boolean SchemaView.Property  
kind Accessor Inherited ReadOnly PropertyKind SchemaView.Property  
label Accessor Inherited ReadOnly string SchemaView.Property Display label. Falls back to the property name if no explicit label is set.
Labels are stored per-reference (not per-definition) because EC allows class overrides.
name Accessor Inherited ReadOnly string SchemaView.Property  
priority Accessor Inherited ReadOnly number SchemaView.Property Display priority. Higher values should be displayed more prominently. 0 means default.

Defined in

Last Updated: 27 May, 2026