44
Name
Type
Description
createDetailCell
Function
Gets or sets the callback function that creates detail cells.
The callback function takes a Row as a parameter and returns an
an
HTML element representing the row details. For example:
// create detail cells for a given row
dp.createDetailCell = function (row) {
var cell = document.createElement('div');
var detailGrid = new wijmo.grid.FlexGrid(cell, {
itemsSource: getProducts(row.dataItem.CategoryID),
headersVisibility: wijmo.grid.HeadersVisibility.Column
});
return cell;
};
(inherited from FlexGridDetailProvider).
.
detailVisibilityMode
DetailVisibilityMode
Gets or sets a value that determines when row details are displayed.
(inherited from FlexGridDetailProvider).
disposeDetailCell
Function
Gets or sets the callback function that disposes of detail cells.
The callback function takes a Row as a parameter and disposes of any
any
resources associated with the detail cell.
This function is optional. Use it in cases where
the createDetailCell function allocates resources that are not
not
automatically garbage-collected.
(inherited from FlexGridDetailProvider).
.
grid
FlexGrid
Gets the FlexGrid that owns this FlexGridDetailProvider.
(inherited from FlexGridDetailProvider).
maxHeight
number
Gets or sets the maximum height of the detail rows, in pixels.
(inherited from FlexGridDetailProvider).
44
Name
Type
Description
rowHasDetail
Function
Gets or sets the callback function that determines whether a row has
details.
The callback function takes a Row as a parameter and returns a
s a
boolean value that indicates whether the row has details. For example:
// remove details from items with odd CategoryID
dp.rowHasDetail = function (row) {
return row.dataItem.CategoryID % 2 == 0;
};
Setting this property to null indicates all rows have details.
(inherited from FlexGridDetailProvider).
.
Methods
Name
Parameters
Description
constructor(grid)
grid (FlexGrid): FlexGrid that will receive detail rows.
Initializes a new instance of
the FlexGridDetailProvider class.
(inherited from FlexGridDetailProvider).
hideDetail(row?)
row? (any): Row or index of the row that will have its
details hidden. This parameter is optional. If not provided,
all detail rows are hidden.
Hides the detail row for a given row.
(inherited from FlexGridDetailProvider).
isDetailAvailable
(row): boolean
row (any): Row or index of the row to investigate.
Gets a value that determines if a row has details
to show.
(inherited from FlexGridDetailProvider).
isDetailVisible
(row): boolean
row (any): Row or index of the row to investigate.
Gets a value that determines if a row's details are
visible.
(inherited from FlexGridDetailProvider).
35
Name
Parameters
Description
showDetail(row,
hideOthers?)
row (any): Row or index of the row that will have its
details shown.
hideOthers? (boolean): Whether to hide details for all
other rows.
(default value: false)
Shows the detail row for a given row.
(inherited from FlexGridDetailProvider).
Module wijmo/wijmo.angular2.grid.sheet
File
wijmo.angular2.js
Contains Angular 2 components for the wijmo.grid.sheet module.
wijmo.angular2.grid.sheet is an external TypeScript module that can be imported to your code using its ambient module name. For example:
import * as wjSheet from 'wijmo/wijmo.angular2.grid.sheet';
@Component({
directives: [wjSheet.WjFlexSheet],
template: `<wj-flex-sheet></wj-flex-sheet>`,
selector: 'my-cmp',
})
export class MyCmp {
}
Classes
Name
Description
WjFlexSheet
Angular 2 component for the FlexSheet control.
l.
Use the wj-flex-sheet component to add FlexSheet controls to your Angular 2 applications. For details about Angular
out Angular
2 markup syntax, see Angular 2 Markup.
.
29
Name
Description
The WjFlexSheet component is derived from the FlexSheet control and inherits all its properties, events and methods.
thods.
The wj-flex-sheet component may contain Sheet child component.
WjSheet
Angular 2 component for the WjFlexSheet Sheet object.
ect.
The wj-sheet component must be contained in a WjFlexSheet component.
mponent.
Use the wj-sheet component to add Sheet objects to your Angular 2 applications. For details about Angular 2 markup
2 markup
syntax, see Angular 2 Markup.
.
The WjSheet component is derived from the Sheet class and inherits all its properties, events and methods.
ethods.
WjFlexSheet Class
Base Class
FlexSheet{
Module
wijmo/wijmo.angular2.grid.sheet
File
wijmo.angular2.js
Angular 2 component for the FlexSheet control.
Use the wj-flex-sheet component to add FlexSheet controls to your Angular 2 applications. For details about Angular 2 markup syntax,
see Angular 2 Markup.
The WjFlexSheet component is derived from the FlexSheet control and inherits all its properties, events and methods.
The wj-flex-sheet component may contain Sheet child component.
WjSheet Class
38
Base Class
Sheet
Implements
OnChanges, OnInit
Module
wijmo/wijmo.angular2.grid.sheet
File
wijmo.angular2.js
Angular 2 component for the WjFlexSheet Sheet object.
The wj-sheet component must be contained in a WjFlexSheet component.
Use the wj-sheet component to add Sheet objects to your Angular 2 applications. For details about Angular 2 markup syntax, see Angular 2
Markup.
The WjSheet component is derived from the Sheet class and inherits all its properties, events and methods.
Properties
Name
Type
Description
columnCount
number
Gets or sets the number of columns in the sheet.
(inherited from Sheet).
grid
FlexGrid
Gets the associated FlexGrid control used to store the sheet data.
(inherited from Sheet).
itemsSource
any
Gets or sets the array or ICollectionView for the FlexGrid instance of
the sheet.
(inherited from Sheet).
name
string
Gets or sets the name of the sheet.
(inherited from Sheet).
rowCount
number
Gets or sets the number of rows in the sheet.
(inherited from Sheet).
57
Name
Type
Description
selectionRanges
ObservableArray
Gets the selection array.
(inherited from Sheet).
visible
boolean
Gets or sets the sheet visibility.
(inherited from Sheet).
Methods
Name
Parameters
Description
constructor(owner?, grid?,
sheetName?, rows?, cols?)
owner? (FlexSheet): The owner @see: FlexSheet
control.
grid? (FlexGrid): The associated FlexGrid control
used to store the sheet data. If not specified then the
new FlexGrid control will be created.
sheetName? (string): The name of the sheet within
the FlexSheet control.
rows? (number): The row count for the sheet.
cols? (number): The column count for the sheet.
Initializes a new instance of
the FlexSheet class.
(inherited from Sheet).
getCellStyle(rowIndex,
columnIndex):ICellStyle
rowIndex (number): the row index of the specified
cell.
columnIndex (number): the column index of the
specified cell.
Gets the style of specified cell.
(inherited from Sheet).
onNameChanged(e)
e (EventArgs)
Raises the sheetNameChanged event.
(inherited from Sheet).
onVisibleChanged(e)
e (EventArgs)
Raises the visibleChanged event.
(inherited from Sheet).
Events
Name
Arguments
Description
nameChanged
EventArgs
Occurs after the sheet name has changed.
(inherited from Sheet).
visibleChanged
EventArgs
Occurs after the visible of sheet has changed.
(inherited from Sheet).
30
Module wijmo/wijmo.angular2.chart
File
wijmo.angular2.js
Contains Angular 2 components for the wijmo.chart module.
wijmo.angular2.chart is an external TypeScript module that can be imported to your code using its ambient module name. For example:
import * as wjChart from 'wijmo/wijmo.angular2.chart';
@Component({
directives: [wjChart.WjFlexChart, wjChart.WjFlexChartSeries],
template: `
<wj-flex-chart [itemsSource]="data" [bindingX]="'x'">
<wj-flex-chart-series [binding]="'y'"></wj-flex-chart-series>
</wj-flex-chart>`,
selector: 'my-cmp',
})
export class MyCmp {
data: any[];
}
Classes
Name
Description
WjFlexChart
Angular 2 component for the FlexChart control.
l.
Use the wj-flex-chart component to add FlexChart controls to your Angular 2 applications. For details
or details
about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChart component is derived from the FlexChart control and inherits all its properties,
erties,
events and methods.
41
Name
Description
The wj-flex-chart component may
contain WjFlexChartAxis, WjFlexChartSeries, WjFlexChartLegend and WjFlexChartDataLabel ch
ild components.
WjFlexChartAxis
Angular 2 component for the WjFlexChart Axis control.
rol.
The wj-flex-chart-axis component must be contained in a WjFlexChart component.
component.
Use the wj-flex-chart-axis component to add Axis objects to your Angular 2 applications. For details
For details
about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChartAxis component is derived from the Axis class and inherits all its properties, events
events
and methods.
WjFlexChartDataLabel
Angular 2 component for the WjFlexChart DataLabel control.
rol.
The wj-flex-chart-data-label component must be contained in a WjFlexChart component.
component.
Use the wj-flex-chart-data-label component to add DataLabel objects to your Angular 2 applications.
applications.
For details about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChartDataLabel component is derived from the DataLabel class and inherits all its
all its
properties, events and methods.
WjFlexChartDataPoint
Angular 2 component for the WjFlexChart DataPoint objects.
cts.
The wj-flex-chart-data-point component must be contained in a WjFlexChart component.
component.
Use the wj-flex-chart-data-point component to add DataPoint objects to your Angular 2 applications.
applications.
For details about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChartDataPoint component is derived from the DataPoint class and inherits all its
ll its
properties, events and methods.
44
Name
Description
WjFlexChartLegend
Angular 2 component for the WjFlexChart Legend control.
rol.
The wj-flex-chart-legend component must be contained in a WjFlexChart component.
component.
Use the wj-flex-chart-legend component to add Legend objects to your Angular 2 applications. For
cations. For
details about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChartLegend component is derived from the Legend class and inherits all its properties,
rties,
events and methods.
WjFlexChartLineMarke
r
Angular 2 component for the WjFlexChart LineMarker control.
rol.
The wj-flex-line-marker component must be contained in a WjFlexChart component.
component.
Use the wj-flex-line-marker component to add LineMarker objects to your Angular 2 applications. For
cations. For
details about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChartLineMarker component is derived from the LineMarker class and inherits all its
all its
properties, events and methods.
WjFlexChartPlotArea
Angular 2 component for the WjFlexChart PlotArea objects.
cts.
The wj-flex-chart-plot-area component must be contained in a WjFlexChart component.
component.
Use the wj-flex-chart-plot-area component to add PlotArea objects to your Angular 2 applications. For
plications. For
details about Angular 2 markup syntax, see Angular 2 Markup.
.
The WjFlexChartPlotArea component is derived from the PlotArea class and inherits all its properties,
erties,
events and methods.
WjFlexChartSeries
Angular 2 component for the WjFlexChart Series object.
ject.
The wj-flex-chart-series component must be contained in a WjFlexChart component.
component.
Documents you may be interested
Documents you may be interested