mirror of
https://github.com/open-metadata/OpenMetadata.git
synced 2025-10-04 21:32:16 +00:00
39 lines
2.5 KiB
Markdown
39 lines
2.5 KiB
Markdown
|
---
|
||
|
|
title: dataInsightCustomChart
|
||
|
|
slug: /main-concepts/metadata-standard/schemas/datainsight/custom/datainsightcustomchart
|
||
|
|
---
|
||
|
|
|
||
|
|
# Chart
|
||
|
|
|
||
|
|
*DI Chart Entity*
|
||
|
|
|
||
|
|
## Properties
|
||
|
|
|
||
|
|
- **`id`**: Unique identifier of this table instance. Refer to *../../type/basic.json#/definitions/uuid*.
|
||
|
|
- **`name`**: Name that identifies this data insight chart. Refer to *../../type/basic.json#/definitions/entityName*.
|
||
|
|
- **`displayName`** *(string)*: Display Name the data insight chart.
|
||
|
|
- **`fullyQualifiedName`**: FullyQualifiedName same as `name`. Refer to *../../type/basic.json#/definitions/fullyQualifiedEntityName*.
|
||
|
|
- **`description`**: Description of the data insight chart. Refer to *../../type/basic.json#/definitions/markdown*.
|
||
|
|
- **`chartType`** *(string)*: Type of chart, used for UI to render the chart. Must be one of: `['LineChart', 'AreaChart', 'BarChart', 'SummaryCard']`.
|
||
|
|
- **`chartDetails`**
|
||
|
|
- **`isSystemChart`** *(boolean)*: Flag to indicate if the chart is system generated or user created. Default: `False`.
|
||
|
|
- **`owner`**: Owner of this chart. Refer to *../../type/entityReference.json*.
|
||
|
|
- **`version`**: Metadata version of the entity. Refer to *../../type/entityHistory.json#/definitions/entityVersion*.
|
||
|
|
- **`updatedAt`**: Last update time corresponding to the new version of the entity in Unix epoch time milliseconds. Refer to *../../type/basic.json#/definitions/timestamp*.
|
||
|
|
- **`updatedBy`** *(string)*: User who made the update.
|
||
|
|
- **`href`**: Link to the resource corresponding to this entity. Refer to *../../type/basic.json#/definitions/href*.
|
||
|
|
- **`changeDescription`**: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription*.
|
||
|
|
- **`incrementalChangeDescription`**: Change that lead to this version of the entity. Refer to *../../type/entityHistory.json#/definitions/changeDescription*.
|
||
|
|
- **`deleted`** *(boolean)*: When `true` indicates the entity has been soft deleted. Default: `False`.
|
||
|
|
- **`dashboard`**: Dashboard where this chart is displayed. Refer to *../../type/entityReference.json*.
|
||
|
|
## Definitions
|
||
|
|
|
||
|
|
- **`function`** *(string)*: aggregation function for chart. Must be one of: `['count', 'sum', 'avg', 'min', 'max', 'unique']`.
|
||
|
|
- **`kpiDetails`** *(object)*: KPI details for the data insight chart.
|
||
|
|
- **`startDate`** *(string)*: Start Date of KPI.
|
||
|
|
- **`endDate`** *(string)*: End Date of KPI.
|
||
|
|
- **`target`** *(number)*: Target value of KPI.
|
||
|
|
|
||
|
|
|
||
|
|
Documentation file automatically generated at 2025-08-12 05:39:47.683420+00:00.
|