TrendWorX64 Viewer Chart Advanced Tab
These are the options available on the TrendWorX64 Viewer's chart's advanced tab.
Appearance
-
Background -Background brush for the entire ChartView.
-
ChartBackground -Background color of entire chart area.
-
ChartInnerAlternateBackground -Alternate background color of plot area for even major X grid lines.
-
ChartInnerBackground -Background color of plot area.
-
ChartInnerBorder -Border color of plot area.
-
EnableSampleMouseOver -Enable mouse over style of pie and bar samples.
-
Height -Height of the chart.
-
Layout Mode -Specifies how charts in the view will be positioned.
-
PlotAreaFrozenBackground -Background color of plot area of chart in freeze mode. If not defined, plot area background is used.
-
SampleMouseOverFill -Mouse over fill of pie and bar samples.
-
SampleMouseOverStroke -Mouse over stroke of pie and bar samples.
-
Show Thumb -Show thumb for resizing the chart.
-
ShowChartContextMenu -Show context menu for chart area.
-
SplitterColor -Color of chart splitters.
-
StartFrozen -Freeze the chart immediately after entering the Runtime mode.
-
Title -Custom title for the group of charts displayed in this ChartView.
-
Use High Performance Mode -Specifies if high performance mode is enabled for the chart component. When this property is set to true then rendering and other performance optimizations would be applied to the content of the chart(s).
Axis
-
Allow Pen Range Selection -Specifies whether the main range axis displayed in the chart will be the one of the pen selected in the legend.
-
AxisSorting -Shift - sorts axes from last pen to first pen and shifts the list so that the axis of selected pen is next to chart area. Stack - moves axis of selected pen next to chart area and shifts all others to left.
-
DefaultPenAxis -Default configuration of pen axis for pens added in runtime.
-
DefaultPenAxisEnabled -Enable to apply default pen axis configuration for pens added in runtime.
-
RangeAxis -The axis displaying a global value range for all the pens contained in each chart.
-
RangeAxisAreaSize -Requested size of value range area. When set to zero or empty, the area has automatic size. Enter number of pixels (50) or percents (10%).
-
ShowAxes -Show or hide all the Ais areas in the chart(s).
-
ShowTrendPeriodArea -Shows trend period axis area. TwxChartCOmponent.ShowAxes property takes precedence over this one.
-
ShowValueRangeArea -Show or hide the value range Axis areas in the chart(s).
-
SwapAxes -Speifies if the X and Y axes in the charts will be reverted to provide vertical plotting of all the plots that support it.
-
TrendPeriodAxis -Configuration of trend period axis.
Common
-
Name - Unique string identifier for this object.
Cursor
-
ContinuousWriteCursorPosition -When enabled, cursor position is continuously stored when dragging the cursors.
-
CursorDataSource -Data source of first cursor position. It must be a string data type.
-
CursorJumpToClick -Enable to allow moving cursors by mouse click or tap.
-
CursorMoveWithMouse -Enable to allow moving chart cursors with mouse cursor. Not available when second cursor is visible. Disables zoom by mouse.
-
CursorSampleMode -Specifies the criteria when highlighting samples.
-
CursorStroke -First cursor color.
-
CursorTooltipsVisibilityDataSource -Data source of cursor tooltip visibility. It must be an integer data type.
-
CursorWidth -Width of cursor bars.
-
EnableCursorUserInput -When enabled, user can change cursor positions using keyboard or pointing devices.
-
ReadCursorPosition -When enabled, cursor positions are obtained from cursor data sources.
-
ReadCursorTooltipsVisibility -When enabled, cursor tooltips visibility is obtained from CursorTooltipsVisibilityDataSource.
-
SecondCursorDataSource -Data source of second cursor position. It must be a string data type.
-
SecondCursorStroke -Second cursor color.
-
ShowCursorInFreezeMode -Gets or sets whether chart cursors are visible in freeze mode.
-
ShowCursorOnRealtime -Gets or sets whether chart cursors are visible in realtime mode.
-
ShowCursorTooltips -Gets or sets whether tooltips will be displayed when dragging a cursor.
-
ShowSecondCursor -Gets or sets whether the second chart cursor is visible.
-
WriteCursorPosition -When enabled, cursor positions are stored in cursor data sources.
-
WriteCursorTooltipsVisibility -When enabled, cursor tooltips visibility is stored in CursorTooltipsVisibilityDataSource.
Data
-
DataSamplingMethod -Data sampling method used to generate samples in this chart.
-
Historical Update Sync -Defines whether the Display Refresh (shifting the time axis) will be triggered after receiving new historical data.
-
HistoryRefreshRate -Desired historical data request interval. If OptimizeHistoryRefreshRate is enabled, HistoryRefreshRate defines minimum allowed value.
-
HistoryRefreshRateAlignment -Historical data request interval time alignment. If set to TimeAlignment Custom, HistoryRefreshRate specifies custom interval. Otherwise HistoryRefreshRateValue defines number of selected time intervals.
-
HistoryRefreshRateValue -Number of intervals specified by HistoryRefreshRateAlignment. Not used in case HistoryRefreshRateAlignment equals TimeAlignmentCustom.
-
IsSessionBufferSizeAutomatic -Whether the SessionBufferSize will be automatically adjusted as needed while in runtime mode.
-
MaxAutomaticSessionBufferSize -The maximum amount of samples each pen in a chart can buffer. It protects against excessive system resources usage in runtime mode. Replaces obsolete buffer limit for raw historical data.
-
OptimizeHistoryRefreshRate -Automatically adjust frequency of reading historical data to improve performance.
-
RefreshRate -Animation speed for trends in real-time mode.
-
RefreshRateAlignment -Animation rate period alignment of the chart in real-time mode. If set to TimeAlignment Custom, RefreshRate specifies custom period. Otherwise, RefreshRateValue defines number of selected time intervals.
-
RefreshRateValue -Number of intervals specified by RefreshRateAlignment. Not used in case RefreshRateAlignment equals TimeAlignment Custom.
-
SamplingInterval - Sampling interval for calculated historical data or collection rate for real-time data. It has no effect on raw historical data.
-
SamplingInternalAlignment -Sampling interval time alignment. If set to TimeAlignment Custom, SamplingInterval specifies custom interval. Otherwise, SamplingInternalValue defines number of selected time intervals.
-
SamplingInternalValue -Number of intervals specified by SamplingIntervalAlignment. Not used in case SamplingIntervalAlignment equals TimeAlignment Custom.
-
SamplingMultiplier -Sample count per major tick mark.
-
SamplingTotalCount -Desired count of samples for each pen in this chart.
-
SessionBufferSize -Maximum limit of data samples each pen can visualize in runtime mode. Applies to historical client-side aggregates. Does not apply to historical raw data, server-side aggregates or real-time data.
-
UseParentDataManager -Gets or sets whether to use parent container data manager, if available. Enable if you need to share local variables.
Grid
-
GridXMajorLineStyle -Line style of major X axis grid lines.
-
GridXMinorLineStyle -Line style of minor X axis grid lines.
-
GridXStroke -Color of X axis grid lines.
-
GridXStrokeThickness -Stroke thickness of X axis grid lines.
-
GridYMajorLineStyle -Line style of major Y axis grid lines.
-
GridYMinorLineStyle -Line style of minor Y axis grid lines.
-
GridYStroke -Color of Y axis grid lines.
-
GridYStrokeThickness -Stroke thickness of Y axis grid lines.
-
ShowGrid -Show of hide grid lines in the chart.
-
TrendPeriodGridVisibility -Select X axis grid lines visibility.
-
ValueRangeGridVisibility -Select Y axis grid lines visibility.
Legend
-
GridLinesVisibility -Legend grid lines visibility.
-
HorizontalGridLines -Horizontal legend grid lines brush. See GridLinesVisibility property.
-
LegendActiveSelectionBackground -Specifies background color of selected legend row.
-
LegendActiveSelectionForeground -Specifies foreground color of selected legend row.
-
LegendBackground -Specifies the legend background brush.
-
LegendBorderBrush -Specifies the legend border brush.
-
LegendBorderThickness -Specifies the legend border thickness.
-
LegendDock -Specifies the position of the legend in the chart component.
-
LegendFontFamily -Specifies font family of legend header and row text.
-
LegendFontSize -Specifies font size of legend header and row text.
-
LegendHeaderBackground -Specifies background color of legend header.
-
LegendHeaderBorder -Specifies color of legend header border lines.
-
LegendHeaderForeground -Specifies foreground of legend header.
-
LegendInactiveSelectionBackground -Specifies background color of inactive selected legend row.
-
LegendInactiveSelectionForeground -Specifies foreground color of inactive selected legend row.
-
LegendRowBackground -Specifies background color of legend row.
-
LegendRowForeground -Specifies foreground color of legend row.
-
LegendScrollbarBackground -Specifies background color of legend scrollbars.
-
LegendScrollbarForeground -Specifies foreground color of legend scrollbars.
-
LegendScrollbarHoverColor -Specifies hover color of legend scrollbars.
-
Show Colored Details -Specifies whether text elements and other details in the legend use the color of the associated pens.
-
Show Header -Gets or sets whether the legend header is displayed.
-
Show Legend -Show or hide the legend.
-
Show Totalizer Engineering Units -Specifies whether totalizer engineering units are displayed together with pen's totalizer values.
-
ShowLegendContextMenu -Show context menu to legend area.
-
VerticalGridLines - Vertical legend grid lines brush. See GridLinesVisibility property.
Misc
-
EnableControlEvents -True to enable configuring actions and commands for control events.
-
Series -Clicking the ellipsis button [...] will open the TwxSeries Collection Editor. In the Members section, you can Add or Remove Plots. Select a Plot in the Members section and you can then edit its Plot properties [Appearance: Name and Title] and Pen [Pens - Clicking the ellipsis button [...] will open the TwxChartPen Collection Editor. In the Members section, you can Add or Remove Pens. Select a Pen in the Members section and you can then edit its Pen Properties [Alarm] [Appearance] [Cursor] [Data] [General] [Range] [Statistics] [Time].
Pens
-
BadQualityPlotMode -Specifies how to plot bad quality data.
-
DefaultConnectionParameters -Default connection parameters for pens added in runtime. Does not apply in case the pen already declares its connection parameters.
-
ShowAnnotation -Specifies whether operator comments will be displayed for the pen if supported by the current pen's data source.
-
ShowDisabledPens -Specifies whether disabled pens are displayed in areas of the control such as the legend.
-
ShowInvalidPens -Show pens with invalid datasources in chart and legend.
-
ShowSampleTooltips -Show tooltips with sample description while hovering one of them.
-
UncertainQualityPlotMode -Specifies how to plot uncertain quality data.
-
UseDefaultConnectionParameters -Enable to fill in default connection parameters for pens added in runtime. Does not apply in case the pen already declares the connection parameters.
Range
-
Auto Scale Margin -Specifies a percentage of extra space added to the range when in auto scale mode.
-
RangeMaximumTag -Tag used to resolve the numeric value to be used as maximum for the global value range axis (when the global option is enabled).
-
RangeMinimumTag -Tag used to resolve the numeric value to be used as minimum for the global value range axis (when the global option is enabled).
-
ShowSignalMarkers -Specifies whether the inner charts will display signal's markers along the value range.
-
VisibleValueRanges -Specifies the count of visible ranges when the value range of this viewer is not global.
The data source for the range has additional
options on the "more" ("...") button. Choosing
"Current Range" will hard-code the current range into
the field. This value becomes the starting range for the viewer.
Choosing "Default" will reset the range to its default
value ("{{localsim::_timerange:String}}").
SummaryChart
-
ShowSummaryChart -Whether to display the summary chart when in freeze mode.
-
ShowSummaryExpandButton -Enable to show summary expand button.
-
ShowSummaryPlot -Enable to show summary chart.
-
ShowSummaryRangeAxis -Show value range axis in summary chart.
-
ShowSummaryScrollbar -Enable to show summary scroll bar below the summary chart.
-
ShowSummaryTrendAxis -Show trend period axis in summary chart.
-
SummaryChartDock -Specifies the position of the summary buffer view in the chart component.
-
SummaryCursorFill -Brush used to fill cursor outer area.
-
SummaryCursorStroke -Brush used for cursor handle.
-
SummarySnapMode -Enable to snap summary cursor and scrollbar to closest tick marks.
-
SummaryTrendAxis -Configuration of summary trend period axis.
-
SummaryTrendPeriod -The trend period which the summary chart will span.
-
SummaryTrendPeriodAlignment -Trend period alignment of summary chart. If set to DateTimeAlignment Custom, SummaryTrendPeriod specifies custom period. Otherwise, SummaryTrendPeriodValue defines number of selected intervals.
-
SummaryTrendPeriodValue -Number of intervals specified by SummaryTrendPeriodAlignment. Not used in case SummaryTrendPeriodAlignment equals DateTimeAlignmentCustom.
-
TimeAlignedSummaryCursors -If time alignment is enabled on X axis, dragging summary cursors results in time aligned period.
-
UseCustomSummaryTrendAxis -Use custom settings for trend period axis in summary chart.
Time
-
CustomGeneralDateFormat -Custom date format in tooltips, legend and reports.
-
CustomGeneralTimeFormat -Custom time format in tooltips, legend and reports.
-
GeneralDateFormat -Date format type in tooltips, legend and reports.
-
GeneralDateTimeMode -Visibility of date and time components in tooltips, legend and reports.
-
GeneralDateTimeSeparator -Date/time separator in tooltips, legend and reports.
-
GeneralTimeFormat -Time format in tooltips, legend and reports.
-
InheritDateTimeFormat -Enable to inherit date and time format settings from time axis.
-
TimeZoneFormat -Format of time zone used in dates and times, in case time zone alignment is enabled.
-
TimeZonesAlignment -Enable to align all pens to local time zone. Samples from different time zones are aligned to current time.
-
UseUtcTime -When enabled, all dates and times in this chart are converted to UTC time.
Trend period
-
AutoTimeAlignment -Let the control automatically set tick marks based on control's size and actual trend period. Time alignment settings for main chart and summary chart is ignored. This option applies to 2D cartesian time-based charts only.
-
ReadTimeRange -When enabled, if this chart is in freeze mode, trend range is obtained from time range data source.
-
ShowTrendPeriodToolBar -Shows trend period toolbar with customizable buttons.
-
TimeRangeDataSource -Data source of global time range.
-
TimeShiftValue -Specifies a time span used as an offset for the current instant displayed in the charts of this view.
-
Trend Period Buttons -Gets the collection of trend period buttons displayed in the control.
-
TrendPeriod -Custom trend period of the chart. Used only if TrendPeriodAlignment is set to DateTimeAlignmentCustom.
-
TrendPeriodAlignment -Trend period alignment of summary chart. If set to DateTimeAlignmentCustom. SummaryTrendPeriod specifies custom period. Otherwise, SummaryTrendPeriodValue defines number of selected intervals.
-
TrendPeriodValue -Number of intervals specified by TrendPeriodAlignment. Not used in case TrendPeriodAlignment equals DateTimeAlignmentCustom.
-
WriteTimeRange -When enabled, actual trend range is stored in time range data source and can be shared with other controls.
Zoom
-
IsZoomModeEnabled -Specifies whether user can zoom chart in or out.
-
Show Range Zoom Ruler -Specifies whether charts in the chart component will display a zoom ruler associated to the main range axis.
-
Simple Wheel Zoom -Chart is zoomed directly by mouse wheel 9without need to hold Ctrl+Shift key).
-
TimeAlignedZoom -If time alignment is enabled on X axis, all zoom operations result in time aligned period.
-
ZoomFill -Fill color of zooming box.