From c29181dbad27a58bd2543de18590a38a4defad50 Mon Sep 17 00:00:00 2001 From: CI User Date: Tue, 18 Jul 2023 22:02:30 +0100 Subject: [PATCH] Update document for efx-grid v6.0.65 --- book/en/README.md | 4 +- book/en/apis/README.html | 2 +- book/en/apis/core/Cell.html | 2 +- book/en/apis/core/CellSpans.html | 2 +- book/en/apis/core/ColumnStats.html | 2 +- book/en/apis/core/DataCache.html | 2 +- book/en/apis/core/DataTable.html | 2 +- book/en/apis/core/DataView.html | 2 +- book/en/apis/core/DragAndDropTitlePlugin.html | 2 +- book/en/apis/core/ElementWrapper.html | 2 +- book/en/apis/core/EventDispatcher.html | 2 +- book/en/apis/core/Grid.html | 2 +- book/en/apis/core/HScrollbar.html | 2 +- book/en/apis/core/ILayoutGrid.html | 2 +- book/en/apis/core/LayoutGrid.html | 2 +- book/en/apis/core/Scrollbar.html | 2 +- book/en/apis/core/SectionSettings.html | 2 +- book/en/apis/core/Segment.html | 2 +- book/en/apis/core/SegmentCollection.html | 2 +- book/en/apis/core/SortableTitlePlugin.html | 2 +- book/en/apis/core/VScrollbar.html | 2 +- book/en/apis/rt_grid/ColumnDefinition.html | 2 +- book/en/apis/rt_grid/Grid.html | 2 +- book/en/apis/rt_grid/RowDefinition.html | 2 +- book/en/columns/column-alignment.html | 2 +- book/en/columns/column-formatter.html | 2 +- book/en/columns/column-freezing.html | 2 +- book/en/columns/column-grouping.html | 2 +- book/en/columns/column-moving.html | 2 +- book/en/columns/column-pinning.html | 2 +- book/en/columns/column-reordering.html | 2 +- book/en/columns/column-resetting.html | 2 +- book/en/columns/column-styling.html | 2 +- book/en/columns/column-width.html | 2 +- book/en/columns/custom-title-formatter.html | 2 +- .../en/columns/dynamic-add-insert-column.html | 2 +- book/en/columns/dynamic-remove-column.html | 2 +- book/en/data/columns-and-data.html | 2 +- book/en/data/create.html | 2 +- book/en/data/data-conversion.html | 2 +- book/en/data/delete.html | 2 +- book/en/data/read.html | 2 +- book/en/data/update.html | 2 +- book/en/extensions/README.html | 2 +- book/en/extensions/column-dragging.html | 2 +- book/en/extensions/row-segmenting.html | 11 +- book/en/extensions/row-segmenting.md | 7 +- book/en/extensions/statistics-row.html | 2 +- book/en/extensions/tr-grid-auto-tooltip.html | 2 +- .../en/extensions/tr-grid-cell-selection.html | 2 +- book/en/extensions/tr-grid-checkbox.html | 2 +- book/en/extensions/tr-grid-column-fitter.html | 2 +- .../extensions/tr-grid-column-formatting.html | 6 +- .../extensions/tr-grid-column-formatting.md | 2 +- .../extensions/tr-grid-column-grouping.html | 2 +- .../extensions/tr-grid-column-resizing.html | 2 +- .../extensions/tr-grid-column-selection.html | 2 +- book/en/extensions/tr-grid-column-stack.html | 2 +- .../tr-grid-conditional-coloring.html | 2 +- book/en/extensions/tr-grid-content-wrap.html | 2 +- book/en/extensions/tr-grid-contextmenu.html | 2 +- book/en/extensions/tr-grid-filter-input.html | 2 +- book/en/extensions/tr-grid-heat-map.html | 2 +- .../extensions/tr-grid-in-cell-editing.html | 18 +- book/en/extensions/tr-grid-in-cell-editing.md | 4 +- book/en/extensions/tr-grid-pagination.html | 2 +- book/en/extensions/tr-grid-percent-bar.html | 2 +- book/en/extensions/tr-grid-range-bar.html | 2 +- book/en/extensions/tr-grid-row-dragging.html | 2 +- book/en/extensions/tr-grid-row-filtering.html | 4 +- book/en/extensions/tr-grid-row-filtering.md | 2 +- book/en/extensions/tr-grid-row-grouping.html | 2 +- book/en/extensions/tr-grid-row-selection.html | 2 +- book/en/extensions/tr-grid-rowcoloring.html | 2 +- .../en/extensions/tr-grid-textformatting.html | 2 +- book/en/extensions/tr-grid-titlewrap.html | 2 +- book/en/extensions/zoom.html | 2 +- book/en/filtering/custom-filter.html | 2 +- .../filtering/filtering-auto-filter-row.html | 2 +- book/en/filtering/filtering-get-reset.html | 2 +- .../filtering/filtering-programmatically.html | 2 +- book/en/general_concept/accessing-data.html | 2 +- book/en/general_concept/basic.html | 2 +- book/en/general_concept/disposing-grid.html | 2 +- book/en/general_concept/event-listeners.html | 2 +- .../en/general_concept/initializing-data.html | 2 +- book/en/getting_started/angular_guide.html | 4 +- book/en/getting_started/angular_guide.md | 2 +- book/en/getting_started/overview.html | 2 +- book/en/getting_started/react_guide.html | 4 +- book/en/getting_started/react_guide.md | 2 +- book/en/getting_started/typescript.html | 4 +- book/en/getting_started/typescript.md | 2 +- book/en/index.html | 6 +- book/en/license.html | 2 +- book/en/migrating/from-emerald-grid.html | 2 +- book/en/misc/core-apis.html | 2 +- book/en/misc/fifty-thosand-rows.html | 2 +- book/en/misc/loading-mask.html | 2 +- book/en/misc/pagination.html | 2 +- book/en/misc/row-expansion.html | 2 +- book/en/misc/row-span.html | 2 +- book/en/misc/text-selection.html | 2 +- .../row-segmenting/dist/row-segmenting.min.js | 2 +- .../dist/tr-grid-column-formatting.min.js | 2 +- .../dist/tr-grid-column-grouping.min.js | 2 +- .../dist/tr-grid-column-stack.min.js | 2 +- .../dist/tr-grid-in-cell-editing.min.js | 2 +- .../dist/tr-grid-row-filtering.min.js | 2 +- .../dist/tr-grid-row-grouping.min.js | 2 +- .../dist/elf-halo-light.js | 64068 ++++++++-------- book/en/rendering/change-formatter.html | 2 +- book/en/rendering/column-formatter.html | 2 +- book/en/rendering/custom-formatter.html | 2 +- .../rendering/formatter-event-handling.html | 2 +- book/en/rendering/predefined-formatter.html | 2 +- .../ef-button-formatter.html | 2 +- .../ef-checkbox-formatter.html | 2 +- .../ef-combo-box-formatter.html | 2 +- .../ef-datetime-picker-formatter.html | 2 +- .../ef-icon-formatter.html | 2 +- .../ef-number-field-formatter.html | 2 +- .../ef-radio-button-formatter.html | 2 +- .../ef-select-formatter.html | 2 +- .../ef-text-field-formatter.html | 2 +- .../ef-toggle-formatter.html | 2 +- .../percent-bar-formatter.html | 2 +- .../simple-image-formatter.html | 2 +- .../simple-input-formatter.html | 2 +- .../simple-link-formatter.html | 2 +- .../simple-ticker-formatter.html | 2 +- .../simple-toggle-formatter.html | 2 +- .../predefined_formatters/text-formatter.html | 2 +- book/en/rows/add-header-footer.html | 2 +- book/en/rows/row-grouping.html | 2 +- book/en/rows/row-height.html | 2 +- book/en/rows/row-highlight-selection.html | 2 +- book/en/rows/row-reordering.html | 2 +- book/en/rows/row-show-hide.html | 2 +- book/en/scrollbars/horizontal-scrollbar.html | 2 +- .../scrollbars/left-side-column-pinning.html | 2 +- .../en/scrollbars/non-overlap-scrollbars.html | 2 +- .../scrollbars/right-side-column-pinning.html | 2 +- book/en/scrollbars/scroll-speed.html | 2 +- book/en/scrollbars/scrollbar-visibility.html | 2 +- book/en/scrollbars/vertical-scrollbar.html | 2 +- book/en/search.index.js | 2 +- book/en/showcases/comprehensive.html | 2 +- book/en/sorting/custom-sort-logic.html | 2 +- book/en/sorting/default-sorting.html | 2 +- book/en/sorting/multi-column-sorting.html | 2 +- book/en/sorting/server-side-sorting.html | 2 +- book/en/sorting/sorting-get-reset.html | 2 +- book/en/sorting/sorting.html | 2 +- book/en/support.html | 2 +- book/en/utilities/data-generator.html | 2 +- book/en/utilities/multi-table.html | 2 +- book/en/utilities/native-table.html | 2 +- book/en/utilities/printing.html | 2 +- book/en/widgets/column-format-dialog.html | 2 +- book/en/widgets/column-selection-dialog.html | 2 +- book/en/widgets/filter-dialog.html | 2 +- book/en/widgets/language-support.html | 2 +- 163 files changed, 32549 insertions(+), 31893 deletions(-) diff --git a/book/en/README.md b/book/en/README.md index b6924eaa..05aa9441 100644 --- a/book/en/README.md +++ b/book/en/README.md @@ -7,13 +7,13 @@ Grid has been created to handle a large number of rows. It achieves high perform EFX Grid element and extensions are published under single package. ```sh -npm install @refinitiv-ui/efx-grid --save-dev +npm install @refinitiv-ui/efx-grid ``` The element is required theme to instantiate itself in the app. Refinitiv's design system is called Halo theme and you can install it from npm command. ```sh -npm install @refinitiv-ui/halo-theme --save-dev +npm install @refinitiv-ui/halo-theme ``` ## Setup guide diff --git a/book/en/apis/README.html b/book/en/apis/README.html index b9b2278d..9d931631 100644 --- a/book/en/apis/README.html +++ b/book/en/apis/README.html @@ -29,7 +29,7 @@

