ZoomCharts Documentation

ZoomCharts.Configuration.FacetChartSettings

Inheritance hierarchy

This type inherits from LinearChartSettings. Through this type it also inherits members from BaseSettings.

Methods

This type does not define any methods.

Properties

Inherited from: BaseSettings
Inherited from: BaseSettings

Chart area related settings.

assetsUrlBase: string
Inherited from: BaseSettings

The URL root where the ZoomCharts library and assets are located. For example, if the base.css file is available at 'http://server/css/zoomcharts/zc.css' then this value should be set to 'http://server/css/zoomcharts/'. Note that the library will try to determine its location automatically by searching the included script tags. So this property can be skipped if the assets folder is located next to 'zoomcharts.js' file on the server.

chartTypes: anonymous type
Inherited from: LinearChartSettings

Default series settings for each series rendering type. Use this to configure all series of specific type to get line or column chart or combination of them.

Properties

Series type to render values as vertical bars.

Series type to connect value points by lines.

container: string | HTMLElement
Inherited from: BaseSettings

Element of the page where the chart will be inserted. Any HTML element should work, for example you can use a <div>.

Any contents of the element will be cleared - this behavior can be used to specify a loading message as the initial content, for example <div>Chart is being initialized...</div>.

Note that a single element can host only one chart. If the same container is given to another chart, the previous chart will be automatically disposed.

Unless parentChart is specified, the value of the property is mandatory and can only be specified while creating the chart, not with updateSettings. The value can be either an ID of an existing element or a reference to a DOM element.

Inherited from: BaseSettings

Settings for displaying chart credits. Use it as a reference to additional data sources if necessery.

Chart including credits

Note that even if credits enabled on page load, it's possible to hide on exported images.

Inherited from: BaseSettings

Settings used to load data into chart. Customise preferred data source feeding methods. You can use one of these options: url, data function, preloaded data.

events: LinearChartSettingsEvents<FacetChartChartEventArguments, FacetChartChartClickEventArguments>
Inherited from: BaseSettings

The events used to handle user interaction with UI elements.

Chart x-axis line rendered at the bottom horizontally to display group names under each bar.

Configurable conditions to filter the raw data values for subset of drawing facets.

Properties
allowZeroValues: boolean
Introduced in version 1.14.0.

Determines if zero values are automatically filtered from the data or if they will be displayed.

sliceFilter: (item: FacetChartDataObject) => boolean

Determine whether to show item or not.

Parameters

the item to test

Return value
Data type: boolean

true to show, false to not show.

Inherited from: LinearChartSettings

Info popup when hovering over columns or lines. Content returned in a form of html and is relevant to context of series hovered.

Inherited from: BaseSettings

A variety of interaction options that includes scrolling, zooming and swipe.

Series cluster including name placed on facet axis.

Properties

Facet item style.

Properties
expandable: boolean

Whether to open series item on click

label: string

Facet item text

styleFunction: (item: FacetChartItem, itemData: FacetChartDataObject) => void

Dynamically determine item style from data.

Parameters

item to apply predefined style

data relevant to item

Inherited from: BaseSettings

The chart legend by additional interactivity to change the visibility of series it corresponds.

Inherited from: BaseSettings

Localizeable strings including export type options and useful default buttons used for chart interaction. Buttons like to navigate back, set the chart on full screen and others.

navigation: anonymous type

Settings to specify initial view once the page loaded.

Properties
initialDrilldown: Array<string>

Initial facet drilldown to show. For example ['', 'Firefox', 'Firefox 2.5'] denotes to various browsers grouped by versions.

initialOffset: number

Initial scroll offset, number of items from start.

parentChart: BaseApi
Inherited from: BaseSettings

The parent chart within which the new chart will be rendered. If this property is specified, container cannot be specified.

Use area.left, area.top, area.width and area.height settings to position the subchart within parent chart.

See also

Left, right scroll buttons if additional facets available

Inherited from: LinearChartSettings

Array of series in the chart. Each of the series can be different type, can use different data source and aggregation. Additionally, series can be clustered and stacked.

Inherited from: LinearChartSettings

The default series used as the chart dominant data. Use settings.series array to specify actual series.

Inherited from: LinearChartSettings

Defines stack settings to use in series. Each property is a stack name and value is stack settings. Values stack of each series on top of each other in the specified series order. Those, stacked bars help to visualize data that is a sum of parts, each of which is in a series.

Inherited from: LinearChartSettings

The default style settings for series.

Properties
columnColors: Array<string>

The default colors applied to the series with type: "columns". The colors are applied in order to all series that do not specify an explicit style.

lineColors: Array<string>

The default colors applied to the series with type: "line". The colors are applied in order to all series that do not specify an explicit style.

Inherited from: BaseSettings

Theme to apply. You can either use this to share configuration objects between multiple charts or use one of the predefined themes.

See also
Inherited from: BaseSettings

The chart's main title.

Inherited from: BaseSettings

Adjustable settings to manage default and custom toolbar items, as well as toolbar overall appearance.

Inherited from: LinearChartSettings

Configures one or more value axis. If no axis are defined, valueAxisDefault settings are used to automatically create a single value axis.

Inherited from: LinearChartSettings

The default settings inherited by all value axis.

X