Class: Layout

CIQ.UI. Layout


new Layout(context [, params])

UI Helper for Layout changes, for instance tapping items on the display menu. This Helper is also responsible for initializing menu items in the "display" menu based on the chart layout

Parameters:
Name Type Argument Description
context CIQ.UI.Context

The context

params Object <optional>

Parameters

Properties
Name Type Argument Default Description
activeClassName string <optional>
"ciq-active"

The class name to be added to a node when a layout item is enabled

Since:
  • 4.1.0 Layout no longer takes a node as its first parameter

Methods


clearStudies(node)

Removes all studies from the top most node

Parameters:
Name Type Description
node HTMLElement

getAggregationEdit(node, field)

Parameters:
Name Type Description
node HTMLElement
field string

getAggregationType(node, aggregationType)

Parameters:
Name Type Description
node HTMLElement
aggregationType string

getChartScale(node, chartScale)

Parameters:
Name Type Description
node HTMLElement
chartScale string

getChartType(node, chartType)

Parameters:
Name Type Description
node HTMLElement
chartType string

getExtendedHours(node)

Parameters:
Name Type Description
node HTMLElement

getL2Heatmap(node)

Parameters:
Name Type Description
node HTMLElement

getL2Heatmap(node)

Parameters:
Name Type Description
node HTMLElement

getLanguage()

Displays the current language

Since:
  • 6.1.0 defaults to English

getMarketDepth(node)

Parameters:
Name Type Description
node HTMLElement

getRangeSlider(node)

Parameters:
Name Type Description
node HTMLElement

setAggregationEdit(node, field)

Parameters:
Name Type Description
node HTMLElement
field string

setAggregationType(node, aggregationType)

Parameters:
Name Type Description
node HTMLElement
aggregationType string

setChartScale(node, chartType)

Parameters:
Name Type Description
node HTMLElement
chartType string

setChartType(node, chartType)

Parameters:
Name Type Description
node HTMLElement
chartType string

setExtendedHours(node)

Parameters:
Name Type Description
node HTMLElement

setL2Heatmap(node)

Parameters:
Name Type Description
node HTMLElement

setL2Heatmap(node)

Parameters:
Name Type Description
node HTMLElement

setLanguage()

Populates and displays the language widget


setMarketDepth(node)

Parameters:
Name Type Description
node HTMLElement

setPeriodicity(node, periodicity, interval, timeUnit)

Parameters:
Name Type Description
node HTMLElement
periodicity number
interval number
timeUnit number

setRangeSlider(node)

Parameters:
Name Type Description
node HTMLElement

showAggregationEdit(node, aggregationType)

Parameters:
Name Type Description
node HTMLElement
aggregationType string