Skip to content

Commit 23b7000

Browse files
committed
[update] complete grid column header property's description
1 parent 16f5533 commit 23b7000

2 files changed

Lines changed: 15 additions & 15 deletions

File tree

docs/grid/api/export/grid_csv_method.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@ You can specify extended export configuration settings via the Grid [`exportConf
2222
:::
2323

2424
@returns:
25-
A promise of data export
25+
A promise of data export as a CSV string
2626

2727
@example:
2828
// default export

docs/grid/api/gridcolumn_properties/gridcolumn_header_property.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -37,24 +37,24 @@ header: [
3737
icon?: string, // sets CSS class for the filter icon in `inputFilter` and the calendar icon in `dateFilter`
3838
/* properties of `comboFilter` configuration */
3939
filter?: (item, input: string) => boolean,
40-
multiselection?: boolean,
41-
readonly?: boolean,
40+
multiselection?: boolean, // false by default
41+
readonly?: boolean, // false by default
4242
virtual?: boolean, // true by default
4343
template?: function,
4444
/* properties of `dateFilter` configuration */
45-
asDateObject?: boolean,
45+
asDateObject?: boolean, // false by default
4646
date?: Date | string,
4747
mark?: (date: Date) => string,
4848
disabledDates?: (date: Date) => boolean,
49-
weekStart?: "saturday" | "sunday" | "monday",
50-
weekNumbers?: boolean,
51-
mode?: "calendar" | "year" | "month" | "timepicker",
52-
timePicker?: boolean,
53-
dateFormat?: string,
54-
timeFormat?: 24 | 12,
55-
thisMonthOnly?: boolean,
56-
width?: string | number,
57-
range?: boolean
49+
weekStart?: "saturday" | "sunday" | "monday", // "sunday" by default
50+
weekNumbers?: boolean, // false by default
51+
mode?: "calendar" | "year" | "month" | "timepicker", // "calendar" by default
52+
timePicker?: boolean, // false by default
53+
dateFormat?: string, // by default, applies the dateFormat used for the column
54+
timeFormat?: 24 | 12, // 24 by default
55+
thisMonthOnly?: boolean, // false by default
56+
width?: string | number, // "250px" by default
57+
range?: boolean // false by default
5858
},
5959
customFilter?: (
6060
value: string | number | Date | Date[],
@@ -100,10 +100,10 @@ Each header object may include:
100100
</tr>
101101
<tr>
102102
<td><a href="../../../configuration/#headerfooter-filters"><b>filterConfig</b></a></td>
103-
<td>(optional) a configuration object for setting the behavior and appearance of the filter. The set of properties depends on the filter type specified in the `content` property: <br><br> - a configuration object for <b>"inputFilter"</b> can contain the following properties: <ul><li><b>placeholder</b> - (optional) the placeholder text in the input field</li><li><b> icon</b> - (optional) the CSS class for the filter icon</li></ul> <br> - a configuration object for <b>"comboFilter"</b> can contain a set of properties:<ul><li><b>filter</b> - (optional) sets a custom function for filtering Combo Box options</li><li><b>multiselection</b> - (optional) enables selection of multiple options</li><li><b>readonly</b> - (optional) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input). The default value of the <b>readonly</b> property depends on the following conditions:<ul><li>the `readonly:true` is set as a default value, if `htmlEnable:true` is set for a column and there is no template specified for a column</li><li>in all other cases, `readonly:false` is set by default</li></ul></li><li><b>placeholder</b> - (optional) sets a placeholder in the input of ComboBox</li><li><b>virtual</b> - (optional) enables dynamic loading of data on scrolling the list of options, <i>true</i> by default</li><li><b>template</b> - (optional) a function which returns a template with content for the filter options. Takes an option item as a parameter:<ul><li><b>item</b> - (object) an option item</li></ul></li></ul> - a configuration object for <b>"dateFilter" (PRO version)</b> can contain a set of properties:<br>Main properties:<ul><li><b>icon</b> - (optional) the CSS class for the calendar icon</li><li><b>placeholder</b> - (optional) the placeholder text in the input field when no date is selected</li><li><b>asDateObject</b> (optional) - determines how the filter processes data for `customFilter` and the `beforeFilter` and `filterChange` events. If `true`, the comparison is performed using Date objects</li><li><b>range</b> - (optional) enables the date range selection mode (from and to)</li><li><b>dateFormat</b> - (optional) the date display format (e.g., `"%d/%m/%Y"`). By default, applies the `dateFormat` used for the column</li></ul>Calendar API configuration properties:<ul><li><b>date</b> - (optional) - the initial date opened in the calendar</li><li><b>mark</b> - (optional) - a function for adding custom CSS classes to specific dates </li><li><b>disabledDates</b> - (optional) - a function for disabling the selection of specific dates </li><li><b>weekStart</b> - (optional) - the start day of the week (`"saturday"`, `"sunday"`, `"monday"`).</li><li><b>weekNumbers</b> - (optional) - shows week numbers if `true`</li><li><b>mode</b> - (optional) - the calendar display mode (`"calendar"`, `"year"`, `"month"`, `"timepicker"`)</li><li><b>timePicker</b> - (optional) - adds the ability to select time</li><li><b>timeFormat</b> - (optional) - the time format (`12` or `24` hours)</li><li><b>thisMonthOnly</b> - (optional) - if `true`, allows selecting dates only within the current month</li><li><b>width</b> - (optional) - the width of the dropdown calendar</li></ul></td>
103+
<td>(optional) a configuration object for setting the behavior and appearance of the filter. The set of properties depends on the filter type specified in the `content` property: <br><br> - a configuration object for <b>"inputFilter"</b> can contain the following properties: <ul><li><b>placeholder</b> - (optional) the placeholder text in the input field</li><li><b> icon</b> - (optional) the CSS class for the filter icon</li></ul> <br> - a configuration object for <b>"comboFilter"</b> can contain a set of properties:<ul><li><b>filter</b> - (optional) sets a custom function for filtering Combo Box options</li><li><b>multiselection</b> - (optional) enables selection of multiple options, *false* by default</li><li><b>readonly</b> - (optional) makes ComboBox readonly (it is only possible to select options from the list, without entering words in the input). The default value of the <b>readonly</b> property depends on the following conditions:<ul><li>the `readonly:true` is set as a default value, if `htmlEnable:true` is set for a column and there is no template specified for a column</li><li>in all other cases, `readonly:false` is set by default</li></ul></li><li><b>placeholder</b> - (optional) sets a placeholder in the input of ComboBox</li><li><b>virtual</b> - (optional) enables dynamic loading of data on scrolling the list of options, <i>true</i> by default</li><li><b>template</b> - (optional) a function which returns a template with content for the filter options. Takes an option item as a parameter:<ul><li><b>item</b> - (object) an option item</li></ul></li></ul> - a configuration object for <b>"dateFilter" (PRO version)</b> can contain a set of properties:<br>Main properties:<ul><li><b>icon</b> - (optional) the CSS class for the calendar icon</li><li><b>placeholder</b> - (optional) the placeholder text in the input field when no date is selected</li><li><b>asDateObject</b> - (optional) determines how the filter processes data for `customFilter` and the `beforeFilter` and `filterChange` events. If *true*, the comparison is performed using Date objects, *false* by default</li><li><b>range</b> - (optional) enables the date range selection mode (from and to), *false* by default</li><li><b>dateFormat</b> - (optional) the date display format (e.g., *"%d/%m/%Y"*). By default, applies the `dateFormat` used for the column</li></ul>Calendar API configuration properties:<ul><li><b>date</b> - (optional) - the initial date opened in the calendar</li><li><b>mark</b> - (optional) - a function for adding custom CSS classes to specific dates </li><li><b>disabledDates</b> - (optional) - a function for disabling the selection of specific dates </li><li><b>weekStart</b> - (optional) - the start day of the week (*"saturday"*, *"sunday"* (default), *"monday"*).</li><li><b>weekNumbers</b> - (optional) - shows week numbers if *true*, *false* by default</li><li><b>mode</b> - (optional) - the calendar display mode (*"calendar"* (default), *"year"*, *"month"*, *"timepicker"*)</li><li><b>timePicker</b> - (optional) - adds the ability to select time, *false* by default</li><li><b>timeFormat</b> - (optional) - the time format (*12* or *24* (default) hours)</li><li><b>thisMonthOnly</b> - (optional) - if *true*, allows selecting dates only within the current month, *false* by default</li><li><b>width</b> - (optional) - the width of the dropdown calendar, *"250px"* by default</li></ul></td>
104104
</tr>
105105
<tr>
106-
<td><a href="../../../configuration/#customizing-headerfooter-filters"><b>customFilter</b></a> </td><td>(optional) a callback function that allows defining custom filtering logic. It takes two parameters:<ul><li><b>value</b> - (required) the cell value in the row</li><li> <b>match</b> - (required) the value selected in the filter</li></ul>and returns `true`, if the row matches the filtering criteria, otherwise `false`</td>
106+
<td><a href="../../../configuration/#customizing-headerfooter-filters"><b>customFilter</b></a> </td><td>(optional) a callback function that allows defining custom filtering logic. It takes two parameters:<ul><li><b>value</b> - (required) the cell value in the row</li><li> <b>match</b> - (required) the value selected in the filter</li></ul>and returns *true*, if the row matches the filtering criteria, otherwise *false*</td>
107107
</tr>
108108
<tr>
109109
<td><b>headerSort</b></td><td>(optional) enables/disables sorting by clicking the header, <i>true</i> by default</td>

0 commit comments

Comments
 (0)