Syncfusion TypeScript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides functionality to render, update, and destroy charts linked to a Grid instance.

Hierarchy

  • GridChart

Index

Properties

Methods

Object literals

Properties

Private accumulationChartElement

accumulationChartElement: HTMLElement

Private chartContainer

chartContainer: HTMLElement

Private chartElement

chartElement: HTMLElement

Private chartExport

chartExport: ChartExport

Private chartPanel

chartPanel: ChartPanel

Private dataSource

dataSource: Object[]

Private defaultAccumulationChartModel

defaultAccumulationChartModel: AccumulationChartModel = extend({enableSmartLabels: true}, this.commonChartModel, {}, true)

Private defaultChartLocale

defaultChartLocale: Object

Private defaultChartModel

defaultChartModel: ChartModel = extend({primaryXAxis: {isInversed: false,title: null,titleStyle: { fontFamily: null, size: '16px', color: null },labelStyle: { fontFamily: null, size: '12px', color: null },labelRotation: 0},primaryYAxis: {isInversed: false,title: null,titleStyle: { fontFamily: null, size: '16px', color: null },labelStyle: { fontFamily: null, size: '12px', color: null },labelRotation: 0}}, this.commonChartModel, {}, true)

Private dialogChartContainer

dialogChartContainer: HTMLElement

Private dialogElement

dialogElement: HTMLElement

Private dialogObj

dialogObj: Dialog

Private element

element: HTMLElement

Private exportChartContainer

exportChartContainer: HTMLElement

Private localeObj

localeObj: L10n

Methods

Private destroy

  • destroy(): void

  • Cleans up and disposes the chart instance(s).

    Returns void

Private generateChartLocale

  • generateChartLocale(): void

  • Returns void

Private getChartDialogHeight

  • getChartDialogHeight(gridObj: IGrid): string | number

  • Parameters

    • gridObj: IGrid

    Returns string | number

Private getChartDialogWidth

  • getChartDialogWidth(gridObj: IGrid): string | number

  • Parameters

    • gridObj: IGrid

    Returns string | number

initDialogUI

  • Initializes the dialog UI for the "Chart" options. This function attaches a dialog with custom components to the target element within the grid, using selected records for dynamic data representation.

    Parameters

    • args: ChartPopupArgs

      specifies the dialog properties.

    • Optional beforeDestroy: Function

      – defines the destroy function which is executed before the dialog close.

    Returns Promise<InitDialogUIArgs>

    A promise that resolves with the target element, grid instance, and selected records.

Private initializeLayout

  • initializeLayout(): void

  • Returns void

Private isBiggerTheme

  • isBiggerTheme(gridObj: IGrid): boolean

  • Parameters

    • gridObj: IGrid

    Returns boolean

refresh

  • Updates the chart with new data or settings.

    Parameters

    • changes: ChartChanges

      Defines the changes to apply for the chart.

    Returns void

Private refreshChart

  • Parameters

    Returns void

render

  • Renders a chart using the specified grid selection and chart configuration.

    Parameters

    • chartPopupArgs: ChartPopupArgs

      Contains information about the selected grid records and chart type.

    • chartModel: ChartChanges

      Chart configuration model.

    • categorySeries: CategorySeries

      Defines the chart category and series.

    Returns void

Private renderChart

  • Parameters

    Returns void

Object literals

Private commonChartModel

commonChartModel: object

background

background: null = null

subTitle

subTitle: null = null

title

title: null = null

legendSettings

legendSettings: object

enablePages

enablePages: true = true

position

position: "Auto" = "Auto"

textOverflow

textOverflow: "Ellipsis" = "Ellipsis"

visible

visible: true = true

textStyle

textStyle: object

color

color: null = null

fontFamily

fontFamily: null = null

size

size: string = "16px"

margin

margin: object

bottom

bottom: number = 10

left

left: number = 10

right

right: number = 10

top

top: number = 10

subTitleStyle

subTitleStyle: object

color

color: null = null

fontFamily

fontFamily: null = null

size

size: string = "15px"

titleStyle

titleStyle: object

color

color: null = null

fontFamily

fontFamily: null = null

size

size: string = "15px"

tooltip

tooltip: object

enable

enable: true = true

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Type alias with type parameter
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc