Skip to main content

channels

Type: string[]
Default: undefined

The keys of the channels you wish to make selectable. Objects that have no channel assigned, or that have a channel assigned whose key is not in this list, will not be selectable. However, by passing in NO_CHANNEL as channel key, objects without channel become selectable.

You cannot supply an empty array: the channels array needs to be either undefined, or an array of at least one element.

channels: ['0ef73fd9-693c-5073-98ac-d1dd8cd86536', 'd3dffb97-c797-f2c3-280b-0c89e996ec19']

channels: ['0ef73fd9-693c-5073-98ac-d1dd8cd86536', 'NO_CHANNEL']

GA areas with area places in multiple channels​

A GA area with area places is split into parts: one part for each channel, and one part for the places that are in no channel. The renderer sells the places of one part only.

If the channels you pass in match two or more parts of the same GA area, only the places in no channel are shown. They are selectable only if you pass in NO_CHANNEL. To sell the places of one channel, pass in that channel without the other channels of the area, and without NO_CHANNEL.

For example, GA1 has 100 places: 40 in channel1, 40 in channel2 and 20 in no channel.

channels: ['channel1Key'] // the 40 places of GA1 in channel1 are selectable
channels: ['channel1Key', 'channel2Key'] // GA1 is not selectable
channels: ['channel1Key', 'NO_CHANNEL'] // only the 20 places of GA1 in no channel are selectable