Skip to content

Vizzu / Modules / types/config / Channel

Interface: Channel

types/config.Channel

Channels are the main building blocks of the chart. Each channel describes a particular aspect of the markers (vertical & horizontal position, color, etc.) and connects them to the underlying data. A single measure and an ordered list of dimensions can be on each channel. The dimensions will recursively slice the measure on the channel. The channels are represented on the chart as an axis or legend.

Properties

attach

Optional attach: SeriesList

List of data series descriptors to be added to the channel beside the ones already added.


axis

Optional axis: AutoBool

Enables the axis line on axis channels.


detach

Optional detach: SeriesList

List of data series descriptors to be removed from the channel.


guides

Optional guides: AutoBool

Enables the grid lines on axis channels showing dimension data.


interlacing

Optional interlacing: AutoBool

Enables the interlacing on axis channels showing measure data.


labelLevel

Optional labelLevel: number

Only one dimension can be shown on an axis or legend by name. This index specifies which attached series should be used.


labels

Optional labels: AutoBool

Enables the axis labels on axis channels.


markerGuides

Optional markerGuides: AutoBool

Enables the guide lines on axis channels showing measure data for all marker positions.


range

Optional range: ChannelRange

Specifies the range that determines how the represented data scales on the channel.


set

Optional set: null | SeriesList

List of data series descriptors on the channel.


step

Optional step: number | "auto"

Base interval of the interlacing on the axis.


ticks

Optional ticks: AutoBool

Enables the axis ticks on axis channels showing measure data.


title

Optional title: null | string

This title is shown on the axis or legend corresponding to the channel. If 'auto', the title will be the name of the measure attached to that channel.