API reference
API reference
Public integration contracts for this runtime. Runtime-backed facade members are identified separately from legacy declaration-only entries. The compatibility policy remains part of every API contract.
Main interfaces
- LumenChartingLibraryWidgetOptions
- ILumenChartingLibraryWidget
- IChartWidgetApi
- IBasicDataFeed
- IExternalDatafeed
- IDatafeedChartApi
- LibrarySymbolInfo
- Bar
- PeriodParams
- DatafeedConfiguration
- IExternalSaveLoadAdapter
- ILineDataSourceApi
- IStudyApi
- ISelectionApi
- IShapesGroupControllerApi
- IOrderLineAdapter
- IPositionLineAdapter
- IExecutionLineAdapter
- IPaneApi
- IPriceScaleApi
- ITimeScaleApi
- ISubscription
- ChartData
- ChartMetaInfo
- ChartStyle
- ResolutionString
- CreateShapeOptions
- CreateMultipointShapeOptions
Style overrides
- Drawing tool overrides: one section per drawing tool
- Indicator overrides: one section per indicator
Supporting types
- AccessList
- AccessListItem
- ActionId
- ActionOptions
- ActionState
- ActionsFactory
- AdditionalSymbolInfoField
- AreaStylePreferences
- AvailableSaveloadVersions
- AvailableZOrderOperations
- BarDetailizationMode
- BarStylePreferences
- BaselineStylePreferences
- CandleStylePreferences
- ChangeThemeOptions
- ChartActionId
- ChartAutomationFamily
- ChartAutomationOwners
- ChartDataStatus
- ChartDatafeedConnectionStatus
- ChartDatafeedState
- ChartDescriptionContext
- ChartDescriptorFunction
- ChartPropertiesOverrides
- ChartTemplate
- ChartTemplateContent
- ChartTypeFavorites
- ClearMarksMode
- ClientSnapshotOptions
- ColorTypes
- ColumnStylePreferences
- CompareSymbol
- ContextMenuItem
- ContextMenuItemsProcessor
- ContextMenuOptions
- ContextMenuPosition
- ContextMenuRendererFactory
- CreateAnchoredShapeOptions
- CreateButtonOptions
- CreateChartUiStyledButtonOptions
- CreateContextMenuParams
- CreateHTMLButtonOptions
- CreateShapeOptionsBase
- CreateStudyOptions
- CreateStudyTemplateOptions
- CrossHairMovedEventParams
- CrossHairMovedEventSource
- CrossHairMovedEventSourceValue
- CurrencyInfo
- CurrencyItem
- CustomAliasedTimezone
- CustomFormatter
- CustomFormatters
- CustomIndicator
- CustomStatusDropDownAction
- CustomStatusDropDownContent
- CustomStudyFormatter
- CustomStudyFormatterFactory
- CustomStudyFormatterFormat
- CustomTimezoneId
- CustomTimezoneInfo
- CustomTimezones
- CustomTranslateFunction
- CustomTranslateOptions
- DOMCallback
- DOMData
- DOMLevel
- DatafeedQuoteValues
- DatafeedSymbolType
- DateFormat
- DeepPartial
- DeepWriteable
- DialogParams
- Direction
- DrawingEventType
- DrawingOverrides
- DrawingToolIdentifier
- DropdownItem
- DropdownParams
- DropdownUpdateParams
- EditObjectDialogEventParams
- EditObjectDialogObjectType
- EmojiOptions
- EmptyCallback
- EntityId
- EntityInfo
- ErrorCallback
- ErrorFormatterParseResult
- Exchange
- ExportDataOptions
- ExportedData
- Favorites
- FieldDescriptor
- FilledAreaType
- FinancialPeriod
- FormatterParseResult
- GetMarksCallback
- GmtTimezoneId
- GrayedObject
- GroupLockState
- GroupVisibilityState
- HHistDirection
- HHistPreferences
- HLCAreaStylePreferences
- HeaderWidgetButtonsMode
- HeikinAshiStylePreferences
- HiLoStylePreferences
- HistoryCallback
- HistoryMetadata
- HollowCandleStylePreferences
- HorizLinePreferences
- IAction
- IActionVariant
- IBarArray
- IBoxedValue
- IBoxedValueReadOnly
- IContext
- IContextMenuRenderer
- ICustomSymbolStatusAdapter
- ICustomSymbolStatusApi
- IDatafeedQuotesApi
- IDestroyable
- IDropdownApi
- IFormatter
- IMenuItem
- INewsApi
- INonSeriesStudyBarsResult
- INonSeriesStudyResult
- INumberFormatter
- IObservable
- IObservableValue
- IObservableValueReadOnly
- IPineSeries
- IPineStudyResult
- IPineStudyResultSimple
- IPineStudyResultTypes
- IProjectionBar
- IProjectionStudyResult
- ISeparator
- ISeriesApi
- ISeriesStudyResult
- ISettingsAdapter
- ISymbolInstrument
- ISymbolValueFormatter
- ITimezoneApi
- IUpdatableAction
- IWatchListApi
- IWatchedValue
- IWatchedValueReadonly
- IWatermarkApi
- IWidgetbarApi
- IconOptions
- InitialSettingsMap
- IntrabarCoverage
- IntrabarCoverageStatus
- KagiStylePreferences
- LanguageCode
- LayoutType
- LegendMode
- LibraryPineStudy
- LibraryPineStudyConstructor
- LibrarySessionId
- LibrarySubsessionInfo
- LineBreakStylePreferences
- LineStudyPlotStyle
- LineStudyPlotStyleName
- LineStyle
- LineStylePreferences
- LineToolState
- LineToolsAndGroupsLoadRequestContext
- LineToolsAndGroupsLoadRequestType
- LineToolsAndGroupsState
- LineToolsGroupState
- LoadingScreenOptions
- LumenChartingLibraryFeatureset
- MappedObject
- Mark
- MarkConstColors
- MarkCustomColor
- MarkLocation
- MarketStatus
- MenuItemType
- MouseEventParams
- MultipleChartsLayoutType
- Nominal
- NumericFormattingParams
- OmitActionId
- OnActionExecuteHandler
- OnActionUpdateHandler
- OnReadyCallback
- OpenChartAutomationOptions
- OrderLineLengthUnit
- OverrideLineStyle
- OverridePriceAxisLastValueMode
- Overrides
- PageName
- PineAlertConditionMeta
- PineAlertDeliveryProvider
- PineAlertDeliveryReceipt
- PineAlertDeliveryStatus
- PineAlertEvent
- PineAlertFrequency
- PineAlertRule
- PineAlertRuleInput
- PineChartQualifiedSource
- PineChartRuntimeApi
- PineDocumentKind
- PineEditorActionOptions
- PineEditorLayoutRequest
- PineEditorUiOptions
- PineEditorUiPreset
- PineEditorWorkspaceApi
- PineEditorWorkspaceChange
- PineEditorWorkspaceSnapshot
- PineJS
- PineJSStd
- PineLibraryDependencyAnalysis
- PineLibraryLockEntry
- PineLibraryProvider
- PineLibraryRequest
- PineLogCursor
- PineLogEvent
- PineLogPage
- PineObjectOverrideChange
- PineObjectOverridePatch
- PineObjectOverridePath
- PineObjectOverrideSnapshot
- PinePublication
- PinePublicationIdentity
- PinePublicationProvider
- PineResolvedLibrary
- PineScriptCapability
- PineScriptCompileResult
- PineScriptDiagnostic
- PineScriptRunOptions
- PineScriptStudyOptions
- PineScriptStudyState
- PineScriptWidgetOptions
- PineStrategyConfig
- PineStrategyOrder
- PineStrategyReport
- PineStrategyReportChange
- PineStrategyRunIdentity
- PineStrategyRunSettings
- PineStrategySettingsApplyRequest
- PineStrategySettingsHost
- PineStrategySummary
- PineStrategyTimelinePoint
- PineStrategyTrade
- PineStudyMigrationReport
- PineStudyObjectBase
- PineStudyObjectChange
- PineStudyObjectSnapshot
- PineStudyResultComposite
- PineWorkspaceCreateRequest
- PineWorkspaceDocument
- PineWorkspaceDocumentSummary
- PineWorkspaceListRequest
- PineWorkspacePage
- PineWorkspacePermissions
- PineWorkspaceProvider
- PineWorkspaceRevision
- PineWorkspaceRevisionListRequest
- PineWorkspaceRevisionPage
- PineWorkspaceRevisionSummary
- PineWorkspaceUpdateRequest
- PlDisplay
- PlotShapeId
- PlotSymbolSize
- PlusClickParams
- PnFStylePreferences
- PolygonPreferences
- PositionLineLengthUnit
- PositionPercents
- PriceScaleMode
- PriceScaleSelectedCurrency
- PriceSource
- PricedPoint
- QuoteData
- QuoteDataResponse
- QuoteErrorData
- QuoteOkData
- QuotesCallback
- QuotesErrorCallback
- RangeOptions
- RawStudyMetaInfo
- RawStudyMetaInfoBase
- RawStudyMetaInfoId
- RawStudyMetaInformation
- RenkoStylePreferences
- ResolveCallback
- SaveChartOptions
- SaveChartToServerOptions
- SaveLoadChartRecord
- SavedStateMetaInfo
- SearchSymbolResultItem
- SearchSymbolsCallback
- SelectBarRequestOptions
- SeriesEventType
- SeriesFieldDescriptor
- SeriesFormat
- SeriesFormatterFactory
- SeriesPreferencesMap
- SeriesPriceScale
- SeriesStatusViewSymbolTextSource
- SeriesType
- ServerTimeCallback
- SetResolutionOptions
- SetSymbolOptions
- SetVisibleRangeOptions
- SetVisibleTimeRange
- ShapePoint
- ShapesGroupId
- SingleChartLayoutType
- StickedPoint
- StudyArrowsPlotInfo
- StudyArrowsPlotPreferences
- StudyAvailableConstSources
- StudyBandBackgroundPreferences
- StudyBandInfo
- StudyBandPreferences
- StudyBandStyle
- StudyBarColorerPlotInfo
- StudyBarTimeInputInfo
- StudyBgColorerPlotInfo
- StudyBooleanInputInfo
- StudyCandleBorderColorerPlotInfo
- StudyCandleWickColorerPlotInfo
- StudyCharsPlotInfo
- StudyCharsPlotPreferences
- StudyColorInputInfo
- StudyColorerPlotInfo
- StudyDataOffsetPlotInfo
- StudyDataPlotInfo
- StudyDefaults
- StudyDownColorerPlotInfo
- StudyEventType
- StudyFieldDescriptor
- StudyFilledAreaGradientColorStyle
- StudyFilledAreaInfo
- StudyFilledAreaSolidColorStyle
- StudyFilledAreaStyle
- StudyFilledAreaStyleBase
- StudyGraphicsDefaults
- StudyInputBaseInfo
- StudyInputId
- StudyInputInfo
- StudyInputInfoList
- StudyInputInformation
- StudyInputOptionsTitles
- StudyInputType
- StudyInputValue
- StudyInputValueItem
- StudyInputsSimple
- StudyLinePlotInfo
- StudyLinePlotPreferences
- StudyMetaInfo
- StudyNumericInputInfo
- StudyOhlcColorerPlotInfo
- StudyOhlcPlotBarsStylePreferences
- StudyOhlcPlotBaseStylePreferences
- StudyOhlcPlotCandlesStylePreferences
- StudyOhlcPlotInfo
- StudyOhlcPlotPreferences
- StudyOhlcStylesInfo
- StudyOrDrawingAddedToChartEventParams
- StudyOverrideValueType
- StudyOverrides
- StudyPaletteColor
- StudyPaletteColorPreferences
- StudyPaletteInfo
- StudyPalettePreferences
- StudyPaletteStyle
- StudyPalettedPlotInfo
- StudyPalettesInfo
- StudyPlotBaseInfo
- StudyPlotBasePreferences
- StudyPlotDisplayMode
- StudyPlotDisplayTarget
- StudyPlotInfo
- StudyPlotInformation
- StudyPlotPreferences
- StudyPlotValueFormat
- StudyPlotValueInheritFormat
- StudyPlotValuePrecisionFormat
- StudyPriceInputInfo
- StudyPriceScale
- StudyPrimitiveResult
- StudyResolutionInputInfo
- StudyResultValueWithOffset
- StudyRgbaColorerPlotInfo
- StudySessionInputInfo
- StudyShapesPlotInfo
- StudyShapesPlotPreferences
- StudySourceInputInfo
- StudyStyleInfo
- StudyStyleInfoDefaults
- StudyStyleValues
- StudyStylesInfo
- StudySymbolInputInfo
- StudyTargetPriceScale
- StudyTargetedPlotInfo
- StudyTemplateData
- StudyTemplateMetaInfo
- StudyTextColorerPlotInfo
- StudyTextInputInfo
- StudyTextareaInputInfo
- StudyTimeInputInfo
- StudyUpColorerPlotInfo
- StyledText
- SubscribeBarsCallback
- SubscribeEventsMap
- SuccessFormatterParseResult
- SupportedLineTools
- SymbolExt
- SymbolInfoPriceSource
- SymbolInputSymbolSource
- SymbolIntervalResult
- SymbolResolveExtension
- SymbolSearchCompleteData
- SymbolSearchCompleteOverrideFunction
- SymbolSource
- ThemeName
- TickMarkType
- TimeFieldDescriptor
- TimeFrameItem
- TimeFramePeriodBack
- TimeFrameTimeRange
- TimeFrameValue
- TimeHoursFormat
- TimePoint
- TimeScaleMarkShape
- TimeScaleOptions
- TimeframeOption
- TimescaleMark
- Timezone
- TimezoneId
- TimezoneInfo
- UndoOptions
- UndoRedoState
- Unit
- UnitInfo
- UserTimeFieldDescriptor
- ValueByStyleId
- VertLinePreferences
- VisibilityType
- VisiblePlotsSet
- VisiblePriceRange
- VisibleTimeRange
- WatchListSymbolList
- WatchListSymbolListAddedCallback
- WatchListSymbolListChangedCallback
- WatchListSymbolListData
- WatchListSymbolListMap
- WatchListSymbolListRemovedCallback
- WatchListSymbolListRenamedCallback
- WatchedValueCallback
- WatchedValueSubscribeOptions
- WatermarkContentData
- WatermarkContentProvider
- WatermarkLine
- WidgetOverrides