ChartIQ SDK Documentation

Namespace: Descriptors

CIQ .Scripting. Descriptors

Set of functions designed to process Tags used in the user script to create the necessary study descriptor elements.

histogram(sd, args)

Name	Type	Description
`sd`	CIQ.Studies.StudyDescriptor	Study descriptor
`args`	Array.<object>	Function specific arguments

input(sd, args)

Parses a tag for an input.

Each input will be translated into an entry of the study descriptor's inputs field

User Tag syntax: variableName = input("Input Name here", Input Value here)

Name	Type	Description
`sd`	CIQ.Studies.StudyDescriptor	Study descriptor
`args`	Array.<object>	Function specific arguments

plot(sd, args)

Parses a tag for plot (rendering) commands.

Currently renders a line.

Each plot will be translated into an output and added to the study descriptor's outputs field

User Tag syntax: plot(variableName, color: "Color here", display:"Name here")

Name	Type	Description
`sd`	CIQ.Studies.StudyDescriptor	Study descriptor
`args`	Array.<object>	Function specific arguments

study(sd, args)

Parses a tag for the name of the study.

User Tag syntax: study("Study Name here", options)

Name	Type	Description
`sd`	CIQ.Studies.StudyDescriptor	Study descriptor
`args`	Array.<object>	Function specific arguments