API Reference
Namespaces
Classes
Events
Global
Externals

Class: Panel

CIQ.ChartEngine. Panel


new Panel(name [, yAxis])

Defines a Panel object. Every chart or study is rendered in a panel.

Example: stxx.panels['chart']

Example: stxx.panels['Aroon (14)']

Parameters:
Name Type Argument Description
name string

The name of the panel.

yAxis CIQ.ChartEngine.YAxis <optional>

y-axis (CIQ.ChartEngine.YAxis) object for the panel.

Members


bottom :number

Type:
  • number

chart :CIQ.ChartEngine.Chart

Type:

display :string

Type:
  • string

displayEdgeIfPadded :boolean

Draws a border around the panel's left and right sides for a more finished look, when no y-axis is present.

Type:
  • boolean
Since:
  • 7.1.0

Default Value:
  • true

exportable :boolean

Determines whether the panel is included in the CIQ.ChartEngine#exportLayout return object.

Type:
  • boolean
Since:
  • 8.0.0

Default Value:
  • true

height :number

Type:
  • number

name :string

Type:
  • string

noDrag :boolean

Prevents plot and axis dragging into, out of, and within panels.

Type:
  • boolean
Since:
  • 7.2.0


percent :number

Type:
  • number

shareChartXAxis :boolean

Type:
  • boolean

titlePadding :number

Sets the padding for the panel

Type:
  • number
Since:
  • 9.2.0

Default Value:
  • 5

top :number

Type:
  • number

yAxis :CIQ.ChartEngine.YAxis

Type:

Methods


clipVerticalTextToPanel( [text] [, context])

Clips vertical text to panel height, allowing for padding

Parameters:
Name Type Argument Description
text string <optional>

The text to clip

context object <optional>

CanvasRenderingContext2D

Since:
  • 9.2.0

Returns:

The clipped text

Type
string