charton

Appearance

charton API

charton API / @chart-on/ui / index / ToolbarItemText

Interface: ToolbarItemText ​

Defined in: ui/src/toolbar.ts:45

Text that follows the chart's language.

Properties ​

labelKey? ​

optional labelKey?: "drawingSelected" | "drawingFill" | "sessionOpen" | "sessions" | "menuLabel" | "menuAppearance" | "appearanceWatermarkText" | "appearanceLogo" | "appearanceNameSize" | "appearanceSymbolSize" | "appearanceIntervalSize" | "menuResetView" | "menuScrollToNewest" | "menuCopyPrice" | "menuAddHorizontalLine" | "menuAddVerticalLine" | "menuAutoScale" | "menuLogScale" | "menuPercentScale" | "menuInvertScale" | "drawingLock" | "drawingUnlock" | "drawingClone" | "drawingDelete" | "drawingGroup" | "drawingUngroup" | "toolKeepHint" | "toolKept" | "seriesPrice" | "seriesFallback" | "panePrice" | "paneNumber" | "paneNumberTitles" | "seriesSettings" | "seriesDuplicate" | "seriesMoveUp" | "seriesMoveDown" | "seriesMoveToPricePane" | "seriesMoveToNewPane" | "seriesMergeIntoPane" | "seriesFoldLegend" | "seriesRemove" | "seriesScale" | "seriesScaleRight" | "seriesScaleLeft" | "seriesScaleOwn" | "seriesShowOn" | "seriesShowOnHidden" | "seriesShowOnAll" | "intervalSeconds" | "intervalMinutes" | "intervalHours" | "intervalDays" | "intervalWeeks" | "intervalMonths" | "intervalTicks" | "intervalVolume" | "intervalTrade" | "intervalTrades" | "intervalVolumeOf" | "drawingVisibility" | "drawingVisibleMonths" | "drawingVisibleRange" | "drawingVisibleNone" | "drawingVisibleWhole" | "indicatorPlot" | "indicatorPlotVisible" | "indicatorPlotLineWidth" | "indicatorPlotLineStyle" | "lineStyleSolid" | "lineStyleDashed" | "lineStyleDotted" | "seriesColor" | "seriesColorAbove" | "seriesColorBelow" | "seriesColorPositive" | "seriesColorNegative" | "seriesColorUp" | "seriesColorDown" | "seriesPlacement" | "seriesPlacementPercent" | "seriesPlacementScale" | "seriesPlacementPane" | "replayLabel" | "replayBack" | "replayPlay" | "replayPause" | "replayStep" | "replaySpeed" | "replayRandom" | "replayExit" | "objectTreeTitle" | "objectTreeMainPane" | "objectTreeSelectedObjects" | "objectTreeSelectedCount" | "objectTreeToggleSelected" | "objectTreeLockSelected" | "objectTreeRemoveSelected" | "objectTreeCollapse" | "objectTreeExpand" | "objectTreeHide" | "objectTreeShow" | "objectTreeLock" | "objectTreeUnlock" | "objectTreeRemove" | "objectTreeRename" | "objectTreeKindPane" | "objectTreeKindSeries" | "objectTreeKindIndicator" | "objectTreeKindDrawing" | "objectTreeCollapsed" | "objectTreeHidden" | "objectTreeLocked" | "seriesKindCandles" | "seriesKindHistogram" | "seriesKindLine" | "seriesKindHeatmap" | "seriesKindIndicator" | "seriesKindCustom" | "seriesKindVolumeProfile" | "seriesKindPoints" | "actionSymbolSearch" | "actionIndicatorPicker" | "actionNextRegion" | "actionPreviousRegion" | "actionCommandPalette" | "actionLightMode" | "actionDarkMode" | "paletteTitle" | "palettePlaceholder" | "paletteSearchLabel" | "paletteAll" | "paletteActions" | "paletteEmpty" | "paletteOn" | "paletteOff" | "symbolSearchInput" | "symbolSearchPlaceholder" | "symbolSearchList" | "symbolSearchType" | "symbolSearchAllTypes" | "symbolSearchExchange" | "symbolSearchAllExchanges" | "symbolSearchSearching" | "symbolSearchFailed" | "symbolSearchLoadFailed" | "symbolSearchLoadingMore" | "symbolSearchMoreFailed" | "symbolSearchUnavailable" | "symbolSearchRetry" | "symbolSearchNoResults" | "symbolSearchResult" | "symbolSearchResults" | "symbolSearchNoMatch" | "symbolSearchNoFilterMatch" | "symbolSearchPrompt" | "toolbarLabel" | "symbolHeaderEmpty" | "symbolHeaderLabel" | "toolbarMore" | "toolbarCustomize" | "toolbarReset" | "toolbarContext" | "toolbarAnalysis" | "toolbarView" | "toolbarAvailable" | "toolbarMoveUp" | "toolbarMoveDown" | "toolbarRemove" | "toolbarDrag" | "toolbarMoved" | "toolbarMoveToBottomBar" | "toolbarMoveToToolbar" | "toolbarSaveError" | "toolbarInterval" | "toolbarChartType" | "toolbarDownloadImage" | "toolbarCaptureFailed" | "toolbarCaptureUnavailable" | "toolbarPrint" | "toolbarPrintFailed" | "toolbarDownloadData" | "toolbarNoData" | "toolbarFullScreen" | "toolbarDrawingTools" | "toolbarCompare" | "toolbarHide" | "toolbarHideDrawings" | "toolbarHideIndicators" | "toolbarHideAll" | "toolbarLayout" | "toolbarSettings" | "toolbarTableView" | "toolbarToggleVisibility" | "toolbarToggleDrawings" | "dialogClose" | "historyUndo" | "historyRedo" | "chartStyleBars" | "chartStyleHlcBars" | "chartStyleCandles" | "chartStyleHollow" | "chartStyleVolumeCandles" | "chartStyleHeikinAshi" | "chartStyleHighLow" | "chartStyleColumns" | "chartStyleLine" | "chartStyleLineMarkers" | "chartStyleStep" | "chartStyleArea" | "chartStyleRangeBand" | "chartStyleBaseline" | "chartStyleKagi" | "chartStylePointFigure" | "chartStyleSectionOhlc" | "chartStyleSectionRange" | "chartStyleSectionClose" | "railLabel" | "railCursor" | "railCursorPointer" | "railGroupCursors" | "railFavoritesBar" | "railMagnet" | "railLock" | "railHide" | "railClear" | "railMoreGroup" | "railGroupLines" | "railGroupAnnotate" | "railGroupParallels" | "railGroupRatios" | "railGroupTime" | "railGroupPatterns" | "railGroupMeasure" | "railSectionTrend" | "railSectionLevel" | "railSectionText" | "railSectionShapes" | "railSectionArrows" | "railSectionFreehand" | "railSectionChannels" | "railSectionPitchforks" | "railSectionFib" | "railSectionGann" | "railSectionCycles" | "railSectionPatterns" | "railSectionWaves" | "railSectionRanges" | "railSectionPositions" | "railSectionProjections" | "railSectionVolume" | "favoriteAdd" | "favoriteRemove" | "favoritesLabel" | "favoritesMove" | "favoritesVertical" | "favoritesHorizontal" | "bottomBarLabel" | "rangeLabel" | "rangeText" | "range1D" | "range1DTitle" | "range5D" | "range5DTitle" | "range1M" | "range1MTitle" | "range3M" | "range3MTitle" | "range6M" | "range6MTitle" | "rangeYtd" | "rangeYtdTitle" | "range1Y" | "range1YTitle" | "range5Y" | "range5YTitle" | "rangeAll" | "rangeAllTitle" | "timezoneLabel" | "timezoneChange" | "timezoneClock" | "sessionLabel" | "sessionsList" | "sessionsNone" | "sessionsEmpty" | "sessionLaneOpen" | "sessionLaneClosed" | "sessionClosed" | "sessionClosesIn" | "sessionOpensIn" | "ladderTitle" | "ladderSize" | "gridLabel" | "gridCellOf" | "gridResizeColumns" | "gridResizeRows" | "scaleLinear" | "scaleLinearTitle" | "scalePercent" | "scalePercentTitle" | "scaleLog" | "scaleLogTitle" | "scaleAuto" | "scaleAutoTitle" | "goToDate" | "goToText" | "goToDateField" | "goToTimeField" | "goToSubmit" | "templatesMenu" | "templatesSave" | "templatesOpen" | "templatesSearch" | "templatesMine" | "templatesBuiltin" | "templatesEmpty" | "templatesAdd" | "templatesRename" | "templatesName" | "templatesNameTaken" | "templatesSaveButton" | "templatesCancel" | "templatesNothing" | "templatesSaved" | "templatesDeleted" | "templatesDeleteTitle" | "templatesDeleteMessage" | "templatesKept" | "templatesFailed" | "templatesApplied" | "templatesSkipped" | "templatesInvalid" | "templatesMissing" | "templatesScope" | "templatesSkipUnknown" | "templatesSkipInvalid" | "templatesSkipBlocked" | "templatesSkipLimit" | "templatesSkipExists" | "templatesTrend" | "templatesMomentum" | "templatesVolatility" | "templatesVolume" | "dialogOk" | "dialogCancel" | "dialogReset" | "dialogResetDefaults" | "dialogDone" | "dialogSearch" | "dialogSearchField" | "dialogNoMatches" | "dialogSections" | "dialogSection" | "dialogCategory" | "dialogCategories" | "dialogStyle" | "formNumber" | "formWholeNumber" | "formMin" | "formMax" | "formText" | "formRequired" | "formMaxLength" | "formInvalid" | "formChoose" | "formChooseSome" | "formColor" | "formTwoNumbers" | "formRangeOrder" | "colorSwatches" | "colorCustom" | "colorCustomShort" | "colorOpacity" | "pickerLoading" | "pickerLoadFailed" | "pickerMoreFailed" | "pickerFailed" | "pickerNoMatch" | "pickerEmpty" | "indicatorsSearch" | "indicatorsSearchPlaceholder" | "indicatorsOnChart" | "indicatorsResults" | "indicatorsFavorites" | "indicatorsRecent" | "indicatorsAll" | "indicatorsCount" | "indicatorsCountOf" | "indicatorsOnChartLower" | "indicatorsFavoriteAdd" | "indicatorsFavoriteRemove" | "indicatorsFavoriteAdded" | "indicatorsFavoriteRemoved" | "favoritesFull" | "indicatorsAdd" | "indicatorsAddName" | "indicatorsAdded" | "indicatorsAddedTimes" | "indicatorsAddedName" | "indicatorsAddedCount" | "indicatorsAddFailed" | "indicatorsLimit" | "indicatorsBlocked" | "indicatorsSettingsOf" | "indicatorsRemove" | "indicatorsRemoved" | "indicatorsOnPricePane" | "indicatorsInNewPane" | "indicatorsPlacement" | "indicatorsWillAdd" | "indicatorsPane" | "indicatorsPending" | "indicatorsHidden" | "indicatorsNoneOnChart" | "indicatorsNoneOnChartMatch" | "indicatorsNoneRegistered" | "indicatorsNoneInCategory" | "indicatorsNoMatch" | "indicatorsSearchAll" | "indicatorsSource" | "indicatorsBuiltIn" | "indicatorsCustom" | "indicatorInputs" | "indicatorColors" | "indicatorDisplay" | "appearanceResetAll" | "appearanceResetSection" | "appearancePresets" | "appearanceDefault" | "appearanceMode" | "appearanceLight" | "appearanceDark" | "appearanceShow" | "appearanceStyle" | "appearanceColor" | "drawingFallback" | "drawingMoreStyle" | "drawingText" | "drawingOptions" | "drawingTextColor" | "drawingProfitColor" | "drawingLossColor" | "drawingFontSize" | "drawingLevels" | "drawingLevelValue" | "drawingLevelShow" | "drawingLevelColor" | "drawingBold" | "drawingItalic" | "drawingShowLabel" | "drawingLabelSide" | "drawingLabelContent" | "drawingLabelLevel" | "drawingLabelBoth" | "drawingLabelPercent" | "drawingShowStats" | "drawingShowFill" | "drawingExtendLeft" | "drawingExtendRight" | "drawingMiddleLine" | "chartSettingsTitle" | "shortcutsTitle" | "shortcutsOpen" | "shortcutsGroupNavigation" | "shortcutsGroupEdit" | "shortcutsGroupDrawing" | "shortcutsGroupGeneral" | "shortcutsNone" | "shortcutsAdd" | "shortcutsChange" | "shortcutsRemove" | "shortcutsReset" | "shortcutsResetAll" | "shortcutsRecording" | "shortcutsRecordHint" | "shortcutsRecorded" | "shortcutsRemoved" | "shortcutsCancelled" | "shortcutsReserved" | "shortcutsInUseTitle" | "shortcutsInUse" | "shortcutsReassign" | "toastDismiss" | "navigatorLabel" | "clusterOrders" | "clusterCancel" | "draftQuantityTitle" | "draftQuantity" | "draftQuantityPreset" | "draftSet" | "draftType" | "draftLimit" | "draftStop" | "draftMarket" | "draftMax" | "clusterBuy" | "clusterSell" | "clusterLong" | "clusterShort" | "pickerSelected" | string & object

Defined in: ui/src/toolbar.ts:52

Message key for label (see the localization option): the toolbar shows the key's text in the chart's language, and label when the language has none. The presets set one from defaultShellMessages. A built-in key only replaces its own English default, so a label you change stays as it is.

labelParams? ​

optional labelParams?: Readonly<Record<string, string | number>>

Defined in: ui/src/toolbar.ts:54

Values for the {name} placeholders of labelKey's text, e.g. { name: 'Volume' }.