ViewApi
TypeScript
declare class ViewApi extends BaseApiExtends
BaseApi
Properties
| Property |
|---|
| cloneView |
| deleteView |
| getAllAvailableColumns |
| getAvailableViewIds |
| getColumnById |
| getColumnsInCurrentView |
| getCurrentView |
| getCurrentViewId |
| getVisibleColumns |
| isPivotView |
| pivotViewApi |
| setActiveView |
| tableViewApi |
Methods
Property Details
cloneView
TypeScript
cloneView: (view: AdaptableTableViewWithOptionalColumns | AdaptablePivotView) => string;Property Value
(view: AdaptableTableViewWithOptionalColumns | AdaptablePivotView) => string
deleteView
TypeScript
deleteView: (viewId: string) => void;Property Value
(viewId: string) => void
getAllAvailableColumns
TypeScript
getAllAvailableColumns: () => AdaptableColDefWithId[];Property Value
() => AdaptableColDefWithId[]
getAvailableViewIds
TypeScript
getAvailableViewIds: () => string[];Property Value
() => string[]
getColumnById
TypeScript
getColumnById: (colId: string) => AdaptableTableColumn | undefined;Property Value
(colId: string) => AdaptableTableColumn | undefined
getColumnsInCurrentView
TypeScript
getColumnsInCurrentView: () => AdaptableTableColumn[];Property Value
() => AdaptableTableColumn[]
getCurrentView
TypeScript
getCurrentView: () => AdaptableComputedTableView | AdaptableComputedPivotView;Property Value
() => AdaptableComputedTableView | AdaptableComputedPivotView
getCurrentViewId
TypeScript
getCurrentViewId: () => string;Property Value
() => string
getVisibleColumns
TypeScript
getVisibleColumns: () => AdaptableTableColumn[];Property Value
() => AdaptableTableColumn[]
isPivotView
TypeScript
isPivotView: () => boolean;Property Value
() => boolean
pivotViewApi
TypeScript
pivotViewApi: PivotViewApi;Property Value
PivotViewApi
setActiveView
TypeScript
setActiveView: (viewId: string) => void;Property Value
(viewId: string) => void
tableViewApi
TypeScript
tableViewApi: TableViewApi;Property Value
TableViewApi
Method Details
addColumnToCurrentView
TypeScript
addColumnToCurrentView(calculatedColumnId: string): void;Parameters
| Parameter | Type |
|---|---|
| calculatedColumnId | string |
Returns
void
addFlashingCellToView
TypeScript
addFlashingCellToView(flashingCellId: string, viewId?: string): void;Parameters
| Parameter | Type |
|---|---|
| flashingCellId | string |
| viewId | string |
Returns
void
addStyledCellToView
TypeScript
addStyledCellToView(styledCellId: string, viewId?: string): void;Parameters
| Parameter | Type |
|---|---|
| styledCellId | string |
| viewId | string |
Returns
void
removeColumnFromView
TypeScript
removeColumnFromView(calculatedColumnId: string, viewId?: string): void;Parameters
| Parameter | Type |
|---|---|
| calculatedColumnId | string |
| viewId | string |
Returns
void
removeFlashingCellFromView
TypeScript
removeFlashingCellFromView(flashingCellId: string, viewId?: string): void;Parameters
| Parameter | Type |
|---|---|
| flashingCellId | string |
| viewId | string |
Returns
void
removeStyledCellFromView
TypeScript
removeStyledCellFromView(styledCellId: string, viewId?: string): void;Parameters
| Parameter | Type |
|---|---|
| styledCellId | string |
| viewId | string |
Returns
void