Skip to content

Commit

Permalink
Merge branch 'vnext' into ESShared/XPlaform_jp_igniteui-xplat-docs-ma…
Browse files Browse the repository at this point in the history
…ke-pr-JP+KR_2024.12.18.2
  • Loading branch information
HUSSAR-mtrela authored Dec 18, 2024
2 parents 1460ab5 + b5f7def commit bab84c4
Show file tree
Hide file tree
Showing 4 changed files with 234 additions and 0 deletions.
132 changes: 132 additions & 0 deletions en/components/dashboard-tile.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,132 @@
---
title: Angular Dashboard Tile Component | Ignite UI for Angular
_description: See how you can easily get started with Angular Dashboard Tile Component.
_keywords: Ignite UI for Angular, UI controls, Angular widgets, web widgets, UI widgets, Angular, Native Angular Components Suite, Native Angular Controls, Native Angular Components Library, Angular Dashboard components, Angular Dashboard Tile controls
mentionedTypes: ["Toolbar", "CategoryChart", "XamDataChart", "XamRadialGauge", "XamLinearGauge", "XamGeographicMap"]
---

# Angular Dashboard Tile Overview

The Angular Dashboard Tile is a automatic data visualization component which determines via analysis of a DataSource collection/array or single data point what would be the most appropriate visualization to display. It then also provides a further suite of tools in its embedded [`IgxToolbarComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_layouts.igxtoolbarcomponent.html) that let you alter the visualization that is presented in a variety of ways.

A wide variety of visualizations may be selected for display depending on the shape of the provided data including, but not limited to: Category Charts, Radial and Polar Charts, Scatter Charts, Geographic Maps, Radial and Linear Gauges, Financial Charts and Stacked Charts.

Interacting with the chart type menu in the toolbar will allow for selecting a different visualization among the list of likely candidates.

## Angular Dashboard Tile Example

<!-- TODO -->

<code-view style="height: 600px" alt="Angular Dashboard Tile Example"
data-demos-base-url="{environment:dvDemosBaseUrl}"
iframe-src="{environment:dvDemosBaseUrl}/charts/dashboard-tile/chart-dashboard"
github-src="charts/dashboard-tile/chart-dashboard">
</code-view>


## Dependencies

<!-- Angular, WebComponents, React -->

Install the following packages in the Ignite UI for Angular toolset:

```cmd
npm install igniteui-angular-charts
npm install igniteui-angular-core
npm install igniteui-angular-dashboards
npm install igniteui-angular-gauges
npm install igniteui-angular-grids
npm install igniteui-angular-inputs
npm install igniteui-angular-layouts
npm install igniteui-angular-maps
```

The following modules are suggested when using the Dashboard Tile component:

```ts
import { IgxDashboardTileModule, IgxDataChartDashboardTileModule, IgxRadialGaugeDashboardTileModule,
IgxLinearGaugeDashboardTileModule, IgxGeographicMapDashboardTileModule,
IgxPieChartDashboardTileModule } from "igniteui-angular-dashboards";

@NgModule({
imports: [
IgxDataChartDashboardTileModule,
IgxRadialGaugeDashboardTileModule,
IgxLinearGaugeDashboardTileModule,
IgxGeographicMapDashboardTileModule,
IgxPieChartDashboardTileModule,
IgxDashboardTileModule
]
})
export class AppModule {}
```

<!-- end:Angular, WebComponents, React -->

## Usage

Depending on what you bind the Dashboard Tile's `DataSource` property to will determine which visualization you see by default, as the control will evaluate the data you bind and then choose a visualization from the Ignite UI for Angular toolset to show. The data visualization controls that are included to be shown in the Dashboard Tile are the following:

* [IgxCategoryChart](charts/chart-overview.md)
* [IgxDataChart](charts/chart-overview.md)
* [IgxDataPieChart](charts/types/data-pie-chart.md)
* [IgxGeographicMap](geo-map.md)
* [IgxLinear Gauge](linear-gauge.md)
* [IgxRadialGauge](radial-gauge.md)

The data visualization that is chosen by default is mainly dependent on the schema and the count of the `DataSource` that you have bound. For example, if you bind a single numeric value, you will get a [`IgxRadialGaugeComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_gauges.igxradialgaugecomponent.html), but if you bind a collection of value-label pairs that are easy to distinguish from each other, you will likely get a `XamDataPieChart`. If you bind an `DataSource` that has more value paths, you will receive a [`IgxDataChartComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxdatachartcomponent.html) with multiple column series or line series, depending mainly on the count of the collection bound. You can also bind to a `ShapeDataSource` or data the appears to contain geographic points to receive a [`IgxGeographicMapComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_maps.igxgeographicmapcomponent.html).