Grid Usage Guide

+

SegmentId field

+

If you intend to apply a segment separator using the segmentId field during runtime, whenever the row data is updated, it is necessary to call the requestSeparatorRefresh function to forcefully render the user interface (UI). This step ensures that the changes are reflected in the UI, allowing for an accurate representation of the updated segment separators.

+

Currently, you can set the segment separator for the grid in two ways. The first method is by using the grid API through the setSegmentSeparator function. The second method involves setting the segmentId field in the row data. However, we strongly advise against using both methods simultaneously. Please choose one approach that suits your needs, keeping in mind that the user interface will appear similar regardless of the method chosen.

Empty segment filtering

By default, segment header cannot be filtered out. However, Row Filtering Extension has emptySegmentFiltering option that allows empty segment to be filtered out. With the option turned on, any segment whose all of its members are not present by filtering will also be hidden. Empty segment will still be visible, if there is no active filter. Collapsing of the segment does not count as having an active filter.

@@ -1756,6 +1759,12 @@
Parameters:
+
+
function
+

requestSeparatorRefresh()

+
request to set the segment separator with the segment ID field in row data
+
+
function

setPredefinedColors(predefinedColors)

diff --git a/book/en/extensions/row-segmenting.md b/book/en/extensions/row-segmenting.md index b4b4d998..137adf32 100644 --- a/book/en/extensions/row-segmenting.md +++ b/book/en/extensions/row-segmenting.md @@ -720,6 +720,11 @@ And then you can paste this config on the example 2 and click "Start Grid" and b ``` +### SegmentId field + +If you intend to apply a segment separator using the `segmentId` field during runtime, whenever the row data is updated, it is necessary to call the `requestSeparatorRefresh` function to forcefully render the user interface (UI). This step ensures that the changes are reflected in the UI, allowing for an accurate representation of the updated segment separators. + +Currently, you can set the segment separator for the grid in two ways. The first method is by using the grid API through the `setSegmentSeparator` function. The second method involves setting the `segmentId` field in the row data. However, we strongly advise against using both methods simultaneously. Please choose one approach that suits your needs, keeping in mind that the user interface will appear similar regardless of the method chosen. ### Empty segment filtering By default, segment header cannot be filtered out. However, Row Filtering Extension has `emptySegmentFiltering` option that allows empty segment to be filtered out. With the option turned on, any segment whose all of its members are not present by filtering will also be hidden. Empty segment will still be visible, if there is no active filter. Collapsing of the segment does not count as having an active filter. @@ -787,4 +792,4 @@ By default, segment header cannot be filtered out. However, Row Filtering Extens

API Reference

-

Type Definitions

typedef

Options

The options can be specified by `rowSegmenting` property of the main grid's options
Type:
Object
Properties:
Name Type Attributes Default Description
spanning boolean <optional>
true If disabled, segment separator rows will not be spanned/stretched across multiple cells
colorTag boolean <optional>
If not specified, the color tag will be disabled when using extension without halo theme.
cssField string <optional>
"TAG_CSS_CLASS" Apply CSS class based on the given field
predefinedColors Object <optional>
Predefined color object map for color tag
clicked function <optional>
null Event handler when user clicks on arrows or cells
headerMenuClicked function <optional>
null Event handler when user clicks on menu icon. The menu icon will be displayed if spanning option is true.
segmentSeparatorBinding function <optional>
null Logic that will be executed on each segment separator row
nonSegmentSeparatorBinding function <optional>
null Logic that will be executed for all non segment separator row
sortingLogic function <optional>
null Logic to be used by sortSegments method
rowSpanningField string <optional>
"ROW_SPANNING" selected field for apply row spanning in row separator
segmentIdField string <optional>
"SEGMENT_ID" selected field for set segment separator row
typedef

SortingLogic(rowDataA, rowDataB) → {number}

Comparer function for comparing the order of 2 segment separator rows. The function takes at least 2 parameters.
The function should return -1 if the first parameter should comes first, 1 for the other way, and 0 if they are equal.
Parameters:
rowDataA
Object
Row data of the segment separator row
rowDataB
Object
Row data of the segment separator row
Returns:
number

Methods

function

addSegmentChild(segmentRef, rowRef)

Parameters:
segmentRef
string | number
Row id or row index
rowRef
string | number
Row id, row index
function

addSegmentChildren(segmentRef, rowRefs)

Parameters:
segmentRef
string | number
Row id or row index
rowRefs
Array.<(string|number)>
Array of row ids or row indices. If null is given, no child will be removed.
function

collapseSegment(rowRef, collapsedopt) → {boolean}

Hide all members in the segment
Parameters:
rowRef
string | number
Row id or row index of the segment separator
collapsed
boolean
<optional>
Returns:
boolean
Return true if there is any change
function

config(optionsopt)

Parameters:
options
Object
<optional>
Grid configuration object
function

expandAllSegments() → {boolean}

Returns:
boolean
Return true if there is any change
function

expandSegment(rowRef, expandedopt) → {boolean}

Parameters:
rowRef
string | number
Row id or row index
expanded
boolean
<optional>
Returns:
boolean
Return true if there is any change
function

fillSegment(segmentRef)

Remove existing segment children and fill the segments with all contnet rows before the next segment separator
Parameters:
segmentRef
string | number
Row id or row index
function

fillSegments()

Remove all existing segment children in each segment and fill the segments with all contnet rows before the next segment separator
function

getConfigObject(gridOptionsopt) → {Object}

Parameters:
gridOptions
Object
<optional>
Returns:
Object
function

getName() → {string}

Returns:
string
function

getRowConfigObject(rowData, rowId) → {Object}

Parameters:
rowData
Object
row config object
rowId
string
Returns:
Object
return row config object with update special field data
function

getSegmentChildIds(segmentRef) → {Array.<string>}

Get row ids of all children from the specified segment
Parameters:
segmentRef
string | number
Row id or row index
Returns:
Array.<string>
Returns array of row ids. Returns null if there is no child or no segment separator found
function

getSegmentIds() → {Array.<string>}

Get row ids of all segment separator
Returns:
Array.<string>
Return null if there is no segment separator
function

getSegmentParentRowId(rowRef) → {string}

Parameters:
rowRef
string | number
Row Id or row index
Returns:
string
parent row id of this segmentation. If the parent row id for this segmentation cannot be found, return ""
function

hasMultiTableSupport() → {boolean}

Plugin that has multi-table support means that it can have multiple hosts/tables and share its states across those hosts/tables.
Returns:
boolean
function

hasSegmentation() → {boolean}

Check if there is at least one segment separator in the data view
Returns:
boolean
function

initialize(host, optionsopt)

Parameters:
host
Object
core grid instance
options
Object
<optional>
function

isSegmentCollapsed(rowRef) → {boolean}

Parameters:
rowRef
string | number
Row id or row index
Returns:
boolean
Return true if only the given row is a collapsed segment separator
function

isSegmentSeparator(rowRef) → {boolean}

Check if the specified row is a segment separator
Parameters:
rowRef
string | number
Row id or row index (not recommended for usage)
Returns:
boolean
function

removeAllSegmentChildren()

function

removeSegmentChild(segmentRef, rowRef)

Parameters:
segmentRef
string | number
Row id or row index
rowRef
string | number
Row id, row index
function

removeSegmentChildren(segmentRef, rowRefs)

Parameters:
segmentRef
string | number
Row id or row index
rowRefs
Array.<(string|number)>
Array of row ids or row indices
function

setPredefinedColors(predefinedColors)

Parameters:
predefinedColors
Object
Predefined color object map
function

setSegmentClassification(rowRef, fields) → {boolean}

Set classification for the specified segment
Parameters:
rowRef
string | number
Row id or row index
fields
string | Array.<string>
Returns:
boolean
function

setSegmentCollapsingLogic(func)

Parameters:
func
function
By default, all row members are hidden in a collapsed segment
function

setSegmentSeparator(rowRef, enabledopt) → {boolean}

Set specified row as a segment separator
Parameters:
rowRef
string | number
Row id or row index
enabled
boolean
<optional>
Returns:
boolean
Return true if there is any change
function

setSortingLogic(sortFunction)

Parameters:
function

sortSegments(sortFunctionopt)

Parameters:
sortFunction
<optional>
function

spanSegmentSeparator(rowRef, spanning)

Parameters:
rowRef
number | string
rowIndex or rowId
spanning
boolean | null
if set true when rowRef is row separator, then span that row
function

unload(hostopt)

Parameters:
host
Object
<optional>
core grid instance
function

unsetAllSegmentSeparators() → {boolean}

Clear all segment separator rows
Returns:
boolean
Return true if there is any change
function

updateHeaders()

\ No newline at end of file +

Type Definitions

typedef

Options

The options can be specified by `rowSegmenting` property of the main grid's options
Type:
Object
Properties:
Name Type Attributes Default Description
spanning boolean <optional>
true If disabled, segment separator rows will not be spanned/stretched across multiple cells
colorTag boolean <optional>
If not specified, the color tag will be disabled when using extension without halo theme.
cssField string <optional>
"TAG_CSS_CLASS" Apply CSS class based on the given field
predefinedColors Object <optional>
Predefined color object map for color tag
clicked function <optional>
null Event handler when user clicks on arrows or cells
headerMenuClicked function <optional>
null Event handler when user clicks on menu icon. The menu icon will be displayed if spanning option is true.
segmentSeparatorBinding function <optional>
null Logic that will be executed on each segment separator row
nonSegmentSeparatorBinding function <optional>
null Logic that will be executed for all non segment separator row
sortingLogic function <optional>
null Logic to be used by sortSegments method
rowSpanningField string <optional>
"ROW_SPANNING" selected field for apply row spanning in row separator
segmentIdField string <optional>
"SEGMENT_ID" selected field for set segment separator row
typedef

SortingLogic(rowDataA, rowDataB) → {number}

Comparer function for comparing the order of 2 segment separator rows. The function takes at least 2 parameters.
The function should return -1 if the first parameter should comes first, 1 for the other way, and 0 if they are equal.
Parameters:
rowDataA
Object
Row data of the segment separator row
rowDataB
Object
Row data of the segment separator row
Returns:
number

Methods

function

addSegmentChild(segmentRef, rowRef)

Parameters:
segmentRef
string | number
Row id or row index
rowRef
string | number
Row id, row index
function

addSegmentChildren(segmentRef, rowRefs)

Parameters:
segmentRef
string | number
Row id or row index
rowRefs
Array.<(string|number)>
Array of row ids or row indices. If null is given, no child will be removed.
function

collapseSegment(rowRef, collapsedopt) → {boolean}

Hide all members in the segment
Parameters:
rowRef
string | number
Row id or row index of the segment separator
collapsed
boolean
<optional>
Returns:
boolean
Return true if there is any change
function

config(optionsopt)

Parameters:
options
Object
<optional>
Grid configuration object
function

expandAllSegments() → {boolean}

Returns:
boolean
Return true if there is any change
function

expandSegment(rowRef, expandedopt) → {boolean}

Parameters:
rowRef
string | number
Row id or row index
expanded
boolean
<optional>
Returns:
boolean
Return true if there is any change
function

fillSegment(segmentRef)

Remove existing segment children and fill the segments with all contnet rows before the next segment separator
Parameters:
segmentRef
string | number
Row id or row index
function

fillSegments()

Remove all existing segment children in each segment and fill the segments with all contnet rows before the next segment separator
function

getConfigObject(gridOptionsopt) → {Object}

Parameters:
gridOptions
Object
<optional>
Returns:
Object
function

getName() → {string}

Returns:
string
function

getRowConfigObject(rowData, rowId) → {Object}

Parameters:
rowData
Object
row config object
rowId
string
Returns:
Object
return row config object with update special field data
function

getSegmentChildIds(segmentRef) → {Array.<string>}

Get row ids of all children from the specified segment
Parameters:
segmentRef
string | number
Row id or row index
Returns:
Array.<string>
Returns array of row ids. Returns null if there is no child or no segment separator found
function

getSegmentIds() → {Array.<string>}

Get row ids of all segment separator
Returns:
Array.<string>
Return null if there is no segment separator
function

getSegmentParentRowId(rowRef) → {string}

Parameters:
rowRef
string | number
Row Id or row index
Returns:
string
parent row id of this segmentation. If the parent row id for this segmentation cannot be found, return ""
function

hasMultiTableSupport() → {boolean}

Plugin that has multi-table support means that it can have multiple hosts/tables and share its states across those hosts/tables.
Returns:
boolean
function

hasSegmentation() → {boolean}

Check if there is at least one segment separator in the data view
Returns:
boolean
function

initialize(host, optionsopt)

Parameters:
host
Object
core grid instance
options
Object
<optional>
function

isSegmentCollapsed(rowRef) → {boolean}

Parameters:
rowRef
string | number
Row id or row index
Returns:
boolean
Return true if only the given row is a collapsed segment separator
function

isSegmentSeparator(rowRef) → {boolean}

Check if the specified row is a segment separator
Parameters:
rowRef
string | number
Row id or row index (not recommended for usage)
Returns:
boolean
function

removeAllSegmentChildren()

function

removeSegmentChild(segmentRef, rowRef)

Parameters:
segmentRef
string | number
Row id or row index
rowRef
string | number
Row id, row index
function

removeSegmentChildren(segmentRef, rowRefs)

Parameters:
segmentRef
string | number
Row id or row index
rowRefs
Array.<(string|number)>
Array of row ids or row indices
function

requestSeparatorRefresh()

request to set the segment separator with the segment ID field in row data
function

setPredefinedColors(predefinedColors)

Parameters:
predefinedColors
Object
Predefined color object map
function

setSegmentClassification(rowRef, fields) → {boolean}

Set classification for the specified segment
Parameters:
rowRef
string | number
Row id or row index
fields
string | Array.<string>
Returns:
boolean
function

setSegmentCollapsingLogic(func)

Parameters:
func
function
By default, all row members are hidden in a collapsed segment
function

setSegmentSeparator(rowRef, enabledopt) → {boolean}

Set specified row as a segment separator
Parameters:
rowRef
string | number
Row id or row index
enabled
boolean
<optional>
Returns:
boolean
Return true if there is any change
function

setSortingLogic(sortFunction)

Parameters:
function

sortSegments(sortFunctionopt)

Parameters:
sortFunction
<optional>
function

spanSegmentSeparator(rowRef, spanning)

Parameters:
rowRef
number | string
rowIndex or rowId
spanning
boolean | null
if set true when rowRef is row separator, then span that row
function

unload(hostopt)

Parameters:
host
Object
<optional>
core grid instance
function

unsetAllSegmentSeparators() → {boolean}

Clear all segment separator rows
Returns:
boolean
Return true if there is any change
function

updateHeaders()

\ No newline at end of file diff --git a/book/en/extensions/statistics-row.html b/book/en/extensions/statistics-row.html index ce6b3f07..5d7ff504 100644 --- a/book/en/extensions/statistics-row.html +++ b/book/en/extensions/statistics-row.html @@ -29,7 +29,7 @@

Grid Usage Guide