ChartIQ SDK Legacy Documentation -

Class: Views

STX. Views

new Views()

This class is maintained for legacy implementations only (not using web components). New implementations should use functionality included in the web components (stxUI.js)
Native implementation of multiple views. Views are accessible in the footer. Requires an STX.StorageManager for serializing views.

Version:
  • ChartIQ Advanced Package

Members

<static> currentView :Number

Index into STX.Views.views of the current view. -1 if no current view is enabled.

Type:
  • Number
Version:
  • ChartIQ Advanced Package

<static> updateGUI

Called when a view is enabled to update any required GUI elements. Set to a function as required by your UI.

Version:
  • ChartIQ Advanced Package
Since:
  • 2016-06-21

<static> views :Array

Contains the list of available views

Type:
  • Array
Version:
  • ChartIQ Advanced Package

Methods

<static> deleteView(i)

Deletes the selected view

Parameters:
Name Type Description
i number

Index into STX.Views.views of the view to delete
Version:
  • ChartIQ Advanced Package

<static> enableView(i)

Enables the requested view

Parameters:
Name Type Description
i number

Index into STX.Views.views of the requested view
Version:
  • ChartIQ Advanced Package

<static> indexOf(name)

Returns the index of a view given the name

Parameters:
Name Type Description
name string

Name of the view
Version:
  • ChartIQ Advanced Package
Since:
  • TBD
Returns:

Index of the view (or -1 if not found)

Type
number

<static> initialize(stx, stxStorageManager [, managePeriodicity])

Initializes the STX.Views object. Requires an STX.StorageManager for serializing views.

Parameters:
Name Type Argument Default Description
stx object

The chart object
stxStorageManager object

STX.StorageManager
managePeriodicity boolean <optional>
 false

If true then periodicity will be controlled by views. The default behavior is that views are independent of periodicity.
Version:
  • ChartIQ Advanced Package

<static> openNewViewDialog()

Opens the save view dialog

Version:
  • ChartIQ Advanced Package

<static> refreshDisplay()

Refreshes the views display. This is called whenever the screensize changes so that iscrolls can refresh themselves. Call this manually if HTML changes affect the size of the footer.

Version:
  • ChartIQ Advanced Package

<static> saveView()

Saves the current layout as a new view. The name of the view is taken from the dialog.

Version:
  • ChartIQ Advanced Package