Edit

Share via

getRelationship (Client API reference)

  • Article

Gets information about the relationship used to filter the subgrid.

Grid types supported

Read-only and editable grids

Syntax

gridContext.getRelationship();

Return Value

Type: Object.

Description: A relationship object with the following:

  • attributeName: String. Name of the column.
  • name: String. Name of the relationship.
  • navigationPropertyName: String. Name of the navigation property for this relationship.
  • relationshipType: Number. Returns one of the following values to indicate the relationship type:
    • 0: OneToMany
    • 1: ManyToMany
  • roleType: Number. Returns one of the following values to indicate the role type of relationship:
    • 1: Referencing
    • 2: AssociationEntity

Remarks

To get the gridContext, see Getting the grid context.

openRelatedGrid