yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-10-03 21:03:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
OpenMetadata/openmetadata-docs/content/v1.10.x-SNAPSHOT/main-concepts/metadata-standard/schemas/dataInsight/custom/dataInsightCustomChart.md
Aniket Katkar f224d4295e
Update docs for 1.9.0 (#22895)
2025-08-12 13:29:42 +05:30

2.5 KiB
Raw Blame History

title slug
dataInsightCustomChart /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.