Options
All
  • Public
  • Public/Protected
  • All
Menu

Class soby_DataRepeater

Hierarchy

Index

Constructors

Events

Properties

Methods

Constructors

constructor

  • new soby_DataRepeater(contentDivSelector: string, title: string, dataService: any, emptyDataHtml: string): soby_DataRepeater

  • Represents a webgrid.

    example

    // Creates the grid object let bookDataSourceBuilder = new soby_WSBuilder(); bookDataSourceBuilder.Filters = new SobyFilters(false); bookDataSourceBuilder.AddSchemaField("Id", SobyFieldTypes.Number, null); bookDataSourceBuilder.AddSchemaField("Title", SobyFieldTypes.Text, null); bookDataSourceBuilder.AddSchemaField("Year", SobyFieldTypes.Number, null); bookDataSourceBuilder.AddSchemaField("Price", SobyFieldTypes.Number, null); bookDataSourceBuilder.AddSchemaField("Genre", SobyFieldTypes.Text, null); bookDataSourceBuilder.AddSchemaField("AuthorId", SobyFieldTypes.Lookup, { ModelName: "Author", ValueFieldType: SobyFieldTypes.Number, ValueFieldName: "Id", TitleFieldName: "Name", ReadTransport: new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Authors", "json", "application/json; charset=utf-8", "GET")}); let bookService = new soby_WebServiceService(bookDataSourceBuilder); bookService.Transport.Read = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books", "json", "application/json; charset=utf-8", "GET"); bookService.Transport.Add = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books", "json", "application/json; charset=utf-8", "POST"); bookService.Transport.Update = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books(#key)", "json", "application/json; charset=utf-8", "PUT"); bookService.Transport.Delete = new soby_TransportRequest(soby_GetTutorialWebAPIUrl() + "/Books(#key)", "json", "application/json; charset=utf-8", "DELETE");

    let bookGrid = new soby_WebGrid("#soby_BooksDiv", "Books", bookService, "There is no record found."); bookGrid.AddKeyField("Id"); bookGrid.AddColumn("Title", "Title", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("Year", "Year", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("Price", "Price", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("Genre", "Genre", SobyShowFieldsOn.All, null, null, true, true, true, null); bookGrid.AddColumn("AuthorId", "Author", SobyShowFieldsOn.All, function (item) { return item.Author.Name; }, null, true, true, true, null);

    bookGrid.Initialize(true);

    Parameters

    • contentDivSelector: string

      The author of the book.

    • title: string

      The title of the grid.

    • dataService: any

      The dataservice of the grid.

    • emptyDataHtml: string

      Html content which will be displayed if there is no record.

    Returns soby_DataRepeater

Events

ItemDataBound

ItemDataBound: any = null

Item data bound event.

property

{object} cellID - Identifier of the row.

property

{object} item - Data item related with the row.

OnCellSelected

OnCellSelected: any = null

Cell selection event.

property

{soby_WebGrid} grid - Current grid object.

property

{object} rowID - Identifier of the row.

property

{object} cellIndex - Index of the cell.

OnCellTemplateContentPopulated

OnCellTemplateContentPopulated: any = null

Grid population event.

OnGridDataBeingParsed

OnGridDataBeingParsed: any = null

Grid population event.

OnGridPopulated

OnGridPopulated: any = null

Grid population event.

OnGridPrintBeingStarted

OnGridPrintBeingStarted: any = null

Grid before print event.

OnGridRowPopulated

OnGridRowPopulated: any = null

Grid row population event.

OnItemAdded

OnItemAdded: any = null

Item added event.

property

{object} rowID - Identifier of the row.

property

{object} item - Data item related with the row.

OnItemUpdated

OnItemUpdated: any = null

Item update event.

property

{object} item - Data item related with the row.

OnItemsDeleted

OnItemsDeleted: any = null

Items delete event.

property

{object} items - Data items related with the row.

OnRowSelected

OnRowSelected: any = null

Row selection event.

Properties

ActionPaneButtons

ActionPaneButtons: sobyActionPaneButtons = ...

Active

Active: boolean = false

AggregateFields

AggregateFields: SobyAggregateFields = ...

AllowExportData

AllowExportData: boolean = false

AllowMultipleSelections

AllowMultipleSelections: boolean = true

AltTitle

AltTitle: string = ""

CellAdditionalClassNames

CellAdditionalClassNames: string = ""

CellCount

CellCount: number = 0

CellTagName

CellTagName: string = "td"

Columns

Columns: SobyGridColumn[] = ...

ContentDivSelector

ContentDivSelector: string = ""

DataRelations

DataRelations: any[] = ...

DataService

DataService: soby_ServiceInterface = null

DisplayTitle

DisplayTitle: boolean = true

EmptyDataHtml

EmptyDataHtml: string = ""

FilterControls

FilterControls: any[] = ...

Filters

Filters: SobyFilters = ...

GridID

GridID: string = ""

GroupByFields

GroupByFields: SobyGroupByFields = ...

InitializedActionPaneButtons

InitializedActionPaneButtons: boolean = false

IsAddAllowed

IsAddAllowed: boolean = true

IsDeletable

IsDeletable: boolean = true

IsEditable

IsEditable: boolean = true

IsGroupable

IsGroupable: boolean = false

IsSelectable

IsSelectable: boolean = true

ItemDialogClientID

ItemDialogClientID: string = ""

Items

Items: any = null

KeyFields

KeyFields: SobyKeyFields = ...

LastGroupByValues

LastGroupByValues: any[] = ...

MaxCellCount

MaxCellCount: number = 1

NavigationInformation

NavigationInformation: SobyNavigationInformation = ...

OrderByFields

OrderByFields: SobyOrderByFields = ...

ResponsiveConditions

ResponsiveConditions: sobyResponsiveCondition[] = ...

RowAdditionalClassNames

RowAdditionalClassNames: string = ""

RowDetailDisplayFunction

RowDetailDisplayFunction: (grid: soby_WebGrid, rowId: string, item: any) => string = null

Type declaration

RowDetailDisplayViewResponsiveCondition

RowDetailDisplayViewResponsiveCondition: sobyResponsiveCondition = null

RowTagName

RowTagName: string = "tr"

SVGImages

SVGImages: soby_SVGImages = ...

ShouldContainRowElement

ShouldContainRowElement: boolean = true

ShowHeader

ShowHeader: boolean = true

ShowRefreshButton

ShowRefreshButton: boolean = true

TBodyTagName

TBodyTagName: string = "tbody"

THeadTagName

THeadTagName: string = "thead"

TableAdditionalClassNames

TableAdditionalClassNames: string = ""

TableTagName

TableTagName: string = "table"

ThemeClassName

ThemeClassName: string = ...

ThemeName

ThemeName: string = "classic"

Title

Title: string = ""

Methods

Activate

  • Activate(): void

  • Activates the grid.

    example

    // Activates the grid grid.Activate();

    Returns void

AddAggregateField

  • AddAggregateField(fieldName: string, aggregateType: number): void

  • Adds an aggregate field

    fieldname

    Name of the field.

    aggregatetype

    Type of the aggregate action.

    example

    // Adds Sum of 'Price' field grid.AddAggregateField("Price", SobyAggregateTypes.Sum);

    Parameters

    • fieldName: string
    • aggregateType: number

    Returns void

AddColumn

  • AddColumn(fieldName: any, displayName: any, showFieldsOn: number, displayFunction: any, cellTemplate: any, sortable: any, filterable: any, editable: any, filterControl: any, cellCss: any, cellClassNames: any, responsiveCondition?: sobyResponsiveCondition): SobyGridColumn

  • Adds a column

    fieldname

    Name of the field.

    displayname

    Display name of the field.

    showfieldson

    States to be displayed on different layouts.

    displayfunction

    The function to be evaulated on display.

    celltemplate

    Html template of the cell.

    sortable

    States whether it is sortable or not.

    filterable

    States whether it is filterable or not.

    editable

    States whether it is editable or not.

    filtercontrol

    The control which will be displayed for filtering purpose.

    example

    // Adds Title as a column grid.AddColumn("Title", "Title", SobyShowFieldsOn.All, null, null, true, true, true, null);

    Parameters

    • fieldName: any
    • displayName: any
    • showFieldsOn: number
    • displayFunction: any
    • cellTemplate: any
    • sortable: any
    • filterable: any
    • editable: any
    • filterControl: any
    • cellCss: any
    • cellClassNames: any
    • Optional responsiveCondition: sobyResponsiveCondition

    Returns SobyGridColumn

AddDataRelation

  • AddDataRelation(masterFieldDisplayName: any, masterFieldValueName: any, detailGridID: any, detailFieldName: any): void

  • Adds a data relation

    masterfielddisplayname

    Display name of the master field.

    masterfieldvaluename

    Field name of the master field.

    detailgridid

    Identifier of the detail grid.

    detailfieldname

    Field name of the detail grid.

    example

    // Adds a data relation on Id field with AuthorId on detail grid authorGrid.AddDataRelation("Title", "Id", authorBooksGrid.GridID, "AuthorId");

    Parameters

    • masterFieldDisplayName: any
    • masterFieldValueName: any
    • detailGridID: any
    • detailFieldName: any

    Returns void

AddFilterControl

  • AddFilterControl(fieldName: any, displayName: any, fieldType: any): void

  • Not implemented yet.

    Parameters

    • fieldName: any
    • displayName: any
    • fieldType: any

    Returns void

AddFilterField

  • AddFilterField(fieldName: string, filterValue: string, fieldType: number, filterType: number, shouldBeClearedOnUIFilterAction: boolean): void

  • Parameters

    • fieldName: string
    • filterValue: string
    • fieldType: number
    • filterType: number
    • shouldBeClearedOnUIFilterAction: boolean

    Returns void

AddGroupByField

  • AddGroupByField(fieldName: string, isAsc: boolean, displayFunction: any): void

  • Parameters

    • fieldName: string
    • isAsc: boolean
    • displayFunction: any

    Returns void

AddHeaderCell

  • AddHeaderCell(headerRow: any, column: any, dataRelation: any): void

  • Adds a header cell

    headerrow

    Row of the header.

    column

    Column of the header.

    datarelation

    Data relation of the column.

    Parameters

    • headerRow: any
    • column: any
    • dataRelation: any

    Returns void

AddKeyField

  • AddKeyField(fieldName: string, parameterName: string): void

  • Adds key field.

    fieldname

    Name of the field.

    example

    // Adds ID as key field grid.AddKeyField("ID");

    Parameters

    • fieldName: string
    • parameterName: string

    Returns void

AddNewRecord

  • AddNewRecord(dataItem: any): void

AddOrderByField

  • AddOrderByField(fieldName: string, isAsc: boolean): void

AggregateBy

  • AggregateBy(fieldName: string, aggregateType: number): void

  • Aggregates result based on given field name

    fieldname

    Name of the field.

    aggregatetype

    Type of the aggregation.

    example

    // Aggregate by Price field as sum grid.AggregateBy("Price", SobyAggregateTypes.Sum)

    Parameters

    • fieldName: string
    • aggregateType: number

    Returns void

AllowDropColumn

  • AllowDropColumn(ev: any): void

ApplyFilters

  • ApplyFilters(fieldName: any): void

  • Apply filters

    fieldname

    Name of the field.

    example

    // Apply filters grid.ApplyFilters('Title');

    Parameters

    • fieldName: any

    Returns void

ApplyResponsiveElementsVisibility

  • ApplyResponsiveElementsVisibility(): void

ChangeTheme

  • ChangeTheme(themeName: string): void

  • Changes theme

    themename

    Name of the theme.

    example

    // Hides header row menu icon grid.ChangeTheme('classic');

    Parameters

    • themeName: string

    Returns void

ClearFiltersOn

  • ClearFiltersOn(fieldName: any): void

  • Clear filters on given field name

    fieldname

    Name of the field.

    example

    // Clear filters on given field name grid.ClearFiltersOn('Title')

    Parameters

    • fieldName: any

    Returns void

ClearUIFilters

  • ClearUIFilters(): void

Clone

CopyToClipboard

  • CopyToClipboard(): void

DeActivate

  • DeActivate(): void

  • De-activates the grid.

    example

    // De-Activates the grid grid.Activate();

    Returns void

DeleteSelectedRows

  • DeleteSelectedRows(): void

  • Deletes selected rows.

    example

    // Deletes selected rows grid.DeleteSelectedRows();

    Returns void

DisplayErrorMessage

  • DisplayErrorMessage(errorMessage: string): void

  • Displays error message

    errormessage

    Error message which returned from the service.

    example

    // Displays error message grid.DisplayErrorMessage(errorMessage);

    Parameters

    • errorMessage: string

    Returns void

DownloadCSV

  • DownloadCSV(csv: any, filename: any): void

  • Parameters

    • csv: any
    • filename: any

    Returns void

DragColumn

  • DragColumn(ev: any, fieldName: any): void

  • Drags column via setting its field name

    ev

    Drag Event.

    fieldname

    Name of the field.

    Parameters

    • ev: any
    • fieldName: any

    Returns void

DropColumn

  • DropColumn(ev: any): void

  • Drops the column

    ev

    Drag Event.

    Parameters

    • ev: any

    Returns void

DropGroupByColumn

  • DropGroupByColumn(ev: any): void

  • Drops group by column

    ev

    Drag Event.

    Parameters

    • ev: any

    Returns void

EditCell

  • EditCell(cellId: any): void

  • Not implemented yet.

    Parameters

    • cellId: any

    Returns void

EditNewRow

  • EditNewRow(): void

  • Edits new row.

    example

    // Edits new row. grid.EditNewRow();

    Returns void

EditOffCell

  • EditOffCell(cellId: any): void

  • Not implemented yet.

    Parameters

    • cellId: any

    Returns void

EditOffOnEditedCells

  • EditOffOnEditedCells(): void

EditSelectedCell

  • EditSelectedCell(): void

EditSelectedRow

  • EditSelectedRow(): void

  • Edits selected row.

    example

    // Edits selected row. grid.EditSelectedRow();

    Returns void

EnsureGridExistency

  • EnsureGridExistency(): void

  • Ensures grid is in the global grid array.

    example

    // Ensures grid is in the global grid array. grid.EnsureGridExistency();

    Returns void

EnsureItemDialogContainer

  • EnsureItemDialogContainer(): JQuery<HTMLElement>

  • Ensures edit/new item form dialog exists in the body.

    example

    // Ensures edit/new item form dialog exists in the body. grid.EnsureItemDialogContainer(1, 'Title');

    Returns JQuery<HTMLElement>

ExpandGroupBy

  • ExpandGroupBy(groupByRowID: any): void

ExportTableToCSV

  • ExportTableToCSV(): void

ExportToExcel

  • ExportToExcel(): void

FilterResult

  • FilterResult(fieldName: any, value: any, fieldType: any, filterType: any, shouldBeClearedOnUIFilterAction: boolean): void

  • Filters result based on given field name with single value

    fieldname

    Name of the field.

    value

    Value of the filter.

    fieldtype

    Type of the field.

    filtertype

    Type of the filter.

    example

    // Filters the result with the given value grid.FilterResult('Title', 'Moby', SobyFieldTypes.Text, SobyFilterTypes.Contains)

    Parameters

    • fieldName: any
    • value: any
    • fieldType: any
    • filterType: any
    • shouldBeClearedOnUIFilterAction: boolean

    Returns void

FilterResultWithMultipleValues

  • FilterResultWithMultipleValues(fieldName: any, values: any, fieldType: any, filterType: any, shouldBeClearedOnUIFilterAction: boolean): void

  • Filters result based on given field name with multiple value

    fieldname

    Name of the field.

    values

    Values of the filter.

    fieldtype

    Type of the field.

    filtertype

    Type of the filter.

    example

    // Filters the result with the given values grid.FilterResultWithMultipleValues('Title', ['Moby', 'Don'], SobyFieldTypes.Text, SobyFilterTypes.Contains)

    Parameters

    • fieldName: any
    • values: any
    • fieldType: any
    • filterType: any
    • shouldBeClearedOnUIFilterAction: boolean

    Returns void

FocusToFirstItem

  • FocusToFirstItem(): void

  • Focuses to the first item

    example

    // Focuses to the first item grid.FocusToFirstItem();

    Returns void

GenerateActionPane

  • GenerateActionPane(): void

  • Generates action pane

    example

    // Generates action pane grid.GenerateActionPane();

    Returns void

GenerateConteFromCellTemplate

  • GenerateConteFromCellTemplate(columnIndex: number, dataItemIndex: number): string

GenerateFilterPane

  • GenerateFilterPane(): void

  • Generates filter pane

    example

    // Generates filter pane grid.GenerateFilterPane();

    Returns void

GenerateGroupByPanePane

  • GenerateGroupByPanePane(): void

  • Generates group by pane

    example

    // Generates filter pane grid.GenerateGroupByPanePane();

    Returns void

GenerateNavigationPane

  • GenerateNavigationPane(): string

  • Generates navigation pane

    example

    // Generates navigation pane grid.GenerateNavigationPane();

    Returns string

GetActiveRowID

  • GetActiveRowID(): string

  • Gets active row identifier

    example

    // returns "soby_griddatarow_bbe4e9e8-6e44-aca8-0129-15fc255df0ec" grid.GetActiveRowID()

    Returns string

GetColumn

  • Gets grid column by field name

    example

    // returns Column object for given fieldname grid.GetColumn('Title');

    Parameters

    • fieldName: any

    Returns SobyGridColumn

GetItemFieldValue

  • GetItemFieldValue(rowIndex: number, fieldName: string): any

  • Get the value of the given rowindex and fieldname.

    rowindex

    Index of the grid row.

    fieldname

    Name of the field.

    example

    // Returns the value of Title field which is in row with index number 1. grid.GetItemFieldValue(1, 'Title');

    Parameters

    • rowIndex: number
    • fieldName: string

    Returns any

GetResponsiveConditionById

GetRowIdByItemIndex

  • GetRowIdByItemIndex(itemIndex: any): string

GetRowIds

  • GetRowIds(): any[]

  • Gets row identifiers

    example

    // returns ["soby_griddatarow_bbe4e9e8-6e44-aca8-0129-15fc255df0ec", "soby_griddatarow_f0b7f7e8-6b89-accf-0446-88eda73e0bee"] grid.GetRowIds()

    Returns any[]

GetSelectedCellID

  • GetSelectedCellID(): string

  • Gets selected cell identifier

    example

    // returns "soby_gridcell_8be81bcb-ae80-5309-3d8a-6ad091c01051" grid.GetSelectedCellID();

    Returns string

GetSelectedCellIds

  • GetSelectedCellIds(): any[]

  • Gets row identifiers

    example

    // returns ["soby_griddatarow_bbe4e9e8-6e44-aca8-0129-15fc255df0ec", "soby_griddatarow_f0b7f7e8-6b89-accf-0446-88eda73e0bee"] grid.GetRowIds()

    Returns any[]

GetSelectedDataItems

  • GetSelectedDataItems(): any[]

  • Gets selected data items

    example

    // returns [Object, Object] grid.GetSelectedDataItems();

    Returns any[]

GetSelectedRowID

  • GetSelectedRowID(): string

  • Gets selected row identifier

    example

    // returns "soby_griddatarow_bbe4e9e8-6e44-aca8-0129-15fc255df0ec" grid.GetSelectedRowID()

    Returns string

GetSelectedRowIDs

  • GetSelectedRowIDs(): any[]

  • Gets selected row identifiers

    example

    // returns ["soby_griddatarow_fa5a2dd6-fc2a-d61b-5b9f-4e6e0824ce11", "soby_griddatarow_fdc30fcf-caee-eec7-a95f-16589d619c9c"] grid.GetSelectedRowIDs();

    Returns any[]

GoToNextPage

  • GoToNextPage(): void

  • Navigates to the next page

    example

    // Navigates to the next page grid.GoToNextPage();

    Returns void

GoToPreviousPage

  • GoToPreviousPage(): void

  • Navigates to the previous page

    example

    // Navigates to the previous page grid.GoToPreviousPage();

    Returns void

GroupBy

  • GroupBy(fieldName: string, isAsc: boolean, displayFunction: any): void

  • Groups result based on given field name

    fieldname

    Name of the field.

    isasc

    States whether it is ascending or descending.

    example

    // Group by Title field as ascending grid.GroupBy('Title', true)

    Parameters

    • fieldName: string
    • isAsc: boolean
    • displayFunction: any

    Returns void

HideCellPopupContent

  • HideCellPopupContent(cellID: any): void

  • Hides cell poup content

    cellid

    Identifier of the cell.

    example

    // Hides cell poup content grid.HideCellPopupContent('soby_gridcell_2e7e2471-cd48-85ac-45ab-5f2db8162cbc')

    Parameters

    • cellID: any

    Returns void

HideHeaderRowMenu

  • HideHeaderRowMenu(fieldName: any): void

  • Hides header row menu

    fieldname

    Name of the field.

    example

    // Hides header row menu icon grid.HideHeaderRowMenu('Title');

    Parameters

    • fieldName: any

    Returns void

HideHeaderRowMenuIcon

  • HideHeaderRowMenuIcon(fieldName: any): void

  • Hides header row menu icon

    fieldname

    Name of the field.

    example

    // Hides header row menu icon grid.HideHeaderRowMenuIcon('Title');

    Parameters

    • fieldName: any

    Returns void

HideItemDialog

  • HideItemDialog(): void

  • Hides edit/new item form dialog.

    example

    // Hides edit/new item form dialog. grid.HideItemDialog();

    Returns void

HideShowFilterPane

  • HideShowFilterPane(): void

  • Hides/show filter pane

    example

    // Hides/show filter pane grid.HideShowFilterPane();

    Returns void

Initialize

  • Initialize(populateItems: boolean): void

  • Initializes the grid

    populateitems

    States whether items should be populated or not.

    example

    // Initializes the grid and populate items grid.Initialize(true);

    Parameters

    • populateItems: boolean

    Returns void

InitializeActionPaneButtons

  • InitializeActionPaneButtons(): void

PopulateAggregateRow

  • PopulateAggregateRow(rowAddBefore: any, level: number, hasEmptyCell: boolean): void

PopulateAggregateRowValues

  • PopulateAggregateRowValues(aggregateRow: any): void

PopulateAggregateRows

  • PopulateAggregateRows(): void

PopulateAggregateRowsValues

  • PopulateAggregateRowsValues(): void

PopulateCellTemplateContent

  • PopulateCellTemplateContent(cellId: string, columnIndex: number, dataItemIndex: number): void

PopulateDetailGrid

  • PopulateDetailGrid(detailGridIDs: any, contentDivSelectors: any, mainRowId: any, fieldNames: any, values: any): void

  • Populates the detail grid

    detailgridids

    Identifiers of the detail grid.

    contentdivselectors

    Selectors div of the detail grid.

    mainrowids

    Row identifiers of the master grid.

    fieldnames

    Names of the field.

    values

    Filter values for the detail grid.

    example

    // Populates the detail grid grid.PopulateDetailGrid('soby_grid_fc073155-7f8d-094a-4745-55acd12c4812','#soby_griddatarow_e63bc6df-9a42-a52e-86a5-3d6665cd0bc0_soby_grid_fc073155-7f8d-094a-4745-55acd12c4812', 'soby_griddatarow_e63bc6df-9a42-a52e-86a5-3d6665cd0bc0', 'AuthorId', '1');

    Parameters

    • detailGridIDs: any
    • contentDivSelectors: any
    • mainRowId: any
    • fieldNames: any
    • values: any

    Returns void

PopulateDetailRow

  • PopulateDetailRow(rowID: any): void

PopulateEditControlsOnNewEditForm

  • PopulateEditControlsOnNewEditForm(isEditForm: boolean, rowId: string): void

  • Populate edit controls for edit/new item form.

    iseditform

    States whether it is an edit item form or new item form.

    rowid

    Identifier of the row.

    example

    // Populates new item form grid.PopulateEditControlsOnNewEditForm(false, null);

    example

    // Populates edit item form for row id as soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b grid.PopulateEditControlsOnNewEditForm(true, 'soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b');

    Parameters

    • isEditForm: boolean
    • rowId: string

    Returns void

PopulateGridData

  • PopulateGridData(items: any): void

  • Populates the grid data

    items

    Data items which returned from the service.

    example

    // Populates the grid with the given items grid.PopulateGridData(items);

    Parameters

    • items: any

    Returns void

PopulateGroupByRow

  • PopulateGroupByRow(itemIndex: number, item: any, row: any): any

PopulateHeaderCells

  • PopulateHeaderCells(): void

  • Populates header cells

    example

    // Populates header cells grid.PopulateHeaderCells()

    Returns void

PopulateSelectionCell

  • PopulateSelectionCell(item: any, row: any, rowID: any): void

PopulateViewColumns

  • PopulateViewColumns(item: any, row: any, rowID: any, itemIndex: number): void

PrintGrid

  • PrintGrid(): void

SaveItemDetail

  • SaveItemDetail(rowId: string): void

  • Saves currently edited item.

    rowid

    Identifier of the row.

    example

    // Saves edited item with row id as soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b. grid.SaveItemDetail('soby_griddatarow_e6d7a5b4-3636-5780-f02e-c84b43ca2c6b');

    Parameters

    • rowId: string

    Returns void

SelectAllRows

  • SelectAllRows(): void

SelectCell

  • SelectCell(rowID: any, cellIndex: any): void

  • Selects the cell

    rowid

    Identifier of the row.

    cellindex

    Index of the cell.

    example

    // Selects the cell with given row identifier and cell index grid.SelectCell("soby_griddatarow_fdc30fcf-caee-eec7-a95f-16589d619c9c", 3);

    Parameters

    • rowID: any
    • cellIndex: any

    Returns void

SelectDetailGridTab

  • SelectDetailGridTab(rowid: any, index: any): void

  • Selects the detail grid tab

    rowid

    Identifier of the row.

    index

    Index of the tab.

    example

    // Populates the detail grid grid.SelectDetailGridTab('soby_griddatarow_e63bc6df-9a42-a52e-86a5-3d6665cd0bc0', '0');

    Parameters

    • rowid: any
    • index: any

    Returns void

SelectRow

  • SelectRow(rowID: any): void

  • Selects the row

    rowid

    Identifier of the row.

    example

    // Selects the row with given row identifier grid.SelectRow("soby_griddatarow_fdc30fcf-caee-eec7-a95f-16589d619c9c");

    Parameters

    • rowID: any

    Returns void

SelectRowByIndex

  • SelectRowByIndex(rowIndex: any): void

  • Selects the row

    rowindex

    Index of the row.

    example

    // Selects the row with given row index grid.SelectRow(1);

    Parameters

    • rowIndex: any

    Returns void

SetActionPaneButtonsVisibility

  • SetActionPaneButtonsVisibility(): void

ShowCellPopupContent

  • ShowCellPopupContent(cellID: string, columnIndex: number, dataItemIndex: number): void

  • Shows cell poup content

    cellid

    Identifier of the cell.

    example

    // Shows cell poup content grid.ShowCellPopupContent('soby_gridcell_2e7e2471-cd48-85ac-45ab-5f2db8162cbc')

    Parameters

    • cellID: string
    • columnIndex: number
    • dataItemIndex: number

    Returns void

ShowHeaderRowMenu

  • ShowHeaderRowMenu(fieldName: any, displayName: any, sortable: any, filterable: any): void

  • Shows header row menu

    ev

    Current event.

    fieldname

    Name of the field.

    displayname

    Display name of the field.

    sortable

    States whether it is sortable or not.

    filterable

    States whether it is filterable or not.

    example

    // Shows header row menu grid.ShowHeaderRowMenu('Title', 'Title', true, true)

    Parameters

    • fieldName: any
    • displayName: any
    • sortable: any
    • filterable: any

    Returns void

ShowHeaderRowMenuIcon

  • ShowHeaderRowMenuIcon(fieldName: any): void

  • Shows header row menu icon

    fieldname

    Name of the field.

    example

    // Shows header row menu icon grid.ShowHeaderRowMenuIcon('Title');

    Parameters

    • fieldName: any

    Returns void

SortGroupByField

  • SortGroupByField(sortFieldName: string, isAsc: boolean): void

  • Sorts result based on given group by field name

    sortfieldname

    Name of the field to be sorted.

    isasc

    States whether it is ascending or descending.

    example

    // Sorts by Title group field as ascending grid.SortGroupByField('Title', true)

    Parameters

    • sortFieldName: string
    • isAsc: boolean

    Returns void

SortResult

  • SortResult(sortFieldName: any, isAsc: any): void

  • Sorts result based on given field name

    sortfieldname

    Name of the field to be sorted.

    isasc

    States whether it is ascending or descending.

    example

    // Sorts by Title field as ascending grid.SortResult('Title', true)

    Parameters

    • sortFieldName: any
    • isAsc: any

    Returns void

UpdateRecord

  • UpdateRecord(parameterNames: any, dbInstanceIds: any, dbInstance: any, rowId: any): void

  • Parameters

    • parameterNames: any
    • dbInstanceIds: any
    • dbInstance: any
    • rowId: any

    Returns void

Generated using TypeDoc