diff --git a/apiMap/Blazor/webInputs.JS.blazor.apiMap.json b/apiMap/Blazor/webInputs.JS.blazor.apiMap.json index 407989d3f..f66a93b6b 100644 --- a/apiMap/Blazor/webInputs.JS.blazor.apiMap.json +++ b/apiMap/Blazor/webInputs.JS.blazor.apiMap.json @@ -79,6 +79,19 @@ "members":[ {"names":[{"platform": "Blazor", "mappedType": "IgbActiveStepChangingArgsDetail","mappedName": "Detail"}], "originalName": "Detail"} ] }, + { + "originalName": "Banner", + "originalNamespace": "Infragistics.Controls", + "originalBaseTypeNamespace": "Infragistics.Controls", + "originalBaseTypeName": "BaseElement", + "packageName": "igniteui-webinputs", + "names":[{"platform": "Blazor","fileName": "Banner.cs","mappedName": "IgbBanner"}], + "members":[ + {"names":[{"platform": "Blazor", "mappedType": "boolean", "mappedName": "open"}], "originalName": "Open"}, + {"names":[{"platform": "Blazor", "mappedType": "method", "mappedName": "show"}], "originalName": "Show"}, + {"names":[{"platform": "Blazor", "mappedType": "method", "mappedName": "hide"}], "originalName": "Hide"}, + {"names":[{"platform": "Blazor", "mappedType": "method", "mappedName": "toggle"}], "originalName": "Toggle"} ] + }, { "originalName": "BaseAlertLike", "originalNamespace": "Infragistics.Controls", diff --git a/apiMap/React/webInputs.JS.r.apiMap.json b/apiMap/React/webInputs.JS.r.apiMap.json index c4a3b0c1a..460d1d845 100644 --- a/apiMap/React/webInputs.JS.r.apiMap.json +++ b/apiMap/React/webInputs.JS.r.apiMap.json @@ -3,6 +3,7 @@ "igr-accordion-module.ts", "igr-avatar-module.ts", "igr-badge-module.ts", + "igr-banner-module.ts", "igr-base-alert-like-module.ts", "igr-base-combo-box-like-module.ts", "igr-base-option-like-module.ts", @@ -157,6 +158,19 @@ "members":[ {"names":[{"platform": "React", "mappedType": "IgrActiveStepChangingArgsDetail","mappedName": "detail"}], "originalName": "Detail"} ] }, + { + "originalName": "Banner", + "originalNamespace": "Infragistics.Controls", + "originalBaseTypeNamespace": "Infragistics.Controls", + "originalBaseTypeName": "BaseElement", + "packageName": "igniteui-webinputs", + "names":[{"platform": "React","fileName": "igr-banner-component.ts","mappedName": "IgrBanner"}], + "members":[ + {"names":[{"platform": "React", "mappedType": "boolean", "mappedName": "open"}], "originalName": "Open"}, + {"names":[{"platform": "React", "mappedType": "method", "mappedName": "show"}], "originalName": "Show"}, + {"names":[{"platform": "React", "mappedType": "method", "mappedName": "hide"}], "originalName": "Hide"}, + {"names":[{"platform": "React", "mappedType": "method", "mappedName": "toggle"}], "originalName": "Toggle"} ] + }, { "originalName": "BaseAlertLike", "originalNamespace": "Infragistics.Controls", diff --git a/apiMap/WebComponents/webInputs.JS.wc.apiMap.json b/apiMap/WebComponents/webInputs.JS.wc.apiMap.json index 7aff31d31..06f8ee3c0 100644 --- a/apiMap/WebComponents/webInputs.JS.wc.apiMap.json +++ b/apiMap/WebComponents/webInputs.JS.wc.apiMap.json @@ -3,6 +3,7 @@ "igc-accordion-module.ts", "igc-avatar-module.ts", "igc-badge-module.ts", + "igc-banner-module.ts", "igc-base-alert-like-module.ts", "igc-base-combo-box-like-module.ts", "igc-base-option-like-module.ts", @@ -22,8 +23,10 @@ "igc-circular-gradient-module.ts", "igc-circular-progress-module.ts", "igc-combo-module.ts", + "igc-date-picker-module.ts", "igc-date-time-input-module.ts", "igc-dialog-module.ts", + "igc-divider-module.ts", "igc-dock-manager-module.ts", "igc-dropdown-group-module.ts", "igc-dropdown-header-module.ts", @@ -157,6 +160,19 @@ "members":[ {"names":[{"platform": "WebComponents", "mappedType": "IgcActiveStepChangingArgsDetail","mappedName": "detail"}], "originalName": "Detail"} ] }, + { + "originalName": "Banner", + "originalNamespace": "Infragistics.Controls", + "originalBaseTypeNamespace": "Infragistics.Controls", + "originalBaseTypeName": "BaseElement", + "packageName": "igniteui-webinputs", + "names":[{"platform": "WebComponents","fileName": "igc-banner-component.ts","mappedName": "IgcBannerComponent"}], + "members":[ + {"names":[{"platform": "WebComponents", "mappedType": "boolean", "mappedName": "open"}], "originalName": "Open"}, + {"names":[{"platform": "WebComponents", "mappedType": "method", "mappedName": "show"}], "originalName": "Show"}, + {"names":[{"platform": "WebComponents", "mappedType": "method", "mappedName": "hide"}], "originalName": "Hide"}, + {"names":[{"platform": "WebComponents", "mappedType": "method", "mappedName": "toggle"}], "originalName": "Toggle"} ] + }, { "originalName": "BaseAlertLike", "originalNamespace": "Infragistics.Controls", @@ -348,6 +364,18 @@ {"names":[{"platform": "WebComponents", "mappedType": "string", "mappedName": "title"}], "originalName": "Title"}, {"names":[{"platform": "WebComponents", "mappedType": "method", "mappedName": "toggle"}], "originalName": "Toggle"} ] }, +{ + "originalName": "Divider", + "originalNamespace": "Infragistics.Controls", + "originalBaseTypeNamespace": "Infragistics.Controls", + "originalBaseTypeName": "BaseElement", + "packageName": "igniteui-webinputs", + "names":[{"platform": "WebComponents","fileName": "igc-divider-component.ts","mappedName": "IgcDividerComponent"}], + "members":[ + {"names":[{"platform": "WebComponents", "mappedType": "boolean", "mappedName": "middle"}], "originalName": "Middle"}, + {"names":[{"platform": "WebComponents", "mappedType": "string", "mappedName": "type"}], "originalName": "Type"}, + {"names":[{"platform": "WebComponents", "mappedType": "boolean", "mappedName": "vertical"}], "originalName": "Vertical"} ] + }, { "originalName": "ExpansionPanel", "originalNamespace": "Infragistics.Controls", @@ -1531,6 +1559,26 @@ {"names":[{"platform": "WebComponents", "mappedType": "Date[]","mappedName": "values"}], "originalName": "Values"}, {"names":[{"platform": "WebComponents", "mappedType": "number", "mappedName": "visibleMonths"}], "originalName": "VisibleMonths"} ] }, + { + "originalName": "DatePicker", + "originalNamespace": "Infragistics.Controls", + "originalBaseTypeNamespace": "Infragistics.Controls", + "originalBaseTypeName": "BaseElement", + "packageName": "igniteui-webinputs", + "names":[{"platform": "WebComponents","fileName": "igc-date-picker-component.ts","mappedName": "IgcDatePickerComponent"}], + "members":[ + {"names":[{"platform": "WebComponents", "mappedType": "Date","mappedName": "activeDate"}], "originalName": "ActiveDate"}, + {"names":[{"platform": "WebComponents", "mappedType": "Date","mappedName": "min"}], "originalName": "Min"}, + {"names":[{"platform": "WebComponents", "mappedType": "Date","mappedName": "max"}], "originalName": "Max"}, + {"names":[{"platform": "WebComponents", "mappedType": "string","mappedName": "inputFormat"}], "originalName": "InputFormat"}, + {"names":[{"platform": "WebComponents", "mappedType": "string","mappedName": "displayFormat"}], "originalName": "DisplayFormat"}, + {"names":[{"platform": "WebComponents", "mappedType": "string","mappedName": "locale"}], "originalName": "Locale"}, + {"names":[{"platform": "WebComponents", "mappedType": "number","mappedName": "visibleMonths"}], "originalName": "VisibleMonths"}, + {"names":[{"platform": "WebComponents", "mappedType": "boolean","mappedName": "showWeekNumbers"}], "originalName": "ShowWeekNumbers"}, + {"names":[{"platform": "WebComponents", "mappedType": "DatePickerWeekStart","mappedName": "weekStart"}], "originalName": "WeekStart"}, + {"names":[{"platform": "WebComponents", "mappedType": "method","mappedName": "stepDown"}], "originalName": "StepDown"}, + {"names":[{"platform": "WebComponents", "mappedType": "method","mappedName": "stepUp"}], "originalName": "StepUp"} ] + }, { "originalName": "DateRangeDescriptor", "originalNamespace": "Infragistics.Controls", diff --git a/doc/en/components/charts/features/chart-axis-options.md b/doc/en/components/charts/features/chart-axis-options.md index cfe67753c..ecaef3f6c 100644 --- a/doc/en/components/charts/features/chart-axis-options.md +++ b/doc/en/components/charts/features/chart-axis-options.md @@ -31,7 +31,7 @@ The {Platform} Charts allows you full control over configuring, formatting, and
-## Axis Labels Management +## Axis Labels Management & Formatting The axes of the chart have the ability to perform an enhanced calculation regarding the amount of space available to the labels of the owning axis. This enhanced calculation allows the axis to optimize the amount of space given to it in order to display more labels for the given axis. @@ -41,7 +41,7 @@ The chart also has the ability to consider auto-rotation of the labels if they w After setting the `AutoMarginAndAngleUpdateMode`, you can set the `ShouldAutoExpandMarginForInitialLabels` property to true to opt into the automatic margin or set the `ShouldConsiderAutoRotationForInitialLabels` property to true for the auto-rotation. You can also further customize the automatic margin that is applied by setting the `AutoExpandMarginExtraPadding` and `AutoExpandMarginMaximumValue` to provide extra space or a maximum possible margin, respectively. -Custom label formats such as `NumberFormatSpecifier` and `DateTimeFormatSpecifier` can be added to each axis via the `XAxisLabelFormatSpecifier` and `YAxisLabelFormatSpecifier` collections. Commonly used for applying Intl.NumberFormat and Intl.DateTimeFormat language sensitive number, date and time formatting. In order for a custom format to be applied to the labels, the `YAxisLabelFormat` or `XAxisLabelFormat` need to be set to `{0}` on the `CategoryChart`. +Custom label formats such as `NumberFormatSpecifier` and `DateTimeFormatSpecifier` can be added to each axis via the `XAxisLabelFormatSpecifier` and `YAxisLabelFormatSpecifier` collections. Commonly used for applying Intl.NumberFormat and Intl.DateTimeFormat language sensitive number, date and time formatting. In order for a custom format to be applied to the labels, the `YAxisLabelFormat` or `XAxisLabelFormat` need to be set to data item's property name on the `CategoryChart`, eg. `{Date}`. For the `FinancialChart` the number is the context because it uses a numeric axis, therefore this needs to be set to `{0}`. The following example formats the yAxis with a `NumberFormatSpecifier` to reprerent $USD prices for top box office movies in the United States. diff --git a/doc/en/components/charts/features/chart-axis-types.md b/doc/en/components/charts/features/chart-axis-types.md index 0c6a24a80..5093a6722 100644 --- a/doc/en/components/charts/features/chart-axis-types.md +++ b/doc/en/components/charts/features/chart-axis-types.md @@ -116,6 +116,16 @@ The following example demonstrates usage of the `CategoryAngleAxis` type: `sample="/charts/data-chart/radial-area-chart", height="500", alt="{Platform} Category Angle Axis Example"` + ### Proportional Category Angle Axis + +The `ProportionalCategoryAngleAxis` treats its data as a sequence of category data items. The labels on this axis are placed along the edge of a circle according to their position in that sequence. This type of axis can display almost any type of data including strings and numbers. + +The `ProportionalCategoryAngleAxis` is generally used with the `NumericRadiusAxis` to plot a pie chart eg. [Radial Series](../types/radial-chart.md). + +The following example demonstrates usage of the `ProportionalCategoryAngleAxis` type: + + `sample="/charts/data-chart/radial-proportional-category-angle-axis", height="500", alt="{Platform} Proportional Category Angle Axis Example"` + ### Numeric Angle Axis The `NumericAngleAxis` treats its data as continuously varying numerical data items. The labels on this axis area placed along a radius line starting from the center of the circular plot. The location of the labels on the `NumericAngleAxis` varies according to the value in the data column mapped using the `RadiusMemberPath` property of the [Polar Series](../types/polar-chart.md) object or the `ValueMemberPath` property of the [Radial Series](../types/radial-chart.md) object. diff --git a/doc/en/components/charts/features/chart-data-selection.md b/doc/en/components/charts/features/chart-data-selection.md index 7c60d1b5f..1aed1f756 100644 --- a/doc/en/components/charts/features/chart-data-selection.md +++ b/doc/en/components/charts/features/chart-data-selection.md @@ -67,6 +67,19 @@ This example demonstrates another series type via the `XamDataChart` where each `sample="/charts/data-chart/radial-column-chart-selection", height="450", alt="{Platform} Radial Column Chart Selection Multiple Modes Example"` +## Programmatic Selection +Chart Selection can also be configured in code where selected items in the chart can be seen on startup or runtime. This can be achieved by adding items to the `SelectedSeriesCollection` of the `CategoryChart`. The `Matcher` property of the `ChartSelection` object allows for selecting a series based on a "matcher", ideal when you do not have access to the actual series from the chart. If you know the properties that your datasource contains, you can use the `ValueMemberPath` that the series would be. + +The matcher is ideal for using in charts, such as the `CategoryChart` when you do not have access to the actual series, like the `XamDataChart`. In this case you if you know the properties that your datasource contained you can surmise the ValueMemberPaths that the series would have. For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to highlight the series bound to Solar values, you can add a ChartSelection object to the `SelectedSeriesItems` collection using a matcher with the following properties set + +For example, if you datasource has numeric properties Nuclear, Coal, Oil, Solar then you know there are series created for each of these properties. If you want to select the series bound to Solar values, you can add a ChartSelection object to the SelectedSeriesItems collection using a matcher with the following properties set. + + + + `sample="/charts/category-chart/selection-matcher", height="500", alt="{Platform} Selection Matcher"` + + + ## API References The following is a list of API members mentioned in the above sections: diff --git a/doc/en/components/charts/types/data-pie-chart.md b/doc/en/components/charts/types/data-pie-chart.md new file mode 100644 index 000000000..d80f5b840 --- /dev/null +++ b/doc/en/components/charts/types/data-pie-chart.md @@ -0,0 +1,183 @@ +--- +title: {Platform} Pie Charts and Graphs | {ProductName} +_description: The {ProductName} data pie chart is a specialized UI control that renders a pie chart, consisting of a circular area divided into sections. Try for FREE. +_keywords: {Platform} charts, pie chart, {ProductName}, Infragistics, data binding, slice selection, animation, highlighting, legend +mentionedTypes: ["XamDataPieChart", "XamDataChart"] +namespace: Infragistics.Controls.Charts +--- +# {Platform} Data Pie Chart + +The {ProductName} Data Pie Chart is a part-to-whole chart that shows how categories (parts) of a data set add up to a total (whole) value. Categories are rendered as sections in a circular, or pie-shaped graph. Each section, or pie slice, has an arc length proportional to its underlying data value. Categories are shown in proportion to other categories based on their value percentage to the total value being analyzed, as parts of 100 or 100%. + +## {Platform} Data Pie Chart Example + +You can create the {Platform} Pie Chart in the `XamDataPieChart` by binding your data items with a string and a numeric data value. These data values will add up to a value of 100% of visualization. + +`sample="/charts/data-pie-chart/overview", height="600", alt="{Platform} Data Pie Chart Overview"` + + + +## {Platform} Data Pie Chart Recommendations + +Pie Charts are appropriate for small data sets and are easy to read at a glance. Pie charts are just one type of part-to-whole visualization. Others include: + +- Doughnut (Ring) +- Funnel +- Stacked Area +- Stacked 100% Area (Stacked Percentage Area) +- Stacked Bar +- Stacked 100% Bar (Stacked Percentage Bar) +- Treemap +- Waterfall + +The {Platform} Data Pie Chart includes interactive features that give the viewer tools to analyze data, like: + +- Legends +- Slice Selection +- Slice Highlighting +- Chart Animations + +Best Practices for a Pie Chart: + +- Comparing slices or segments as percentage values in proportion to a total value or whole. +- Showing how a group of categories is broken into smaller segments. +- Presenting small, non-hierarchical data sets (less than 6 to 8 segments of data). +- Ensuring data segments add up to 100%. +- Arranging the order of data from largest (highest) to smallest (least). +- Using standard presentation techniques such as starting in the 12 o'clock position and continuing clockwise. +- Ensuring the color palette is distinguishable for segments/slices of the parts. +- Considering data labels in segments vs. legends for ease of reading. +- Choosing an alternative chart to Pie such as Bar or Ring based on ease of comprehension. +- Avoiding positioning multiple pie charts next to each other for comparative analysis. + +Do Not Use Pie Chart When: + +- Comparing change over time —use a Bar, Line or Area chart. +- Requiring precise data comparison —use a Bar, Line or Area chart. +- You have more than 6 or 8 segments (high data volume) — consider a Bar, Line or Area chart if it works for your data story. +- It would be easier for the viewer to perceive the value difference in a Bar chart. + +## {Platform} Data Pie Chart Legend + +Legends are used to show information about each point, to know about its contribution towards the total sum. + +In order to display a legend next to the pie chart an ItemLegend needs to be created and assigned to the `Legend` property. The ItemLegend will display its items in vertical orientation as a default, but this can be changed by setting its `Orientation` property. + +The labels shown on the legend will display the same content as the label that is shown for each slice in the `XamDataPieChart` by default, but this can be modified by utilizing the `LegendSliceLabelContentMode` property on the chart. This exposes an enumeration that allows you to show the label, value, percentage, or any combination of those as the legend's content for each slice in the chart. + +You can also modify the ItemLegend badge. By default, it appears as a filled circle corresponding to the color of the associated chart slice. You can configure this by using the `LegendItemBadgeShape` property on the chart, and you can set this to be a circle, line, bar, column, and more. + +Below is an example that demonstrates usage of the ItemLegend with the `XamDataPieChart`. + +`sample="/charts/data-pie-chart/legend", height="600", alt="{Platform} Data Pie Chart Legend"` + + + +## {Platform} Pie Chart Others Category + +Sometimes, the underlying data for the pie chart will contain many items with small values. In this case, the Others category will permit automatic aggregation of several data values into a single slice. + +The Others category in the `XamDataPieChart` has three main, configurable properties - `OthersCategoryType`, `OthersCategoryThreshold`, and `OthersCategoryText` that allow you to configure how the Others slice in the chart is shown. These are each described below: + +The `OthersCategoryType` property works in tandem with the `OthersCategoryThreshold` property of the `XamDataPieChart`. For the `OthersCategoryType`, you can define whether you want the `OthersCategoryThreshold` to be evaluated as a number or a percentage. For example, if you decide on number and set the `OthersCategoryThreshold` to 5, any slices that have a value less than 5 will become part of the Others category. Using the same value of 5 with a percent type, any values that are less than 5 percent of the total values of the `XamDataPieChart` will become part of the Others category. + +By default, the Others slice will be represented by a label of "Others." You can change this by modifying the `OthersCategoryText` property of the chart. + +If you want to ensure that the Others category does not show up in the `XamDataPieChart`, you can set the `OthersCategoryThreshold` to 0. + +The following sample demonstrates usage of the Others slice in the `XamDataPieChart`: + +`sample="/charts/data-pie-chart/others", height="600", alt="{Platform} Data Pie Chart Others"` + + + +## {Platform} Data Pie Chart Selection + +The `XamDataPieChart` supports slice selection by mouse click on the slices plotted in the chart. This can be configured by utilizing the `SelectionBehavior` and `SelectionMode` properties of the chart, described below: + +The main two options of the `SelectionBehavior` are `PerDataItemSingleSelect` and `PerDataItemMultiSelect`, which will enable single and multiple selection, respectively. + +The `SelectionMode` property exposes an enumeration that determines how the pie chart slices respond to being selected. The following are the options of that enumeration and what they do: + +- `Brighten`: The selected slices will be highlighted. +- `FadeOthers`: The selected slices will remain their same color and others will fade. +- `FocusColorFill`: The selected slices will change their background to the FocusBrush of the chart. +- `FocusColorOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. +- `FocusColorThickOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well. +- `GrayscaleOthers`: The unselected slices will have a gray color filter applied to them. +- `None`: There is no effect on the selected slices. +- `SelectionColorFill`: The selected slices will change their background to the SelectionBrush of the chart. +- `SelectionColorOutline`: The selected slices will have an outline with the color defined by the SelectionBrush of the chart. +- `SelectionColorThickOutline`: The selected slices will have an outline with the color defined by the FocusBrush of the chart. The thickness of this outline can be configured via the Thickness property of the control as well. +- `ThickOutline`: The selected slices will apply an outline with the thickness dependent on the Thickness property of the chart. + +When a slice is selected, its underlying data item will be added to the SelectedSeriesItems collection of the chart. As such, the XamDataPieChart exposes the SelectedSeriesItemsChanged event to detect when a slice has been selected and this collection is changed. + +The following sample demonstrates the selection feature of the `XamDataPieChart` control: + +`sample="/charts/data-pie-chart/selection", height="600", alt="{Platform} Data Pie Chart Selection"` + + + +## {Platform} Data Pie Chart Highlighting + +The `XamDataPieChart` supports mouse over highlighting, as well as a highlighting overlay that can be configured by providing a separate data source. + +First, the `HighlightingBehavior` enumerated property determines how a slice will be highlighted. The following are the options of that property and what they do: + +- `DirectlyOver`: The slices are only highlighted when the mouse is directly over them. +- `NearestItems`: The nearest slice to the mouse position will be highlighted. +- `NearestItemsAndSeries`: The nearest slice and series to the mouse position will be highlighted. +- `NearestItemsRetainMainShapes`: The nearest items to the mouse position will be highlighted and the main shapes of the series will not be de-emphasized. + +The `HighlightingMode` enumerated property determines how the data pie chart slices respond to being highlighted. The following are the options of that property and what they do: + +- `Brighten`: The series will have its color brightened when the mouse position is over or near it. +- `BrightenSpecific`: The specific slice will have its color brightened when the mouse position is over or near it. +- `FadeOthers`: The series will retain its color when the mouse position is over or near it, while the others will appear faded. +- `FadeOthersSpecific`: The specific slice will retain its color when the mouse position is over or near it, while the others will appear faded. +- `None`: The series and slices will not be highlighted. + +The following example demonstrates the mouse highlighting behaviors of the `XamDataPieChart` component: + +`sample="/charts/data-pie-chart/highlighting", height="600", alt="{Platform} Data Pie Chart Highlighting"` + +In addition to the mouse highlighting, the `XamDataPieChart` exposes a highlight filter capability that can display a subset of your data. This is applied by specifying a `HighlightedDataSource` for the control and by setting the `HighlightedValuesDisplayMode` property to `Overlay`. The `HighlightedDataSource` expects a subset of the data assigned to the `DataSource` property of the `XamDataPieChart`. + +When these conditions are met, the values of the subset will be highlighted, while the remainder of the full set of data will be faded - effectively creating a highlight for the subset and allowing easier visualization of a subset of your data within the same control. + + + +## {Platform} Data Pie Chart Animation + +The `XamDataPieChart` supports animating its slices into view, as well as when a value changes. + +You can set the `IsTransitionInEnabled` property to **true** to have the pie chart animate into view. The type of animation performed can be configured by setting the `TransitionInMode` enumerated property to the type of animation you would like to see. Additionally, you can also set the `TransitionInSpeedType` property to scale with index, value, normal, or randomized. The duration of this animation can be controlled by the `TransitionInDuration` property, which takes a `TimeSpan`. + +If you would like to animate data changes, this can also be done by setting the `AnimateSeriesWhenAxisRangeChanges` property to **true**. The duration of this change can be configured by setting the `TransitionDuration` property as well. + +The following sample demonstrates the usage of animation in the `XamDataPieChart`: + +`sample="/charts/data-pie-chart/animation", height="600", alt="{Platform} Data Pie Chart Animation"` + + + +## Additional Resources + +- [Donut Chart](donut-chart.md) +- [Polar Chart](polar-chart.md) +- [Radial Chart](radial-chart.md) + +## API References + +The following table lists API members mentioned in the above sections: + +- `OthersCategoryThreshold` +- `OthersCategoryType` +- `SelectionMode` + + |Chart Type | Control Name | API Members | + |-----------------|----------------|------------ | + |Data Pie Chart | `XamDataPieChart` | `XamDataPieChart` | + |Item Legend | `ItemLegend` | `ItemLegend` | + diff --git a/doc/en/components/charts/types/radial-chart.md b/doc/en/components/charts/types/radial-chart.md index 8e4b9a7bf..1ac1bb07d 100644 --- a/doc/en/components/charts/types/radial-chart.md +++ b/doc/en/components/charts/types/radial-chart.md @@ -55,7 +55,11 @@ Once our radial chart is created, we may want to make some further styling custo `sample="/charts/data-chart/radial-area-chart-styling", height="600", alt="{Platform} Radial Area Chart Styling"` + + +## {Platform} Radial Chart Settings +In addition, the labels can be configured to appear near or wide from the chart. This can be configured with the `LabelMode` property for the `CategoryAngleAxis`. diff --git a/doc/en/components/editors/date-picker.md b/doc/en/components/editors/xdate-picker.md similarity index 51% rename from doc/en/components/editors/date-picker.md rename to doc/en/components/editors/xdate-picker.md index f33e9d7bf..35b0df73f 100644 --- a/doc/en/components/editors/date-picker.md +++ b/doc/en/components/editors/xdate-picker.md @@ -1,24 +1,27 @@ --- -title: {Platform} Date Picker | Data Visualization Tools | Infragistics -_description: Infragistics' {Platform} date picker component helps your users select dates. Improve your graphs and visualization with Ignite UI for {Platform}! -_keywords: {Platform} date picker, drop down, {ProductName}, Infragistics -mentionedTypes: ['DatePicker'] +title: {Platform} XDate Picker | Data Visualization Tools | Infragistics +_description: Infragistics' {Platform} xdate picker component helps your users select dates. Improve your graphs and visualization with Ignite UI for {Platform}! +_keywords: {Platform} xdate picker, drop down, {ProductName}, Infragistics +mentionedTypes: ['XDatePicker'] --- -# {Platform} Date Picker Overview +# {Platform} XDate Picker Overview -The Date Picker component allows users to use a drop-down calendar UI allowing the intuitive selection of a day, month and year. This can be helpful when an application user needs to select specific dates, and multiple editors can be combined to create a date-range UI. +The XDate Picker component allows users to use a drop-down calendar UI allowing the intuitive selection of a day, month and year. This can be helpful when an application user needs to select specific dates, and multiple editors can be combined to create a date-range UI. -## {Platform} Date Picker Example +> [!WARNING] +> The `XDatePicker` component is deprecated from version 5.0.018.7.0 of {ProductName}. For the latest supported {ProductName} Date Picker component refer to its respective page under "Scheduling". -This sample demonstrates how to create `DatePicker` with option to select a single date. +## {Platform} XDate Picker Example -`sample="/editors/date-picker/overview", height="350", alt="{Platform} Date Picker Example"` +This sample demonstrates how to create `XDatePicker` with option to select a single date. + +`sample="/editors/date-picker/overview", height="350", alt="{Platform} XDate Picker Example"` ## Dependencies -When installing the Date Picker component, the core and inputs packages must also be installed. +When installing the XDate Picker component, the core and inputs packages must also be installed. ```cmd npm install --save {PackageCore} @@ -29,65 +32,65 @@ npm install --save {PackageLayouts} ## Component Modules -The Date Picker component requires the following modules to be registered: +The XDate Picker component requires the following modules to be registered: ```razor // in Program.cs file builder.Services.AddIgniteUIBlazor( - typeof(IgbDatePickerModule)); + typeof(IgbXDatePickerModule)); ``` ```ts -import { IgrDatePickerModule } from 'igniteui-react-inputs'; +import { IgrXDatePickerModule } from 'igniteui-react-inputs'; -IgrDatePickerModule.register(); +IgrXDatePickerModule.register(); ``` ```ts -import { IgcDatePickerModule } from 'igniteui-webcomponents-inputs'; +import { IgcXDatePickerModule } from 'igniteui-webcomponents-inputs'; import { ModuleManager } from 'igniteui-webcomponents-core'; -ModuleManager.register(IgcDatePickerModule); +ModuleManager.register(IgcXDatePickerModule); ``` ## Usage -The {Platform} Date Picker editor component consists of three default parts - the text area, a calendar drop-down button, and a clear button. These areas are described below: +The {Platform} XDate Picker editor component consists of three default parts - the text area, a calendar drop-down button, and a clear button. These areas are described below: - Text Area: This displays the selected date, stored in the `Value` property of the editor. -- Calendar: Clicking the calendar button will open the calendar drop-down of the Date Picker. The calendar will open to show the month of the currently selected `Value`, if there is one. If a `Value` is not specified, the calendar will show the month corresponding to the current date. The month at the top can be clicked to show a list of months, and the same applies for the year. There are also arrow buttons to the left and right of the month and year visualization that will increment and decrement the shown month chronologically. +- Calendar: Clicking the calendar button will open the calendar drop-down of the XDate Picker. The calendar will open to show the month of the currently selected `Value`, if there is one. If a `Value` is not specified, the calendar will show the month corresponding to the current date. The month at the top can be clicked to show a list of months, and the same applies for the year. There are also arrow buttons to the left and right of the month and year visualization that will increment and decrement the shown month chronologically. - Clear Button: The 'x' icon will clear the current value. | Property | Type | Description | | ---------|------|------------ | | `IconColor` | string | Changes the color of the calendar button. | -| `AllowTextInput` | bool | The date picker's value can be typed-in and modified by toggling this property to true. | +| `AllowTextInput` | bool | The xdate picker's value can be typed-in and modified by toggling this property to true. | | `DateFormat` | enum | Defaults to DateShort e.g. 'mm/dd/yyyy'. When set to DateLong, the date displayed in the editor will appear as e.g. Wednesday, April 14, 2021. | | `FirstDayOfWeek` | enum | Defaults to Sunday. A given day of the week will be used as the first day in each weekly row of the calendar, e.g. Monday through Sunday. | | `FormatString` | string | When DateShort is used, the date's format can be configured e.g. 'dd/mm/yyyy'. Note, if the `DateFormat`'s DateLong and `FormatString` are set then the `DateFormat` is ignored. | -| `Label` | string | Displays custom text above the date in the top-left corner of the Date Picker. | +| `Label` | string | Displays custom text above the date in the top-left corner of the XDate Picker. | | `MinDate` | DateTime | Restricts earlier dates from being selected or viewed. | | `MaxDate` | DateTime | Restricts later dates from being selected or viewed. | | `Placeholder` | string | A custom string to be displayed when the value within the edit portion of the calendar is cleared. | -| `ShowClearButton` | bool | Defaults to true, the clear button is directly to the left of the calendar button, visualized by an X. When clicked, it will clear the `Value` of the Date Picker. The clear button's visibility can be toggled on and off. | +| `ShowClearButton` | bool | Defaults to true, the clear button is directly to the left of the calendar button, visualized by an X. When clicked, it will clear the `Value` of the XDate Picker. The clear button's visibility can be toggled on and off. | | `ShowTodayButton`| bool | The today is directly below the dates when the calendar is opened. When clicked, it will select the current date. The today button's visibility can be toggled on and off. | -| `ShowWeekNumbers` | bool | Week numbers can be displayed as a number, at the left of every row of dates, in the drop down portion of the date picker. The week number's visibility can be toggled on and off. | +| `ShowWeekNumbers` | bool | Week numbers can be displayed as a number, at the left of every row of dates, in the drop down portion of the XDate Picker. The week number's visibility can be toggled on and off. | | `FirstWeekOfYear` | enum | Configures the start of the week numbers for the entire year. Can be set to FirstDay, FirstFourDayWeek, FirstFullWeek. | -| `OpenOnFocus` | bool | By default, the dropdown portion of the Date Picker is opened on single click, forcing the user to click the calendar button to drop down the calendar. | -| `Value` | date | Sets the value of the Date Picker and selects it in the dropdown calendar. | +| `OpenOnFocus` | bool | By default, the dropdown portion of the XDate Picker is opened on single click, forcing the user to click the calendar button to drop down the calendar. | +| `Value` | date | Sets the value of the XDate Picker and selects it in the dropdown calendar. | -Users can also customize the Date Picker's font by using the various text properties of the control. They are: `TextColor`, `TextFontFamily`, `TextFontSize`, `TextFontStyle`, and `TextFontWeight`. +Users can also customize the XDate Picker's font by using the various text properties of the control. They are: `TextColor`, `TextFontFamily`, `TextFontSize`, `TextFontStyle`, and `TextFontWeight`. ### Editing -The following example demonstrates how to enable editing in the `DatePicker`. +The following example demonstrates how to enable editing in the `XDatePicker`. -`sample="/editors/date-picker/editing", height="300", alt="{Platform} Date Picker Editing Example"` +`sample="/editors/date-picker/editing", height="300", alt="{Platform} XDate Picker Editing Example"` @@ -95,9 +98,9 @@ The following example demonstrates how to enable editing in the `DatePicker`. ### Date Limits -The following example demonstrates how to restrict selected dates in the `DatePicker`. +The following example demonstrates how to restrict selected dates in the `XDatePicker`. -`sample="/editors/date-picker/date-limits", height="360", alt="{Platform} Date Picker Date Limits Example"` +`sample="/editors/date-picker/date-limits", height="360", alt="{Platform} XDate Picker Date Limits Example"` @@ -105,9 +108,9 @@ The following example demonstrates how to restrict selected dates in the `DatePi ### Date Formats -The following example demonstrates how apply a long date in the `DatePicker`. +The following example demonstrates how apply a long date in the `XDatePicker`. -`sample="/editors/date-picker/format", height="350", alt="{Platform} Date Picker Format Example"` +`sample="/editors/date-picker/format", height="350", alt="{Platform} XDate Picker Format Example"` @@ -115,9 +118,9 @@ The following example demonstrates how apply a long date in the `DatePicker`. ### Date Ranges -The following example demonstrates how combine multiple `DatePicker` controls. +The following example demonstrates how combine multiple `XDatePicker` controls. -`sample="/editors/date-picker/range", height="300", alt="{Platform} Date Picker Date Range Example"` +`sample="/editors/date-picker/range", height="300", alt="{Platform} XDate Picker Date Range Example"` @@ -127,7 +130,7 @@ The following example demonstrates how combine multiple `DatePicker` controls. The following is a list of API members mentioned in the above sections: -- `DatePicker` +- `XDatePicker` - `IconColor` - `AllowTextInput` - `DateFormat` diff --git a/doc/en/components/general-changelog-dv-blazor.md b/doc/en/components/general-changelog-dv-blazor.md index 47bc0e3e5..c88296b0a 100644 --- a/doc/en/components/general-changelog-dv-blazor.md +++ b/doc/en/components/general-changelog-dv-blazor.md @@ -10,13 +10,93 @@ namespace: Infragistics.Controls.Charts All notable changes for each version of {ProductName} are documented on this page. +## **{PackageVerChanges-24-1-SEP}** + +### General + +- New [Banner](notifications/banner.md) component. +- New [DatePicker](scheduling/date-picker.md) component. +- New `Divider` component. +- `Icon` + - Added `SetIconRef` method. This allows to register and replace icons by SVG files. + - All components now use icons by reference internally so that it's easy to replace them without explicitly providing custom templates. +- `Combo`, `DatePicker`, `Dialog`, `Dropdown`, `ExpansionPanel`, `NavDrawer`, `Toast`, `Snackbar`, **IgbSelectComponent** + - Toggle methods `Show`, `Hide`, `Toggle` methods return **true** now on success. Otherwise **false**. +- `RadioGroup` + - Added `Name` and `Value` properties. `Value` also supports two-way binding. + +**BREAKING CHANGES**: + +- Renamed old **IgbDatePicker** to **IgbXDatePicker**. +- Removed `Form` component. Use native form instead. +- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components: + - `Avatar`, `Button`,`IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree` +- `Badge`, `Chip`, `LinearProgress`, `CircularProgress` + - Renamed `Variant` property type to `StyleVariant`. +- `Calendar` + - Renamed `WeekStart` property type to `WeekDays`. +- `Checkbox`, `Switch` + - Changed `Change` event argument type from `ComponentBoolValueChangedEventArgs` to `CheckboxChangeEventArgs`. +- `Combo` + - The `IgbCombo` is now of generic type and the `Value` type is now of type `T[]`. This means that either you need to specify `T` or it will be inferred by the assigned `Value` type. + - Removed `PositionStrategy`, `Flip`, `SameWidth` properties. +- **IgbSelectComponent** + - Removed `PositionStrategy`, `Flip`, `SameWidth` properties. +- `DateTimeInput` + - Removed `MaxValue` and `MinValue` properties. Use `Max` and `Min` instead. +- `Dropdown` + - Removed `PositionStrategy` property. +- `Input` + - Removed old named `Maxlength` and `Minlength` properties. Use `MaxLength` and `MinLength`. + - Removed old named `Readonly` and `Inputmode` properties. Use `ReadOnly` and `InputMode`. + - Changed `InputMode` type also to `string`. +- `Radio` + - Changed `Change` event argument type from `ComponentBoolValueChangedEventArgs` to `RadioChangeEventArgs`. +- `RangeSlider` + - Removed `AriaThumbLower` and `AriaThumbUpper` properties. Use `ThumbLabelLower` and `ThumbLabelUpper` instead. +- `Rating` + - Renamed `Readonly` property to `ReadOnly`. + +### {PackageGrids} + +- `All Grids` + - Added `GetColumns` / `GetColumnsAsync` methods, which return the grid columns collection. + - Added new `RowClick` event. +- `PivotGrid` + - Added `Sortable` property for a `PivotDimension`. + - Added horizontal layout. Can be enabled inside the new `PivotUI` property as `RowLayout` `Horizontal`. + - Added row dimension summaries for horizontal layout only. Can be enabled for each `PivotDimension` by setting `HorizontalSummary` to **true**. + - Added `HorizontalSummariesPosition` property to the `PivotUI`, configuring horizontal summaries position. + - Added row headers for the row dimensions. Can be enabled inside the new `PivotUI` property as `ShowHeaders` **true**. + - Keyboard navigation now can move in to row headers back and forth from any row dimension headers or column headers. + - Added keyboard interactions for row dimension collapse using `Alt + Arrows` and row headers sorting using `Ctrl + Arrow Up/Down`. + +**BREAKING CHANGES**: +- `All Grids`, `RowIsland` + - Removed `DisplayDensity` deprecated property. + - Renamed `Columns`, `ActualColumns`, `ContentColumns` properties to `ColumnList`, `ActualColumnList` and `ContentColumnList`. Recommended to use the new `GetColumns` method instead. + - Renamed `RowDelete` and `RowAdd` event argument type to `RowDataCancelableEventArgs`. + - Renamed `ContextMenu` event argument type to `GridContextMenuEventArgs`. + - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `RowID` and `PrimaryKey` properties. Use `RowKey` instead. +- `PivotGrid` + - removed `ShowPivotConfigurationUI` property. Use `PivotUI` and set inside it the new `ShowConfiguration` option. +- `Column` + - Removed `Movable` property. Use Grid's `Moving` property now. + - Removed `ColumnChildren` property. Use `ChildColumns` instead. +- `ColumnGroup` + - Removed `Children` property. Use `ChildColumns` instead. +- `Paginator` + - Removed `IsFirstPageDisabled` and `IsLastPageDisabled` properties. Use `IsFirstPage` and `IsLastPage` instead. + +## **{PackageVerChanges-24-1-JUN}** + ### General - `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input. - `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete. - `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead. ### {PackageGrids} -- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. +- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. Check out the [Grid Size](grids/grid/size.md) topic for more. - `PivotGrid` - The type of Columns, Rows, Filters from `PivotConfiguration` option is now array of IgbPivotDimension - `IgbPivotDimension[]`, it was `IgbPivotDimensionCollection` previously. The type of Values from `PivotConfiguration` option is now array of IgbPivotValue - `IgbPivotValue[]`, it was `IgbPivotValueCollection` previously. @@ -25,7 +105,10 @@ The type of Values from `PivotConfiguration` option is now array of IgbPivotValu * [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users. -- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `XamDataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a partcular dataitem. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrouding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection. +- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `XamDataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular dataitem. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection. + +- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `XamDataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart. + - [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property. @@ -304,7 +387,7 @@ Added New Feature - [Row Paging](grids/data-grid/row-paging.md) which is used to * [Button & Icon Button](inputs/button.md) * [Card](layouts/card.md) * [Checkbox](inputs/checkbox.md) -* [Form](inputs/form.md) +* Form * [Icon](layouts/icon.md) * [List](grids/list.md) * [Navigation Bar](menus/navbar.md) diff --git a/doc/en/components/general-changelog-dv-react.md b/doc/en/components/general-changelog-dv-react.md index d1ed1d313..f58318cab 100644 --- a/doc/en/components/general-changelog-dv-react.md +++ b/doc/en/components/general-changelog-dv-react.md @@ -9,6 +9,84 @@ namespace: Infragistics.Controls.Charts All notable changes for each version of {ProductName} are documented on this page. +## **{PackageVerChanges-24-1-SEP}** + +### {PackageCommon} + +- New [Banner](notifications/banner.md) component. +- New [DatePicker](scheduling/date-picker.md) component. +- New `Divider` component. +- Added support for native events to all components. +- `Icon` + - Added `setIconRef` method. This allows to register and replace icons by SVG files. + - All components now use icons by reference internally so that it's easy to replace them without explicitly providing custom templates. +- `Combo`, `DatePicker`, `Dialog`, `Dropdown`, `ExpansionPanel`, `NavDrawer`, `Toast`, `Snackbar`, **IgrSelectComponent** + - Toggle methods `show`, `hide`, `toggle` methods return **true** now on success, otherwise **false**. +- **IgrButtonComponent**, `IconButton`, `Checkbox`, `Switch`, `Combo`, `DateTimeInput`, `Input`, `MaskInput`, `Radio`, **IgrSelectComponent**, `Textarea` + - Deprecated custom `focus` and `blur` events. Use the native `onFocus` and `onBlur` events instead +- `RadioGroup` + - Added `Name` and `Value` properties. + +**BREAKING CHANGES**: + +- Renamed old **IgrDatePicker** to **IgrXDatePicker**. +- Removed `Form` component. Use native form instead. +- Removed `size` property in favor of the `--ig-size` CSS custom property for the following components: + - `Avatar`, **IgrButtonComponent**, `IconButton`, `Calendar`, `Chip`, `Dropdown`, `Icon`, `Input`, `List`, `Rating`, `Snackbar`, `Tabs`, `Tree` +- `Badge`, `Chip`, `LinearProgress`, `CircularProgress` + - Renamed `Variant` property type to `StyleVariant`. +- `Calendar` + - Renamed `WeekStart` property type to `WeekDays`. +- `Checkbox`, `Switch` + - Changed `change` event argument type from `ComponentBoolValueChangedEventArgs` to `CheckboxChangeEventArgs`. +- `Combo`, **IgrSelectComponent** + - Removed `positionStrategy`, `flip`, `sameWidth` properties. +- `DateTimeInput` + - Removed `maxValue` and `minValue` properties. Use `max` and `min` instead. +- `Dropdown` + - Removed `positionStrategy` property. +- `Input` + - Removed old named `maxlength` and `minlength` properties. Use `maxLength` and `minLength`. + - Removed old named `readonly` and `inputmode` properties. Use `readOnly` and `inputMode`. + - Changed `inputMode` type also to `string`. +- `Radio` + - Changed `change` event argument type from `ComponentBoolValueChangedEventArgs` to `RadioChangeEventArgs`. +- `RangeSlider` + - Removed `ariaThumbLower` and `ariaThumbUpper` properties. Use `thumbLabelLower` and `thumbLabelUpper` instead. +- `Rating` + - Renamed `readonly` property to `readOnly`. + +### {PackageGrids} + +- `All Grids` + - Added new `RowClick` event. +- `PivotGrid` + - Added `sortable` property for a `PivotDimension`. + - Added horizontal layout. Can be enabled inside the new `pivotUI` property as `rowLayout` `horizontal`. + - Added row dimension summaries for horizontal layout only. Can be enabled for each `PivotDimension` by setting `horizontalSummary` to **true**. + - Added `horizontalSummariesPosition` property to the `pivotUI`, configuring horizontal summaries position. + - Added row headers for the row dimensions. Can be enabled inside the new `pivotUI` property as `showHeaders` **true**. + - Keyboard navigation now can move in to row headers back and forth from any row dimension headers or column headers. + - Added keyboard interactions for row dimension collapse using `Alt + Arrows` and row headers sorting using `Ctrl + Arrow Up/Down`. + +**BREAKING CHANGES**: + +- `All Grids`, `RowIsland` + - Removed `displayDensity` deprecated property. + - Renamed `actualColumns`, `contentColumns` properties to `actualColumnList` and `contentColumnList`. Use `columns` or `columnList` property to get all columns now. + - Renamed `rowDelete` and `rowAdd` event argument type to `RowDataCancelableEventArgs`. + - Renamed `contextMenu` event argument type to `GridContextMenuEventArgs`. + - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `rowID` and `primaryKey` properties. Use `rowKey` instead. +- `PivotGrid` + - removed `showPivotConfigurationUI` property. Use `pivotUI` and set inside it the new `showConfiguration` option. +- `Column` + - Removed `movable` property. Use Grid's `moving` property now. + - Removed `columnChildren` property. Use `childColumns` instead. +- `ColumnGroup` + - Removed `children` property. Use `childColumns` instead. +- `Paginator` + - Removed `isFirstPageDisabled` and `isLastPageDisabled` properties. Use `isFirstPage` and `isLastPage` instead. + ## **{PackageVerChanges-24-1-JUN}** ### {PackageCommon} @@ -17,14 +95,18 @@ All notable changes for each version of {ProductName} are documented on this pag - `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead. ### {PackageGrids} -- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. + +- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. Check out the [Grid Size](grids/grid/size.md) topic for more. + - `PivotGrid` - Configuration of the component can now be applied correctly. ### {PackageCharts} (Charts) * [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users. -- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `XamDataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a partcular dataitem. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrouding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection. +- [Chart Selection](charts/features/chart-data-selection.md) - New series selection styling. This is adopted broadly across all category, financial and radial series for `CategoryChart` and `XamDataChart`. Series can be clicked and shown a different color, brightened or faded, and focus outlines. Manage which items are effected through individual series or entire data item. Multiple series and markers are supported. Useful for illustrating various differences or similarities between values of a particular dataitem. Also `SelectedSeriesItemsChanged` event and `SelectedSeriesItems` are available for additional help to build out robust business requirements surrounding other actions that can take place within an application such as a popup or other screen with data analysis based on the selection. + +- [Proportional Category Angle Axis](charts/types/radial-chart.md) - New axes for the Radial Pie Series in the `XamDataChart`, to enable creating pie charts in the allowing robust visualizations using all the added power of the data chart. - [Treemap Highlighting](charts/types/treemap-chart.md#{PlatformLower}-treemap-highlighting) - Now exposes a `HighlightingMode` property that allows you to configure the mouse-over highlighting of the items in the tree map. This property takes two options: `Brighten` where the highlight will apply to the item that you hover the mouse over only, and `FadeOthers` where the highlight of the hovered item will remain the same, but everything else will fade out. This highlight is animated, and can be controlled using the `HighlightingTransitionDuration` property. diff --git a/doc/en/components/general-changelog-dv-wc.md b/doc/en/components/general-changelog-dv-wc.md index 3d656c447..a7fa0d1ad 100644 --- a/doc/en/components/general-changelog-dv-wc.md +++ b/doc/en/components/general-changelog-dv-wc.md @@ -3,22 +3,54 @@ title: {Platform} What's New | {ProductName} | Infragistics _description: Learn about new features in the {ProductName}. _keywords: Changelog, What's New, {ProductName}, Infragistics mentionedTypes: ["SeriesViewer", "XYChart", "DomainChart", "XamDataChart", "Toolbar", "XamGeographicMap", "DatePicker", "MultiColumnComboBox", "CategoryChart", "CrosshairLayer", "FinalValueLayer", "CalloutLayer", "DataLegend", "Infragistics.Controls.Grid", "Infragistics.Controls.GridSelectionMode", "XamRadialGauge", "XamRadialChart", "Toolbar"] -namespace: Infragistics.Controls.Charts +namespace: Infragistics.Controls --- + # {ProductName} Changelog All notable changes for each version of {ProductName} are documented on this page. -## **{PackageVerChanges-24-1-JUN}** - -### {PackageCommon} +### **{PackageVerChanges-24-1-SEP}** + +- `All Grids` + - Added new `RowClick` event. +- `PivotGrid` + - Added `sortable` property for a `PivotDimension`. + - Added horizontal layout. Can be enabled inside the new `pivotUI` property as `rowLayout` `horizontal`. + - Added row dimension summaries for horizontal layout only. Can be enabled for each `PivotDimension` by setting `horizontalSummary` to **true**. + - Added `horizontalSummariesPosition` property to the `pivotUI`, configuring horizontal summaries position. + - Added row headers for the row dimensions. Can be enabled inside the new `pivotUI` property as `showHeaders` **true**. + - Keyboard navigation now can move in to row headers back and forth from any row dimension headers or column headers. + - Added keyboard interactions for row dimension collapse using `Alt + Arrows` and row headers sorting using `Ctrl + Arrow Up/Down`. + +**BREAKING CHANGES**: +- `All Grids`, `RowIsland` + - Removed `displayDensity` deprecated property. + - Renamed `actualColumns`, `contentColumns` properties to `actualColumnList` and `contentColumnList`. Use `column` or `columnList` property to get all columns now. + - Renamed `rowDelete` and `rowAdd` event argument type to `RowDataCancelableEventArgs`. + - Renamed `contextMenu` event argument type to `GridContextMenuEventArgs`. + - Removed `GridEditEventArgs`, `GridEditDoneEventArgs`, `PinRowEventArgs` events `rowID` and `primaryKey` properties. Use `rowKey` instead. +- `PivotGrid` + - removed `showPivotConfigurationUI` property. Use `pivotUI` and set inside it the new `showConfiguration` option. +- `Column` + - Removed `movable` property. Use Grid's `moving` property now. + - Removed `columnChildren` property. Use `childColumns` instead. +- `ColumnGroup` + - Removed `children` property. Use `childColumns` instead. +- `Paginator` + - Removed `isFirstPageDisabled` and `isLastPageDisabled` properties. Use `isFirstPage` and `isLastPage` instead. + + +### **{PackageVerChanges-24-1-JUN}** + +#### {PackageCommon} - `Input`, `Textarea` - exposed `ValidateOnly` to enable validation rules being enforced without restricting user input. - `Dropdown` - `PositionStrategy` property is deprecated. The dropdown now uses the `Popover` API to render its container in the top layer of the browser viewport, making the property obsolete. - `DockManager` - `SplitPane` `IsMaximized` is deprecated. Having isMaximized set to true on a split pane level has no real effect as split panes serve as containers only, meaning they have no actual content to be shown maximized. Use the `IsMaximized` property of `TabGroupPane` and/or `ContentPane` instead. -### {PackageGrids} -- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. -### {PackageCharts} (Charts) +#### {PackageGrids} +- `DisplayDensity` deprecated in favor of the `--ig-size` CSS custom property. Check out the [Grid Size](grids/grid/size.md) topic for more regarding the Grid. +#### {PackageCharts} (Charts) * [Data Legend Grouping](charts/features/chart-data-legend.md#{PlatformLower}-data-legend-grouping) & [Data Tooltip Grouping](charts/features/chart-data-tooltip.md#{PlatformLower}-data-tooltip-grouping-for-data-chart) - New grouping feature added. The property `GroupRowVisible` toggles grouping with each series opting in can assign group text via the `DataLegendGroup` property. If the same value is applied to more than one series then they will appear grouped. Useful for large datasets that need to be categorized and organized for all users. @@ -30,119 +62,729 @@ All notable changes for each version of {ProductName} are documented on this pag - `Toolbar` - New `IsHighlighted` option for ToolAction for outlining a border around specific tools of choice. -### {PackageGauges} (Gauges) +#### {PackageGauges} (Gauges) - `XamRadialGauge` - New label for the highlight needle. `HighlightLabelText` and `HighlightLabelSnapsToNeedlePivot` and many other styling related properties for the HighlightLabel were added. -## **{PackageVerChanges-23-2-MAR}** +### **{PackageVerChanges-23-2-MAR}** -### {PackageCharts} +- New [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) component. - - New Data Filtering via the `InitialFilter` property. Apply filter expressions to filter the chart data to a subset of records. Can be used for drill down large data. +### **{PackageVerChanges-23-2-DEC}** -- `XamRadialChart` - - New Label Mode - The `CategoryAngleAxis` for the now exposes a `LabelMode` property that allows you to further configure the location of the labels. This allows you to toggle between the default mode by selecting the `Center` enum, or use the new mode, `ClosestPoint`, which will bring the labels closer to the circular plot area. +- Added New Features (Grid) - [State Persistence](grids/grid/state-persistence.md). -### {PackageGauges} +### **{PackageVerChanges-22-2.2}** -- `XamRadialGauge` - - New title/subtitle properties. `TitleText`, `SubtitleText` will appear near the bottom the gauge. In addition, the various title/subtitle font properties were added such as `TitleFontSize`, `TitleFontFamily`, `TitleFontStyle`, `TitleFontWeight` and `TitleExtent`. Finally, the new `TitleDisplaysValue` will allow the value to correspond with the needle's position. - - New `OpticalScalingEnabled` and `OpticalScalingSize` properties for the `XamRadialGauge`. This new feature will manage the size at which labels, titles, and subtitles of the gauge have 100% optical scaling. You can read more about this new feature [here](radial-gauge.md#optical-scaling) - - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear. -- `XamLinearGauge` - - New highlight needle was added. `HighlightValue` and `HighlightValueDisplayMode` when both are provided a value and 'Overlay' setting, this will make the main needle to appear faded and a new needle will appear. -- `XamBulletGraph` - - The Performance bar will now reflect a difference between the value and new `HighlightValue` when the `HighlightValueDisplayMode` is applied to the 'Overlay' setting. The highlight value will show a filtered/subset completed measured percentage as a filled in color while the remaining bar's appearance will appear faded to the assigned value, illustrating the performance in real-time. +- A new argument `PrimaryKey` has been introduced to `IgcRowDataEventArgs`, and part of the event arguments that are emitted by the `RowAdded` and `RowDeleted` events. When the grid has a primary key attribute added, then the emitted primaryKey event argument represents the row ID, otherwise it defaults to undefined. +- `RowSelectionChanging` event arguments are changed. Now, the `OldSelection`, `NewSelection`, `Added` and `Removed` collections no longer consist of the row keys of the selected elements when the grid has set a primaryKey, but now in any case the row data is emitted. +- When the grid is working with remote data and a primary key has been set, the selected rows that are not currently part of the grid view will be emitted for a partial row data object. +- When selected row is deleted from the grid component `RowSelectionChanging` event will no longer be emitted. +- The `OnGroupingDone` event has been renamed to `GroupingDone` to not violate the no on-prefixed outputs convention. +- The `OnDensityChanged` event has been renamed to `DensityChanged` to not violate the no on-prefixed outputs convention. All components exposing this event are affected. -### {PackageGrids} +- `PivotGrid`: The `IgcPivotDateDimension` properties `InBaseDimension` and `InOption` have been deprecated and renamed to `BaseDimension` and `Options` respectively. -- New [`HierarchicalGrid`](grids/hierarchical-grid/overview.md) component +### **{PackageVerChanges-22-2.1}** -## **{PackageVerChanges-23-2-JAN}** +- New [Pivot Grid](grids/pivot-grid/overview.md) component. -### {PackageCharts} (Charts) +### **{PackageVerChanges-22-2}** -* [Chart Highlight Filter](charts/features/chart-highlight-filter.md) - The `CategoryChart` and `XamDataChart` now expose a way to highlight and animate in and out of a subset of data. The display of this highlight depends on the series type. For column and area series, the subset will be shown on top of the total set of data where the subset will be colored by the actual brush of the series, and the total set will have a reduced opacity. For line series, the subset will be shown as a dotted line. +- New [Grid](grids/data-grid.md) component. +- New [Tree Grid](grids/tree-grid/overview.md) component. +- `DataGrid`: + - Changed **{IgPrefix}Column** to `DataGridColumn` + - Changed **GridCellEventArgs** to `DataGridCellEventArgs` + - Changed **GridSelectionMode** to `DataGridSelectionMode` + - Changed **SummaryOperand** to `DataSourceSummaryOperand` -## **{PackageVerChanges-23-2-DEC}** +### **{PackageVerChanges-22-1}** -### {PackageGrids} (Grid) +- `DataGrid`: + - Added New Feature - [Row Paging](grids/data-grid/row-paging.md) which is used to split a large set of data into a sequence of pages that have similar content. With pagination, data can be displayed in a set number of rows, letting users “scroll” through their data, without needing a scroll bar. The UI for table pagination usually includes things like the current page, total pages, and clickable Previous and Next arrows/buttons that let users flip through the pages of data. -* Added New Features - [State Persistence](grids/grid/state-persistence.md) +### **{PackageVerChanges-21-2.1}** +- `DataGrid`: + - Added `ValueMultiField`, of type string[], in the `ComboBoxColumn` to be used when your items in the drop down contain a key that consists of multiple fields. -## **{PackageVerChanges-23-2}** +> [!Note] +> The following breaking changes were introduced: Changed `ValueField` property from type string[] to string. + +### **{PackageVerChanges-21-2}** + +- `DataGrid`: + - New Features Added: + - [Filter Row](grids/data-grid/column-filtering.md) + - [Load/Save Layout Customizations](grids/data-grid/load-save-layout.md) + - [GroupBy Area for column grouping](grids/data-grid/row-grouping.md) + - [Cell Merging](grids/data-grid/cell-merging.md) + - New API: + - Added `SelectionChanged` event. Used to detect changes on selection interactions + e.g. Multiple row selection. + - Breaking Changes: + - Changed grid's SummaryScope property's type to SummaryScope from `DataSourceSummaryScope` + - Changed GroupHeaderDisplayMode property's type to GroupHeaderDisplayMode from `DataSourceSectionHeaderDisplayMode` + + +### **{PackageVerChanges-21-1}** + +- `DataGrid`: + - Added `EditOnKeyPress` aka Excel-style Editing, instantly begin editing when typing. + - Added `EditModeClickAction` property - By default double-clicking is required to enter edit mode. This can be set to `SingleClick` to allow for edit mode to occur when selecting a new cell. + - Added `EnterKeyBehaviors` property - aka Excel-style Navigation (Enter Behavior) – controls the behavior of the enter key, e.g. Options are (none, edit, move up, down, left, right) + - Added `EnterKeyBehaviorAfterEdit` property - While in edit-mode, this property controls when enter is pressed, e.g. Options are (moves to the cell below, above, right, left) + - Added `SelectAllRows` - method. + - Added Row Range Selection - With `GridSelectionMode` property set to MultipleRow the following new functionality is now included: + - Click and drag to select rows + - Shift and click to select multiple rows. + - Shift and press the up/down arrow keys to select multiple rows. + - Pressing space bar toggles selection of active row via `GridSelectionMode` property set to MultipleRow or SingleRow + - Added Column Summaries to Column Options Dialog. -### {PackageGrids} (Toolbar - Beta) +### **{PackageVerChangedFields}** -* Save tool action has been added to save the chart to an image via the clipboard. -* Vertical orientation has been added via the toolbar's `Orientation` property. By default the toolbar is horizontal, now the toolbar can be shown in vertical orientation where the tools will popup to the left/right respectfully. -* Custom SVG icons support was added via the toolbar's `renderImageFromText` method, further enhancing custom tool creation. +- `DataGrid`: -## **{PackageVerChanges-23-1}** +> [!Note] +> These breaking changes were introduce in the grid package. -### New Components +- Changed name of PropertyPath -* [Toolbar](menus/toolbar.md) - Beta. This component is a companion container for UI operations to be used primarily with our charting components. The toolbar will dynamically update with a preset of properties and tool items when linked to our `XamDataChart` or `CategoryChart` components. You'll be able to create custom tools for your project allowing end users to provide changes, offering an endless amount of customization. +The data grid component property `propertyPath` has been renamed to `field`. This applies to all Column types, GroupDescription, SortDescription & SummaryDescription. -### {PackageCharts} (Charts) +```html +