-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
compose-sdk-release-bot
committed
Sep 28, 2023
1 parent
94b672f
commit 4e405c9
Showing
154 changed files
with
8,103 additions
and
654 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -52,3 +52,6 @@ lerna-debug.log* | |
| docs/ | ||
| docs-internal/ | ||
| e2e/results.xml | ||
|
|
||
| # generated from storybook build | ||
| storybook-static/ | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
17 changes: 17 additions & 0 deletions
17
docs-md/sdk/modules/sdk-ui/functions/function.ContextMenu.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| --- | ||
| title: ContextMenu | ||
| --- | ||
|
|
||
| # Function ContextMenu | ||
|
|
||
| > **ContextMenu**(`__namedParameters`): `Element` | ||
| ## Parameters | ||
|
|
||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | `__namedParameters` | [`ContextMenuProps`](../type-aliases/type-alias.ContextMenuProps.md) | | ||
|
|
||
| ## Returns | ||
|
|
||
| `Element` |
18 changes: 18 additions & 0 deletions
18
docs-md/sdk/modules/sdk-ui/functions/function.DrilldownBreadcrumbs.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,18 @@ | ||
| --- | ||
| title: DrilldownBreadcrumbs | ||
| --- | ||
|
|
||
| # Function DrilldownBreadcrumbs | ||
|
|
||
| > **DrilldownBreadcrumbs**(`props`, `context`?): `null` \| `ReactElement`\< `any`, `any` \> | ||
| ## Parameters | ||
|
|
||
| | Parameter | Type | | ||
| | :------ | :------ | | ||
| | `props` | [`DrilldownBreadcrumbsProps`](../type-aliases/type-alias.DrilldownBreadcrumbsProps.md) | | ||
| | `context`? | `any` | | ||
|
|
||
| ## Returns | ||
|
|
||
| `null` \| `ReactElement`\< `any`, `any` \> |
63 changes: 63 additions & 0 deletions
63
docs-md/sdk/modules/sdk-ui/functions/function.DrilldownWidget.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,63 @@ | ||
| --- | ||
| title: DrilldownWidget | ||
| --- | ||
|
|
||
| # Function DrilldownWidget | ||
|
|
||
| > **DrilldownWidget**(`props`): `Element` | ||
| React component designed to add drilldown functionality to any type of chart | ||
|
|
||
| It acts as a wrapper around a given chart component, enhancing it with drilldown capabilities | ||
|
|
||
| The widget offers several features including: | ||
| - A context menu for initiating drilldown actions (can be provided as a custom component) | ||
| - Breadcrumbs that not only allow for drilldown selection slicing but also | ||
| provide an option to clear the selection (can be provided as a custom component) | ||
| - Filters specifically created for drilldown operation | ||
| - An option to navigate to the next drilldown dimension | ||
|
|
||
| When an `initialDimension` is specified, the `drilldownDimension` will automatically inherit its value, | ||
| even before any points on the chart are selected. | ||
| This allows for complete control over the chart's dimensions to be handed over to the DrilldownWidget | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | `props` | [`DrilldownWidgetProps`](../type-aliases/type-alias.DrilldownWidgetProps.md) | DrilldownWidget properties | | ||
|
|
||
| ## Returns | ||
|
|
||
| `Element` | ||
|
|
||
| DrilldownWidget wrapper component | ||
|
|
||
| ## Example | ||
|
|
||
| Example of using the `DrilldownWidget` component to | ||
| plot a custom React component that uses the `ExecuteQuery` component to | ||
| query the `Sample ECommerce` data source hosted in a Sisense instance. | ||
| ```ts | ||
| <DrilldownWidget | ||
| drilldownDimensions={[DM.Commerce.AgeRange, DM.Commerce.Gender, DM.Commerce.Condition]} | ||
| initialDimension={DM.Category.Category} | ||
| > | ||
| {({ drilldownFilters, drilldownDimension, onDataPointsSelected, onContextMenu }) => ( | ||
| <ExecuteQuery | ||
| dataSource={DM.DataSource} | ||
| dimensions={[drilldownDimension]} | ||
| measures={measure.sum(DM.Commerce.Revenue)} | ||
| filters={drilldownFilters} | ||
| > | ||
| {(data) => ( | ||
| <MyCustomChart | ||
| rawData={data} | ||
| onContextMenu={onContextMenu} | ||
| onDataPointsSelected={onDataPointsSelected} | ||
| /> | ||
| )} | ||
| </ExecuteQuery> | ||
| )} | ||
| </DrilldownWidget> | ||
| ``` |
49 changes: 49 additions & 0 deletions
49
docs-md/sdk/modules/sdk-ui/functions/function.TreemapChart.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: TreemapChart | ||
| --- | ||
|
|
||
| # Function TreemapChart | ||
|
|
||
| > **TreemapChart**(`props`, `context`?): `null` \| `ReactElement`\< `any`, `any` \> | ||
| A React component displaying hierarchical data in the form of nested rectangles. | ||
| This type of chart can be used in different scenarios, for example, | ||
| instead of a column chart if you have to compare too many categories and sub-categories. | ||
| See [Treemap Chart](https://docs.sisense.com/main/SisenseLinux/treemap.htm) for more information. | ||
|
|
||
| ## Parameters | ||
|
|
||
| | Parameter | Type | Description | | ||
| | :------ | :------ | :------ | | ||
| | `props` | [`TreemapChartProps`](../interfaces/interface.TreemapChartProps.md) | Treemap chart properties | | ||
| | `context`? | `any` | - | | ||
|
|
||
| ## Returns | ||
|
|
||
| `null` \| `ReactElement`\< `any`, `any` \> | ||
|
|
||
| Treemap Chart component | ||
|
|
||
| ## Example | ||
|
|
||
| An example of using the component to visualize the `Sample ECommerce` data source: | ||
| ```ts | ||
| <TreemapChart | ||
| dataSet={DM.DataSource} | ||
| dataOptions={{ | ||
| category: [ | ||
| { | ||
| column: DM.Commerce.Сondition, | ||
| isColored: true, | ||
| }, | ||
| DM.Commerce.Date.Years | ||
| ], | ||
| value: [measures.sum(DM.Commerce.Quantity)], | ||
| }} | ||
| onDataPointClick= {(point, nativeEvent) => { | ||
| console.log('clicked', point, nativeEvent); | ||
| }} | ||
| /> | ||
| ``` | ||
| ### | ||
| <img src="../../../img/treemap-chart-example-1.png" width="600px" /> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.