ZoomCharts Documentation

Version: 1.21.1 (2024-11-08)

ZoomCharts.Configuration.FacetChartDataObjectRoot

Inheritance hierarchy

This type inherits from FacetChartDataObjectCommon and BaseDataErrorResponse. Through these types it also inherits members from BaseDataObjectBase and BaseDataObjectBase.

Methods

This type does not define any methods.

Properties

afterSum: number

In the case of a partial load, this specifies the sum of all values in the data source which come after the values in the subvalues array. If you're doing a partial load, you must specify at least 2 of the following: afterSum, beforeSum, sum.

beforeSum: number

In the case of a partial load, this specifies the sum of all values in the data source which come before the values in the subvalues array. If you're doing a partial load, you must specify at least 2 of the following: afterSum, beforeSum, sum.

error: string
Inherited from: BaseDataErrorResponse

If the data could not be retrieved, this field can be used to instruct the chart to cancel the data request and log an error. Note that in most cases this field should not be used in favor of returning the correct HTTP status code (such as 404 or 500) so that the browser and any proxies do not cache the response.

extra: any
Inherited from: BaseDataObjectBase

Store any additional data values within this field. Although it is possible to extend the data object itself with additional fields it is not recommended to do so because a future ZoomCharts version could introduce a known parameter with the same name thus changing the behavior of an existing chart.

id: string

The ID of the pie for which the data is being loaded. Note that for the initial data request this value has to be empty, otherwise the chart assumes that the data is for a nested object and not for the initial view.

limit: number

In the case of a partial load, this specifies the maximum number of entries that was fetched from the data source. This is used to figure out if more data is available. If this field isn't set, or is set and is larger than the count of values in the subvalues array, then it is assumed that no more data is available.

name: string

The name of the root data object.

offset: number

In the case of a partial load, this specifies the offset in the data source where the subvalues array starts. This parameter is mandatory if you're doing a partial load.

Values for this drilldown level. In the case of a partial load, this will contain only a part of all values available in the data source.

sum: number

In the case of a partial load, this specifies the sum of all values in the data source. If you're doing a partial load, you must specify at least 2 of the following: afterSum, beforeSum, sum.

X