input

Functions

bool

navi

bool(
    defval: const bool,
    title: const String = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input bool

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const bool`		The default value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input bool

color

navi

color(
    defval: const Color,
    title: const String = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input Color

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const Color`		The default color value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input Color

enum

navi

enum<T>(
    defval: const T,
    title: const String = na,
    options: const Array<T> = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input T

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const T`		The default enum value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`options`	`const Array<T>`	`na`	An array of allowed enum values.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input T

float

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const float`		The default value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`options`	`const Array<float>`	`na`	An array of allowed values for the input.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input float

int

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const int`		The default value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`options`	`const Array<int>`	`na`	An array of allowed values for the input.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input int

price

navi

price(
    defval: const float,
    title: const String = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input float

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const float`		The default price value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input float

session

navi

session(
    defval: const String,
    title: const String = na,
    options: const Array<String> = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input String

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const String`		The default session value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`options`	`const Array<String>`	`na`	An array of allowed session values.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input String

source

navi

source(
    defval: const expression,
    title: const String = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true,
    confirm: const bool = false
  ): input float

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const expression`		The default series expression value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.

Returns: input float

string

navi

string(
    defval: const String,
    title: const String = na,
    options: const Array<String> = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input String

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const String`		The default String value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`options`	`const Array<String>`	`na`	An array of allowed values for the input.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input String

symbol

navi

symbol(
    defval: const String,
    title: const String = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input String

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const String`		The default symbol value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input String

text_area

navi

text_area(
    defval: const String,
    title: const String = na,
    tooltip: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input String

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const String`		The default text value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input String

time

navi

time(
    defval: const int,
    title: const String = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input int

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const int`		The default time value of the input as UNIX timestamp.
`title`	`const String`	`na`	The label for the input in the settings.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input int

timeframe

navi

timeframe(
    defval: const String,
    title: const String = na,
    options: const Array<String> = na,
    tooltip: const String = na,
    inline: const String = na,
    group: const String = na,
    confirm: const bool = false,
    display: const PlotDisplay = PlotDisplay.ALL,
    active: input bool = true
  ): input String

Creates an input value exposed in the script settings UI.

Parameters

Name	Type	Default	Description
`defval`	`const String`		The default timeframe value of the input.
`title`	`const String`	`na`	The label for the input in the settings.
`options`	`const Array<String>`	`na`	An array of allowed timeframe values.
`tooltip`	`const String`	`na`	The tooltip text for the input.
`inline`	`const String`	`na`	The inline group name for layout.
`group`	`const String`	`na`	The input group name for organization.
`confirm`	`const bool`	`false`	If true, a confirmation dialog is shown.
`display`	`const PlotDisplay`	`PlotDisplay.ALL`	The display mode for the input.
`active`	`input bool`	`true`	If true, the input is active.

Returns: input String

input ​

Functions ​

bool ​

color ​

enum ​

float ​

int ​

price ​

session ​

source ​

string ​

symbol ​

text_area ​

time ​

timeframe ​

input

Functions

bool

color

enum

float

int

price

session

source

string

symbol

text_area

time

timeframe