You are not locked into a single visualization when you bind the `DataSource`, and you can tell the control that you want to see a particular visualization by setting its `VisualizationType` property. For example, if you specifically wanted to see a line chart, you could define the Dashboard Tile like so:

<!-- TODO SAMPLE -->

<code-view style="height: 600px" alt="Angular Dashboard Tile Gauge Example"
data-demos-base-url="{environment:dvDemosBaseUrl}"
iframe-src="{environment:dvDemosBaseUrl}/charts/dashboard-tile/gauge-dashboard"
github-src="charts/dashboard-tile/gauge-dashboard">
</code-view>


The visualization or properties of the visualization are also configurable using the [`IgxToolbarComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_layouts.igxtoolbarcomponent.html) at the top of the control. This [`IgxToolbarComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_layouts.igxtoolbarcomponent.html) has the default tools for the current visualization with the addition of four Dashboard Tile specific ones, highlighted below:

<img src="../images/dashboard-tile-toolbar.png" />

From left to right:

* The first tool will show a data grid with the `DataSource` provided to the control. This is a toggle tool, so if you click it again after showing the grid, it will revert to the visualization.
* The second tool allows you to configure the settings of the current data visualization.
* The third tool allows you to change the current visualization, allowing you to plot a different series type or show a different type of visualization altogether. This can be set on the control by setting the `VisualizationType` property, mentioned above.
* The last tool allows you to configure which properties on your underlying data item are included for the control. You can configure this by setting the [`includedProperties`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxdomainchartcomponent.html#includedProperties) or [`excludedProperties`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxdomainchartcomponent.html#excludedProperties) collection on the control.

This demo demonstrates dashboard tile integration with the Angular Pie Chart. The toolbar options at the top right provides access to styling and changing the data visualization.

<code-view style="height: 600px" alt="Angular Dashboard Tile Pie Example"
data-demos-base-url="{environment:dvDemosBaseUrl}"
iframe-src="{environment:dvDemosBaseUrl}/charts/dashboard-tile/pie-dashboard"
github-src="charts/dashboard-tile/pie-dashboard">
</code-view>


This demo demonstrates dashboard tile integration with the Angular Geographic Map. The toolbar options at the top right provides access to styling and changing the data visualization.

<code-view style="height: 600px" alt="Angular Dashboard Tile Map Example"
data-demos-base-url="{environment:dvDemosBaseUrl}"
iframe-src="{environment:dvDemosBaseUrl}/charts/dashboard-tile/map-dashboard"
github-src="charts/dashboard-tile/map-dashboard">
</code-view>


## API References

* [`IgxToolbarComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_layouts.igxtoolbarcomponent.html)
* [`IgxCategoryChartComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxcategorychartcomponent.html)
* [`IgxDataChartComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxdatachartcomponent.html)
* [`IgxDataPieChartComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxdatapiechartcomponent.html)
* [`IgxGeographicMapComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_maps.igxgeographicmapcomponent.html)
* [`IgxLinearGaugeComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_gauges.igxlineargaugecomponent.html)
* [`IgxRadialGaugeComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_gauges.igxradialgaugecomponent.html)

## Additional Resources

* [Ignite UI for Angular **Forums**](https://www.infragistics.com/community/forums/f/ignite-ui-for-angular)
* [Ignite UI for Angular **GitHub**](https://github.com/IgniteUI/igniteui-angular)
14 changes: 14 additions & 0 deletions en/components/general-changelog-dv.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,20 @@ All notable changes for each version of Ignite UI for Angular are documented on
* [Ignite UI for Angular CHANGELOG.md at Github](https://github.com/IgniteUI/igniteui-angular/blob/master)

## **Version TBA (December 2024)**

### igniteui-angular-charts (Charts)

DashboardTile (Beta)

* New [Dashboard Tile](dashboard-tile.md) component is a container control that analyzes and visualizes a bound ItemsSource collection or single point and returns an appropriate data visualization based on the schema and count of the data. This control utilizes a built-in [Toolbar](menus/toolbar.md) component to allow you to make changes to the visualization at runtime, allowing you to see many different visualizations of your data with minimal code.

### igniteui-angular-charts (Inputs)

* New ColorEditor & Toolbar ToolAction (Beta)

This new editor can be used as a standalone color picker and is now integrated into the [Toolbar](menus/toolbar.md) component to update visualizations at runtime.

## **18.1.0 (September 2024)**

* [Data Pie Chart](charts/types/data-pie-chart.md) - The [`IgxDataPieChartComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxdatapiechartcomponent.html) is a new component that renders a pie chart. This component works similarly to the [`IgxCategoryChartComponent`]({environment:dvApiBaseUrl}/products/ignite-ui-angular/api/docs/typescript/latest/classes/igniteui_angular_charts.igxcategorychartcomponent.html), in that it will automatically detect the properties on your underlying data model while allowing selection, highlighting, animation and legend support via the ItemLegend component.
Expand Down
88 changes: 88 additions & 0 deletions en/components/inputs/color-editor.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,88 @@
---
title: Angular Color Editor | Color Editor | Infragistics
_description: Color Editor component provides an easily configurable option to change colors for any desirable component or aspect of your application.
_keywords: Angular Color Editor, Ignite UI for Angular, Infragistics
mentionedTypes: ["ColorEditor"]
namespace: Infragistics.Controls
---

# Angular Color Editor Overview (preview)

The Ignite UI for Angular Color Editor is a lightweight color picker component. The Color Editor can pop open by clicking the brush icon. Both the rgba and hex values can be obtained from the desired color along the bottom. These values will update when the three sliders are modified. The center box is designed for adjusting the saturation and brightness along with two adjacent sliders for adjusting the rgb and luminance values. Rgb registers between (1-255). The lightness registers between(0-1).

## Angular Color Editor Example

<code-view style="height: 320px" alt="Angular Color Editor Example"
data-demos-base-url="{environment:dvDemosBaseUrl}"
iframe-src="{environment:dvDemosBaseUrl}/inputs/color-editor/overview"
github-src="inputs/color-editor/overview">
</code-view>


<div class="divider--half"></div>

## Dependencies

<!-- Angular, WebComponents, React -->

First, you need to install the Ignite UI for Angular by running the following command:

```cmd
npm install igniteui-angular-core
npm install igniteui-angular-inputs
```

Before using the `ColorEditor`, you need to register the following modules as follows:

<!-- end:Angular, WebComponents, React -->

## Usage

The simplest way to start using the `ColorEditor` is as follows:

<!-- Angular -->

```html
<igx-color-editor
name="colorEditor"
#colorEditor>
</igx-color-editor>
</div>
```

<!-- end: Angular -->

## Binding to events

The Color Editor component raises the following events:

* valueChanged
* valueChanging

<!-- Angular -->

```ts
@ViewChild("colorEditor", { static: true } )
private colorEditor: IgxColorEditorComponent
public ngAfterViewInit(): void
{
this.colorEditor.valueChanged.subscribe(this.onValueChanged);
}

public onValueChanged = (e: any) => {
console.log("test");
}
```

<!-- end: Angular -->

<div class="divider--half"></div>

## API References

* `ColorEditor`

## Additional Resources

* [Ignite UI for Angular **Forums**](https://www.infragistics.com/community/forums/f/ignite-ui-for-angular)
* [Ignite UI for Angular **GitHub**](https://github.com/IgniteUI/igniteui-angular)
Binary file added en/images/dashboard-tile-toolbar.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit bab84c4

Please sign in to comment.