diff options
99 files changed, 62906 insertions, 164 deletions
diff --git a/Software/DB/Tango.mdf b/Software/DB/Tango.mdf Binary files differindex a4fcba41a..1924ce049 100644 --- a/Software/DB/Tango.mdf +++ b/Software/DB/Tango.mdf diff --git a/Software/DB/Tango_log.ldf b/Software/DB/Tango_log.ldf Binary files differindex 935b903b5..5096e2dc6 100644 --- a/Software/DB/Tango_log.ldf +++ b/Software/DB/Tango_log.ldf diff --git a/Software/PMR/Messages/Diagnostics/DiagnosticsMonitors.proto b/Software/PMR/Messages/Diagnostics/DiagnosticsMonitors.proto index 28ebc5bc3..e367a00ce 100644 --- a/Software/PMR/Messages/Diagnostics/DiagnosticsMonitors.proto +++ b/Software/PMR/Messages/Diagnostics/DiagnosticsMonitors.proto @@ -202,7 +202,7 @@ message DiagnosticsMonitors repeated double HeadZone4HeaterCurrent = 61; //Head Zone 5-6 Heater Current (Min = 0, Max = 100, PPF = 1) - repeated double HeadZone5_6HeaterCurrent = 62; + repeated double HeadZone56HeaterCurrent = 62; //Mixer 1 Heater Current (Min = 0, Max = 100, PPF = 1) repeated double Mixer1HeaterCurrent = 63; diff --git a/Software/PMR/Messages/Insights/InsightsMonitors.proto b/Software/PMR/Messages/Insights/InsightsMonitors.proto index 627ad7255..d152e6181 100644 --- a/Software/PMR/Messages/Insights/InsightsMonitors.proto +++ b/Software/PMR/Messages/Insights/InsightsMonitors.proto @@ -200,7 +200,7 @@ message InsightsMonitors double HeadZone4HeaterCurrent = 61; //Head Zone 5-6 Heater Current - double HeadZone5_6HeaterCurrent = 62; + double HeadZone56HeaterCurrent = 62; //Mixer 1 Heater Current double Mixer1HeaterCurrent = 63; diff --git a/Software/PMR/Messages/Integration/ExternalBridgeUdpDiscoveryPacket.proto b/Software/PMR/Messages/Integration/ExternalBridgeUdpDiscoveryPacket.proto index d797e6de3..4a7d5b59b 100644 --- a/Software/PMR/Messages/Integration/ExternalBridgeUdpDiscoveryPacket.proto +++ b/Software/PMR/Messages/Integration/ExternalBridgeUdpDiscoveryPacket.proto @@ -7,4 +7,5 @@ message ExternalBridgeUdpDiscoveryPacket { string Time = 1; string SerialNumber = 2; + bool CompressionEnabled = 3; }
\ No newline at end of file diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Contracts/IInsightsView.cs b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Contracts/IInsightsView.cs new file mode 100644 index 000000000..7ca881f9a --- /dev/null +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Contracts/IInsightsView.cs @@ -0,0 +1,14 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Tango.FSE.Common; + +namespace Tango.FSE.Insights.Contracts +{ + public interface IInsightsView : IFSEView + { + void ZoomExtents(); + } +} diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsChart.cs b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsChart.cs new file mode 100644 index 000000000..c51015e66 --- /dev/null +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsChart.cs @@ -0,0 +1,68 @@ +using SciChart.Charting.Model.ChartSeries; +using SciChart.Charting.Model.DataSeries; +using SciChart.Charting.Visuals.Annotations; +using SciChart.Charting.Visuals.RenderableSeries; +using System; +using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.Linq; +using System.Reflection; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Media; +using Tango.Core; + +namespace Tango.FSE.Insights.SciChart +{ + public class InsightsChart : ExtendedObject + { + public event EventHandler IsVisibleChanged; + + private ObservableCollection<InsightsChart> ChartsCollection { get; set; } + public String Name { get; set; } + public String Description { get; set; } + public PropertyInfo InsightsMonitorsProperty { get; set; } + public IRenderableSeriesViewModel RenderableSeries { get; set; } + public XyDataSeries<DateTime, double> DataSeries { get; set; } + public AnnotationCollection Annotations { get; set; } + + private bool _isVisible; + public bool IsVisible + { + get { return _isVisible; } + set + { + if (_isVisible != value) + { + _isVisible = value; + RaisePropertyChangedAuto(); + IsVisibleChanged?.Invoke(this, new EventArgs()); + } + } + } + + public bool IsLast + { + get + { + return ChartsCollection.Last() == this; + } + } + + public InsightsChart(ObservableCollection<InsightsChart> chartsCollection) + { + ChartsCollection = chartsCollection; + ChartsCollection.CollectionChanged += ChartsCollection_CollectionChanged; + RenderableSeries = new LineRenderableSeriesViewModel() { DrawNaNAs = LineDrawMode.Gaps }; + RenderableSeries.Stroke = Colors.DodgerBlue; + DataSeries = new XyDataSeries<DateTime, double>(); + RenderableSeries.DataSeries = DataSeries; + Annotations = new AnnotationCollection(); + } + + private void ChartsCollection_CollectionChanged(object sender, System.Collections.Specialized.NotifyCollectionChangedEventArgs e) + { + RaisePropertyChanged(nameof(IsLast)); + } + } +} diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsRubberBandXYZoomModifier.cs b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsRubberBandXYZoomModifier.cs new file mode 100644 index 000000000..21f7ecc8f --- /dev/null +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsRubberBandXYZoomModifier.cs @@ -0,0 +1,24 @@ +using SciChart.Charting.ChartModifiers; +using SciChart.Core.Utility.Mouse; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Input; + +namespace Tango.FSE.Insights.SciChart +{ + public class InsightsRubberBandXYZoomModifier : RubberBandXyZoomModifier + { + public override void OnModifierMouseDown(ModifierMouseArgs e) + { + //IsXAxisOnly = !e.IsMaster; + + if (Keyboard.Modifiers == ModifierKeys.Control) + { + base.OnModifierMouseDown(e); + } + } + } +} diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsZoomPanModifier.cs b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsZoomPanModifier.cs new file mode 100644 index 000000000..00bb7beea --- /dev/null +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/SciChart/InsightsZoomPanModifier.cs @@ -0,0 +1,22 @@ +using SciChart.Charting.ChartModifiers; +using SciChart.Core.Utility.Mouse; +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Input; + +namespace Tango.FSE.Insights.SciChart +{ + public class InsightsZoomPanModifier : ZoomPanModifier + { + public override void OnModifierMouseDown(ModifierMouseArgs e) + { + if (!(Keyboard.Modifiers == ModifierKeys.Control)) + { + base.OnModifierMouseDown(e); + } + } + } +} diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Tango.FSE.Insights.csproj b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Tango.FSE.Insights.csproj index 83cb8cdef..623783f98 100644 --- a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Tango.FSE.Insights.csproj +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Tango.FSE.Insights.csproj @@ -58,6 +58,34 @@ <Reference Include="Newtonsoft.Json, Version=9.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL"> <HintPath>..\..\..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath> </Reference> + <Reference Include="SciChart.Charting, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Charting.dll</HintPath> + </Reference> + <Reference Include="SciChart.Charting.DrawingTools, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Charting.DrawingTools.dll</HintPath> + </Reference> + <Reference Include="SciChart.Charting3D, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Charting3D.dll</HintPath> + </Reference> + <Reference Include="SciChart.Core, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Core.dll</HintPath> + </Reference> + <Reference Include="SciChart.Data, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Data.dll</HintPath> + </Reference> + <Reference Include="SciChart.Drawing, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Drawing.dll</HintPath> + </Reference> + <Reference Include="SciChart.Drawing.DirectX, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\..\Referenced Assemblies\SciChart\SciChart.Drawing.DirectX.dll</HintPath> + </Reference> <Reference Include="System" /> <Reference Include="System.ComponentModel.DataAnnotations" /> <Reference Include="System.Data" /> @@ -78,6 +106,10 @@ <Reference Include="PresentationFramework" /> </ItemGroup> <ItemGroup> + <Compile Include="Contracts\IInsightsView.cs" /> + <Compile Include="SciChart\InsightsChart.cs" /> + <Compile Include="SciChart\InsightsRubberBandXYZoomModifier.cs" /> + <Compile Include="SciChart\InsightsZoomPanModifier.cs" /> <Compile Include="ViewModelLocator.cs" /> <Compile Include="InsightsModule.cs" /> <Compile Include="ViewModels\InsightsViewVM.cs" /> @@ -127,6 +159,10 @@ <Project>{a34ee0f0-649d-41c8-8489-b6f1cc6924ee}</Project> <Name>Tango.Core</Name> </ProjectReference> + <ProjectReference Include="..\..\..\Tango.Insights\Tango.Insights.csproj"> + <Project>{4a55c185-3f8d-41b0-8815-c15f6213a14a}</Project> + <Name>Tango.Insights</Name> + </ProjectReference> <ProjectReference Include="..\..\..\Tango.Integration\Tango.Integration.csproj"> <Project>{4206ac58-3b57-4699-8835-90bf6db01a61}</Project> <Name>Tango.Integration</Name> @@ -165,6 +201,10 @@ <Generator>MSBuild:Compile</Generator> <SubType>Designer</SubType> </Page> + <Page Include="Themes\Generic.xaml"> + <Generator>MSBuild:Compile</Generator> + <SubType>Designer</SubType> + </Page> <Page Include="Views\InsightsView.xaml"> <SubType>Designer</SubType> <Generator>MSBuild:Compile</Generator> diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Themes/Generic.xaml b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Themes/Generic.xaml new file mode 100644 index 000000000..4c8731fa1 --- /dev/null +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Themes/Generic.xaml @@ -0,0 +1,60 @@ +<ResourceDictionary xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation" + xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" + xmlns:commonControls="clr-namespace:Tango.FSE.Common.Controls;assembly=Tango.FSE.Common" + xmlns:entities="clr-namespace:Tango.BL.Entities;assembly=Tango.BL" + xmlns:material="http://materialdesigninxaml.net/winfx/xaml/themes" + xmlns:local="clr-namespace:Tango.FSE.Diagnostics.Themes"> + + + <DataTemplate x:Key="InsightEventTemplate" DataType="{x:Type entities:EventType}"> + <Border Padding="10 5" Cursor="Hand" IsHitTestVisible="True" BorderThickness="1" CornerRadius="3" BorderBrush="{StaticResource FSE_PrimaryBackgroundLightBrush}"> + <Border.ToolTip> + <StackPanel> + <TextBlock TextWrapping="Wrap"> + <Run>#</Run><Run Text="{Binding Code}"></Run> + <LineBreak/> + <Run Text="{Binding TechnicalDescription}"></Run> + </TextBlock> + </StackPanel> + </Border.ToolTip> + <Border.Style> + <Style TargetType="Border"> + <Setter Property="Background" Value="{StaticResource FSE_PrimaryBackgroundDarkBrush}"></Setter> + <Style.Triggers> + <Trigger Property="IsMouseOver" Value="True"> + <Setter Property="Background" Value="{StaticResource FSE_PrimaryBackgroundLightBrush}"></Setter> + </Trigger> + </Style.Triggers> + </Style> + </Border.Style> + <DockPanel> + <material:PackIcon Height="16" Width="16" VerticalAlignment="Center"> + <material:PackIcon.Style> + <Style TargetType="material:PackIcon"> + <Setter Property="Kind" Value="InfoCircleOutline"></Setter> + <Style.Triggers> + <DataTrigger Binding="{Binding Category}" Value="Info"> + <Setter Property="Kind" Value="InfoCircleOutline"></Setter> + <Setter Property="Foreground" Value="{StaticResource FSE_PrimaryForegroundBrush}"></Setter> + </DataTrigger> + <DataTrigger Binding="{Binding Category}" Value="Warning"> + <Setter Property="Kind" Value="Alert"></Setter> + <Setter Property="Foreground" Value="{StaticResource FSE_WarningBrush}"></Setter> + </DataTrigger> + <DataTrigger Binding="{Binding Category}" Value="Error"> + <Setter Property="Kind" Value="Alert"></Setter> + <Setter Property="Foreground" Value="{StaticResource FSE_ErrorBrush}"></Setter> + </DataTrigger> + <DataTrigger Binding="{Binding Category}" Value="Critical"> + <Setter Property="Kind" Value="BellAlert"></Setter> + <Setter Property="Foreground" Value="{StaticResource FSE_ErrorBrush}"></Setter> + </DataTrigger> + </Style.Triggers> + </Style> + </material:PackIcon.Style> + </material:PackIcon> + <TextBlock VerticalAlignment="Center" Margin="5 0 0 0" Text="{Binding Name}" Foreground="{StaticResource FSE_PrimaryForegroundBrush}"></TextBlock> + </DockPanel> + </Border> + </DataTemplate> +</ResourceDictionary>
\ No newline at end of file diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/ViewModels/InsightsViewVM.cs b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/ViewModels/InsightsViewVM.cs index 40b29c643..e5d09c282 100644 --- a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/ViewModels/InsightsViewVM.cs +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/ViewModels/InsightsViewVM.cs @@ -1,13 +1,479 @@ -using System; +using SciChart.Charting.Model.ChartSeries; +using SciChart.Charting.Visuals.Annotations; +using SciChart.Charting.Visuals.RenderableSeries; +using SciChart.Data.Model; +using System; using System.Collections.Generic; +using System.Collections.ObjectModel; +using System.ComponentModel; using System.Linq; +using System.Reflection; using System.Text; +using System.Threading; using System.Threading.Tasks; +using System.Windows; +using System.Windows.Controls; +using System.Windows.Data; +using System.Windows.Media; +using Tango.BL.Entities; +using Tango.BL.Enumerations; +using Tango.Core.Commands; using Tango.FSE.Common; +using Tango.FSE.Common.Insights; +using Tango.FSE.Insights.Contracts; +using Tango.FSE.Insights.SciChart; +using Tango.Logging; +using Tango.PMR.Insights; namespace Tango.FSE.Insights.ViewModels { - public class InsightsViewVM : FSEViewModel + public class InsightsViewVM : FSEViewModel<IInsightsView> { + private bool _chartsLoaded; + private ICollectionView _monitorsView; + + public RelayCommand GetInsightsCommand { get; set; } + + public ObservableCollection<InsightsChart> Charts { get; set; } + + public ObservableCollection<InsightsChart> VisibleCharts { get; set; } + + private DateTime _minDate; + public DateTime MinDate + { + get { return _minDate; } + set { _minDate = value; RaisePropertyChangedAuto(); } + } + + private DateTime _maxDate; + public DateTime MaxDate + { + get { return _maxDate; } + set { _maxDate = value; RaisePropertyChangedAuto(); } + } + + private DateTime? _startDate; + public DateTime? StartDate + { + get { return _startDate; } + set { _startDate = value; RaisePropertyChangedAuto(); } + } + + private DateTime? _startTime; + public DateTime? StartTime + { + get { return _startTime; } + set { _startTime = value; RaisePropertyChangedAuto(); } + } + + private DateTime? _endDate; + public DateTime? EndDate + { + get { return _endDate; } + set { _endDate = value; RaisePropertyChangedAuto(); } + } + + private DateTime? _endTime; + public DateTime? EndTime + { + get { return _endTime; } + set { _endTime = value; RaisePropertyChangedAuto(); } + } + + private InsightsHandler _handler; + public InsightsHandler Handler + { + get { return _handler; } + set { _handler = value; RaisePropertyChangedAuto(); } + } + + private IRange _visibleChartsRange; + public IRange VisibleChartsRange + { + get { return _visibleChartsRange; } + set { _visibleChartsRange = value; RaisePropertyChangedAuto(); } + } + + private String _monitorsFilter; + public String MonitorsFilter + { + get { return _monitorsFilter; } + set { _monitorsFilter = value; RaisePropertyChangedAuto(); OnMonitorsFilterChanged(); } + } + + private InsightsPackage _insightsPackage; + public InsightsPackage InsightsPackage + { + get { return _insightsPackage; } + set { _insightsPackage = value; RaisePropertyChangedAuto(); RaisePropertyChanged(nameof(InsightsPackageAvailable)); } + } + + public bool InsightsPackageAvailable + { + get { return InsightsPackage != null; } + } + + private bool _displayAnnotations; + public bool DisplayAnnotations + { + get { return _displayAnnotations; } + set { _displayAnnotations = value; RaisePropertyChangedAuto(); } + } + + private bool _isSearchBarOpened; + public bool IsSearchBarOpened + { + get { return _isSearchBarOpened; } + set { _isSearchBarOpened = value; RaisePropertyChangedAuto(); } + } + + public AnnotationCollection Annotations { get; set; } + + public InsightsViewVM() + { + IsSearchBarOpened = true; + Charts = new ObservableCollection<InsightsChart>(); + VisibleCharts = new ObservableCollection<InsightsChart>(); + Annotations = new AnnotationCollection(); + GetInsightsCommand = new RelayCommand(GetInsights, () => IsFree); + } + + public override void OnApplicationStarted() + { + base.OnApplicationStarted(); + StartDate = DateTime.Now.AddDays(-7); + StartTime = new DateTime(1, 1, 1, 0, 0, 0); + EndDate = null; + EndTime = null; + } + + public async override void OnApplicationReady() + { + base.OnApplicationReady(); + + if (!_chartsLoaded) + { + try + { + var monitors = (await Services.TechComponentsService.Monitors.FindAll()).OrderBy(x => x.Description).ToList(); + + foreach (var monitor in monitors.Where(x => !x.MultiChannel).ToList()) + { + InsightsChart chart = new InsightsChart(VisibleCharts); + chart.Name = monitor.Name; + chart.Description = monitor.Description; + chart.InsightsMonitorsProperty = typeof(InsightsMonitors).GetProperty(((TechMonitors)monitor.Code).ToString(), BindingFlags.Public | BindingFlags.Instance | BindingFlags.DeclaredOnly); + chart.IsVisibleChanged += Chart_IsVisibleChanged; + chart.DataSeries.Append(GetDemoDates(), GetDemoValues()); + Charts.Add(chart); + } + + foreach (var chart in Charts.ToList().Where(x => x.InsightsMonitorsProperty == null)) + { + Charts.Remove(chart); + LogManager.Log($"Error loading insights chart '{chart.Name}'. Could not find property on InsightsMonitors.", LogCategory.Error); + } + + _monitorsView = CollectionViewSource.GetDefaultView(Charts); + _monitorsView.Filter = (x) => + { + if (!MonitorsFilter.IsNotNullOrEmpty()) return true; + + InsightsChart chart = x as InsightsChart; + if (chart != null) + { + return chart.Description.ToLower().Contains(MonitorsFilter.ToLower()); + } + + return false; + }; + + _chartsLoaded = true; + } + catch (Exception ex) + { + //TODO: Report Insights module error with BugReporting Snackbar... + } + } + } + + public override void OnNavigatedTo() + { + base.OnNavigatedTo(); + MinDate = DateTime.Now.AddDays(-30); + MaxDate = DateTime.Now; + } + + private async void GetInsights() + { + if (StartDate == null) + { + await NotificationProvider.ShowError("Please specify start date before trying to get insights."); + return; + } + + DateTime? start = null; + + if (StartTime != null) + { + start = + new DateTime( + StartDate.Value.Year, + StartDate.Value.Month, + StartDate.Value.Day, + StartTime.Value.Hour, + StartTime.Value.Minute, + StartTime.Value.Second); + } + else + { + start = StartDate.Value.Date; + } + + DateTime? end = null; + + if (EndDate != null) + { + if (EndTime != null) + { + end = + new DateTime( + EndDate.Value.Year, + EndDate.Value.Month, + EndDate.Value.Day, + EndTime.Value.Hour, + EndTime.Value.Minute, + EndTime.Value.Second); + } + else + { + end = EndDate.Value.Date.AddDays(1); + } + } + else + { + end = DateTime.Now.AddDays(1); + } + + LogManager.Log($"Getting insights from '{start.Value}' to '{end.Value}'"); + + try + { + IsSearchBarOpened = false; + + using (var task = NotificationProvider.PushTaskItem("Getting insights from the remote machine...", false, () => + { + try + { + Handler?.Abort(); + } + catch (Exception ex) + { + throw; + } + })) + { + IsFree = false; + Handler = await InsightsProvider.GetInsights(start.Value.ToUniversalTime(), end.Value.ToUniversalTime()); + Handler.ProgressChanged += (x, e) => + { + task.UpdateProgress(e.Progress.Message, e.Progress.Value, e.Progress.Maximum, e.Progress.IsIndeterminate); + }; + + task.CanCancel = true; + + var package = await Handler.WaitForCompletion(); + + task.CanCancel = false; + + await LoadInsightsPackage(package); + } + } + catch (ThreadAbortException) + { + IsSearchBarOpened = true; + //Operation canceled by cancel button.. + } + catch (OperationCanceledException) + { + IsSearchBarOpened = true; + //Aborted by user... + } + catch (Exception ex) + { + IsSearchBarOpened = true; + LogManager.Log(ex, "Error getting insights."); + await NotificationProvider.ShowError($"Error occurred while trying to get insights.\n{ex.FlattenMessage()}"); + } + finally + { + IsFree = true; + } + } + + private async Task LoadInsightsPackage(InsightsPackage package) + { + LogManager.Log($"Insights received with {package.Frames.Count} frames."); + + await Task.Factory.StartNew(() => + { + foreach (var chart in Charts) + { + chart.DataSeries.Clear(); + + List<DateTime> dates = new List<DateTime>(); + List<double> values = new List<double>(); + + foreach (var frame in package.Frames) + { + var value = chart.InsightsMonitorsProperty.GetValue(frame.Monitors); + + dates.Add(frame.Frame.Time.ToLocalTime()); + + if (value != null) + { + values.Add((double)value); + } + else + { + values.Add(double.NaN); + } + } + + chart.DataSeries.Append(dates, values); + } + + + InvokeUI(() => + { + Annotations.Clear(); + + //Load annotations + bool disconnected = false; + int positiveFrameCounter = 0; + + foreach (var frame in package.Frames) + { + if (frame.Frame.IsEmpty) + { + if (!disconnected && positiveFrameCounter > 1) + { + disconnected = true; + AddMachineConnectedDisconnectedAnnotation(frame.Frame.Time.ToLocalTime(), false); + } + + positiveFrameCounter = 0; + } + else + { + positiveFrameCounter++; + + if (disconnected) + { + disconnected = false; + AddMachineConnectedDisconnectedAnnotation(frame.Frame.Time.ToLocalTime(), true); + } + } + } + + PlotInsightsEvents(package); + InsightsPackage = package; + View.ZoomExtents(); + }); + }); + } + + public void AddMachineConnectedDisconnectedAnnotation(DateTime date, bool connected) + { + VerticalLineAnnotation line = new VerticalLineAnnotation(); + line.StrokeThickness = 2; + line.Stroke = connected ? Brushes.Green : Brushes.Red; + line.X1 = date; + line.X2 = date; + line.ShowLabel = false; + line.AnnotationLabels.Add(new AnnotationLabel() + { + LabelPlacement = LabelPlacement.TopRight, + Text = connected ? "machine connected" : "machine disconnected" + }); + Annotations.Add(line); + } + + private void PlotInsightsEvents(InsightsPackage package) + { + double y = 0.05; + + foreach (var ev in package.Events) + { + CustomAnnotation eventBox = new CustomAnnotation(); + eventBox.X1 = ev.Time.ToLocalTime(); + eventBox.Y1 = y; + eventBox.CoordinateMode = AnnotationCoordinateMode.RelativeY; + eventBox.Content = ev.EventType; + eventBox.ContentTemplate = Application.Current.Resources["InsightEventTemplate"] as DataTemplate; + Annotations.Add(eventBox); + + y += 0.05; + + if (y > 0.95) + { + y = 0.05; + } + } + } + + private void Chart_IsVisibleChanged(object sender, EventArgs e) + { + InsightsChart chart = sender as InsightsChart; + + if (chart.IsVisible) + { + VisibleCharts.Add(chart); + } + else + { + VisibleCharts.Remove(chart); + } + } + + private void OnMonitorsFilterChanged() + { + _monitorsView?.Refresh(); + } + + private List<DateTime> GetDemoDates() + { + List<DateTime> dates = new List<DateTime>(); + + for (int i = 0; i < 30; i++) + { + dates.Add(DateTime.Now.AddDays(-30).AddDays(i)); + } + + return dates; + } + + private List<double> GetDemoValues() + { + List<double> values = new List<double>(); + + int counter2 = 0; + + for (int i = 0; i < 30; i++) + { + if (counter2 == 2) + { + values.Add(double.NaN); + counter2 = 0; + } + else + { + values.Add(i); + counter2++; + } + } + + return values; + } } } diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml index be3211e78..c70656c00 100644 --- a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml @@ -7,55 +7,234 @@ xmlns:vm="clr-namespace:Tango.FSE.Insights.ViewModels" xmlns:local="clr-namespace:Tango.FSE.Insights.Views" xmlns:material="http://materialdesigninxaml.net/winfx/xaml/themes" + xmlns:insights="clr-namespace:Tango.FSE.Insights.SciChart" + xmlns:s="http://schemas.abtsoftware.co.uk/scichart" + xmlns:controls="clr-namespace:Tango.FSE.Common.Controls;assembly=Tango.FSE.Common" mc:Ignorable="d" d:DesignHeight="1080" d:DesignWidth="1920" d:DataContext="{d:DesignInstance Type=vm:InsightsViewVM, IsDesignTimeCreatable=False}" DataContext="{x:Static global:ViewModelLocator.InsightsViewVM}"> + + <Grid IsEnabled="{Binding IsFree}"> - <Grid Margin="0 0 0 20"> - <Ellipse Fill="{StaticResource FSE_PrimaryBackgroundMidBrush}" Width="1500" Height="600" VerticalAlignment="Top" HorizontalAlignment="Center" Margin="0 -380 0 0" Opacity="0.5" StrokeThickness="1" Stroke="{StaticResource FSE_GrayBrush}" /> - <DockPanel Margin="20 40 20 0"> - <Grid DockPanel.Dock="Top"> - <DockPanel HorizontalAlignment="Center" VerticalAlignment="Top"> - <StackPanel Orientation="Horizontal" DockPanel.Dock="Left" VerticalAlignment="Bottom" Margin="0 0 0 -20"> - <Grid VerticalAlignment="Bottom" Margin="0 0 20 14"> - <StackPanel> - <Grid Margin="-300 -70 0 0" Width="200"> - <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="40" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> - <material:TimePicker Is24Hours="True" VerticalAlignment="Center" Width="150" /> - </Grid> - <Grid Width="250"> - <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="50" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> - <DatePicker VerticalAlignment="Center" Width="200" /> - </Grid> - </StackPanel> - </Grid> - <Image RenderOptions.BitmapScalingMode="Fant" RenderTransformOrigin="0.5,0.5" Source="../Images/arrow_right.png" DockPanel.Dock="Left" Stretch="Fill" Height="80" Width="100" VerticalAlignment="Bottom"> - <Image.RenderTransform> - <RotateTransform Angle="180"/> - </Image.RenderTransform> - </Image> - </StackPanel> - <StackPanel DockPanel.Dock="Right" VerticalAlignment="Bottom" Orientation="Horizontal" Margin="0 0 0 -20"> - <Image RenderOptions.BitmapScalingMode="Fant" Source="../Images/arrow_right.png" DockPanel.Dock="Right" Stretch="Fill" Height="80" Width="100" VerticalAlignment="Bottom" /> - <Grid VerticalAlignment="Bottom" Margin="20 0 0 14"> - <StackPanel> - <Grid Margin="0 -70 -300 0" Width="200"> - <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="40" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> - <material:TimePicker Is24Hours="True" VerticalAlignment="Center" Width="150" /> - </Grid> - <Grid Width="250"> - <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="50" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> - <DatePicker VerticalAlignment="Center" Width="200" /> + <Grid> + <Grid> + <Grid Margin="5 15 5 0"> + <Grid> + <Grid.ColumnDefinitions> + <ColumnDefinition Width="Auto" MinWidth="200" /> + <ColumnDefinition Width="*" /> + </Grid.ColumnDefinitions> + <Border Margin="5 5 0 5"> + <DockPanel> + <Menu DockPanel.Dock="Top" Margin="0 -10 0 0"> + <MenuItem Header="_File"></MenuItem> + <MenuItem Header="_View"> + <MenuItem Header="Display Annotations" IsCheckable="True" IsChecked="{Binding DisplayAnnotations}" /> + </MenuItem> + </Menu> + <Grid DockPanel.Dock="Top" Width="330" Margin="0 10 0 0" HorizontalAlignment="Center"> + <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="50" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> + <TextBox VerticalAlignment="Center" Margin="30 0" material:HintAssist.Hint="Find Monitor" Text="{Binding MonitorsFilter,UpdateSourceTrigger=PropertyChanged,Delay=200}"></TextBox> + </Grid> + <ScrollViewer Margin="0 20 0 0" HorizontalScrollBarVisibility="Disabled" VerticalScrollBarVisibility="Auto"> + <ItemsControl ItemsSource="{Binding Charts}"> + <ItemsControl.ItemTemplate> + <DataTemplate> + <ToggleButton Margin="5" IsChecked="{Binding IsVisible}"> + <ToggleButton.Template> + <ControlTemplate TargetType="ToggleButton"> + <Grid> + <Polygon x:Name="poly" Fill="{StaticResource FSE_PrimaryBackgroundDarkBrush}" StrokeThickness="1" Stroke="{StaticResource FSE_PrimaryBackgroundLightBrush}" Stretch="Fill" Height="40" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> + <TextBlock Text="{Binding Description}" HorizontalAlignment="Center" VerticalAlignment="Center" FontSize="{StaticResource FSE_SmallFontSize}"></TextBlock> + </Grid> + <ControlTemplate.Triggers> + <Trigger Property="IsChecked" Value="True"> + <Setter TargetName="poly" Property="Fill" Value="{StaticResource FSE_PrimaryAccentBrush}"></Setter> + </Trigger> + <Trigger Property="IsMouseOver" Value="True"> + <Setter TargetName="poly" Property="Stroke" Value="{StaticResource FSE_PrimaryAccentBrush}"></Setter> + </Trigger> + </ControlTemplate.Triggers> + </ControlTemplate> + </ToggleButton.Template> + </ToggleButton> + </DataTemplate> + </ItemsControl.ItemTemplate> + </ItemsControl> + </ScrollViewer> + </DockPanel> + </Border> + <ItemsControl x:Name="chartsItemsControl" Margin="10 0 0 0" Grid.Column="1" ItemsSource="{Binding VisibleCharts}"> + <ItemsControl.ItemsPanel> + <ItemsPanelTemplate> + <UniformGrid IsItemsHost="True" Columns="1" /> + </ItemsPanelTemplate> + </ItemsControl.ItemsPanel> + <ItemsControl.ItemTemplate> + <DataTemplate> + <Grid Loaded="SciChartSurface_Loaded"> + <Border BorderBrush="{StaticResource FSE_PrimaryBackgroundLightBrush}" BorderThickness="1" Margin="0 5" CornerRadius="5" Padding="1"> + <s:SciChartSurface Annotations="{Binding Annotations}" Background="{StaticResource FSE_PrimaryBackgroundDarkBrush}" Visibility="{Binding IsVisible,Converter={StaticResource BooleanToVisibilityConverter}}" s:SciChartGroup.VerticalChartGroup="SyncedChartsSameAxisSizes" RenderableSeries="{s:SeriesBinding RenderableSeries}"> + <s:SciChartSurface.GridLinesPanelStyle> + <Style TargetType="s:GridLinesPanel"> + <Setter Property="Background" Value="#191919"></Setter> + </Style> + </s:SciChartSurface.GridLinesPanelStyle> + + <!-- Define X and Y Axis. Optional bands give a cool look and feel for minimal performance impact --> + <s:SciChartSurface.YAxis> + <s:NumericAxis GrowBy="0.1,0.1" MinorsPerMajor="2" VisibleRange="0,1"/> + </s:SciChartSurface.YAxis> + <s:SciChartSurface.XAxis> + <s:DateTimeAxis Visibility="{Binding IsLast,Converter={StaticResource BooleanToVisibilityConverter}}" DrawMajorBands="True" VisibleRange="{Binding RelativeSource={RelativeSource AncestorType=UserControl},Path=DataContext.VisibleChartsRange, Mode=TwoWay}"/> + </s:SciChartSurface.XAxis> + <s:SciChartSurface.ChartModifier> + + <!-- Whats going on here? --> + <!-- We share the mouse events by using MouseManager.MouseEventGroup="..." --> + <!-- We ensure modifiers receive events even when another has handled by setting ReceiveHandledEvents=true --> + <!-- We bind both charts XAxis to shared property on the viewmodel to ensure they stay in sync --> + <s:ModifierGroup s:MouseManager.MouseEventGroup="myCustomGroup"> + <insights:InsightsRubberBandXYZoomModifier IsXAxisOnly="True" ReceiveHandledEvents="True" /> + <insights:InsightsZoomPanModifier ReceiveHandledEvents="True" XyDirection="XDirection" /> + <!--<s:MouseWheelZoomModifier/>--> + <!--<s:RolloverModifier ReceiveHandledEvents="True"/>--> + <s:CursorModifier ReceiveHandledEvents="True"/> + <!--<s:YAxisDragModifier Tag="FirstYAxis"/>--> + <!--<s:XAxisDragModifier />--> + <s:ZoomExtentsModifier/> + </s:ModifierGroup> + </s:SciChartSurface.ChartModifier> + </s:SciChartSurface> + </Border> + + <Grid HorizontalAlignment="Left" VerticalAlignment="Top" Width="260" Height="30" Margin="3 8 0 0"> + <Polygon Points="1,0 300,0 240,40 0,40 0,1" Fill="#3800AFFF" Stretch="Fill" Stroke="Black" /> + <TextBlock Margin="30 0 0 0" Text="{Binding Description}" HorizontalAlignment="Left" VerticalAlignment="Center" FontSize="{StaticResource FSE_SmallFontSize}"></TextBlock> + <controls:ToggleIconButton CheckedIcon="Close" IsChecked="{Binding IsVisible}" HorizontalAlignment="Left" VerticalAlignment="Center" Width="16" Height="16" Margin="5 -2 0 0" /> + </Grid> </Grid> - </StackPanel> - </Grid> - </StackPanel> - <Image RenderOptions.BitmapScalingMode="Fant" Margin="40 0" Source="../Images/time.png" Stretch="Uniform" Width="100" /> - </DockPanel> + </DataTemplate> + </ItemsControl.ItemTemplate> + </ItemsControl> + + <Grid x:Name="gridAnnotations" Loaded="SciChartSurface_Loaded" Grid.Column="1" Margin="10 5 0 25" IsHitTestVisible="True"> + <Grid.Style> + <Style TargetType="Grid"> + <Setter Property="Visibility" Value="Hidden"></Setter> + <Style.Triggers> + <MultiDataTrigger> + <MultiDataTrigger.Conditions> + <Condition Binding="{Binding DisplayAnnotations}" Value="True" /> + <Condition Binding="{Binding VisibleCharts.Count,Converter={StaticResource GreaterThanToBooleanConverter}}" Value="True" /> + </MultiDataTrigger.Conditions> + <Setter Property="Visibility" Value="Visible"></Setter> + </MultiDataTrigger> + </Style.Triggers> + </Style> + </Grid.Style> + <s:SciChartSurface Annotations="{Binding Annotations}" Opacity="1" Background="Transparent" GridLinesPanelStyle="{x:Null}" s:SciChartGroup.VerticalChartGroup="SyncedChartsSameAxisSizes"> + + <!-- Define X and Y Axis. Optional bands give a cool look and feel for minimal performance impact --> + <s:SciChartSurface.YAxis> + <s:NumericAxis Visibility="Hidden" DrawMajorBands="False" DrawMajorGridLines="False" DrawMajorTicks="False" DrawMinorGridLines="False" DrawMinorTicks="False" GrowBy="0.1,0.1" MinorsPerMajor="2" VisibleRange="0,1"/> + </s:SciChartSurface.YAxis> + <s:SciChartSurface.XAxis> + <s:DateTimeAxis Visibility="Visible" FontSize="0.1" Background="Transparent" Foreground="Transparent" DrawMajorBands="False" DrawMajorGridLines="False" DrawMajorTicks="False" DrawMinorGridLines="False" DrawMinorTicks="False" VisibleRange="{Binding VisibleChartsRange, Mode=TwoWay}"/> + </s:SciChartSurface.XAxis> + <s:SciChartSurface.ChartModifier> + + <!-- Whats going on here? --> + <!-- We share the mouse events by using MouseManager.MouseEventGroup="..." --> + <!-- We ensure modifiers receive events even when another has handled by setting ReceiveHandledEvents=true --> + <!-- We bind both charts XAxis to shared property on the viewmodel to ensure they stay in sync --> + <s:ModifierGroup s:MouseManager.MouseEventGroup="myCustomGroup"> + <insights:InsightsRubberBandXYZoomModifier RubberBandFill="Transparent" RubberBandStroke="Transparent" IsXAxisOnly="True" ReceiveHandledEvents="True" /> + <insights:InsightsZoomPanModifier ReceiveHandledEvents="True" XyDirection="XDirection" /> + <s:CursorModifier ReceiveHandledEvents="True"/> + <!--<s:MouseWheelZoomModifier/>--> + <!--<s:RolloverModifier ReceiveHandledEvents="True"/>--> + <!--<s:CursorModifier ReceiveHandledEvents="True"/>--> + <!--<s:YAxisDragModifier Tag="FirstYAxis"/>--> + <!--<s:XAxisDragModifier />--> + <s:ZoomExtentsModifier/> + </s:ModifierGroup> + </s:SciChartSurface.ChartModifier> + </s:SciChartSurface> + </Grid> + </Grid> </Grid> - <Grid> + </Grid> + <Grid VerticalAlignment="Top"> + <Grid.Style> + <Style TargetType="Grid"> + <Setter Property="Margin" Value="0 20 0 0"></Setter> + <Style.Triggers> + <DataTrigger Binding="{Binding ElementName=chkSearchBar,Path=IsChecked}" Value="True"> + <DataTrigger.EnterActions> + <BeginStoryboard> + <Storyboard> + <ThicknessAnimation Storyboard.TargetProperty="Margin" To="0 20 0 0" Duration="00:00:0.2" /> + </Storyboard> + </BeginStoryboard> + </DataTrigger.EnterActions> + <DataTrigger.ExitActions> + <BeginStoryboard> + <Storyboard> + <ThicknessAnimation Storyboard.TargetProperty="Margin" To="0 -160 0 0" Duration="00:00:0.2" /> + </Storyboard> + </BeginStoryboard> + </DataTrigger.ExitActions> + </DataTrigger> + </Style.Triggers> + </Style> + </Grid.Style> + <Ellipse Fill="{StaticResource FSE_PrimaryBackgroundMidBrush}" Width="1500" Height="560" VerticalAlignment="Top" HorizontalAlignment="Center" Margin="0 -380 0 0" Opacity="0.9" StrokeThickness="1" Stroke="{StaticResource FSE_GrayBrush}" /> + <Grid DockPanel.Dock="Top" Panel.ZIndex="100"> + <StackPanel> + <DockPanel HorizontalAlignment="Center" VerticalAlignment="Top"> + <StackPanel Orientation="Horizontal" DockPanel.Dock="Left" VerticalAlignment="Bottom" Margin="0 0 0 -20"> + <Grid VerticalAlignment="Bottom" Margin="0 0 20 14"> + <StackPanel> + <Grid Margin="-300 -70 0 0" Width="200"> + <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="40" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> + <material:TimePicker SelectedTime="{Binding StartTime}" Is24Hours="True" VerticalAlignment="Center" Width="150" material:HintAssist.Hint="Time (00:00:00)" /> + </Grid> + <Grid Width="250"> + <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="50" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> + <DatePicker DisplayDateStart="{Binding MinDate}" DisplayDateEnd="{Binding MaxDate}" SelectedDate="{Binding StartDate}" VerticalAlignment="Center" Width="200" material:HintAssist.Hint="Start Date" /> + </Grid> + </StackPanel> + </Grid> + <Image RenderOptions.BitmapScalingMode="Fant" RenderTransformOrigin="0.5,0.5" Source="../Images/arrow_right.png" DockPanel.Dock="Left" Stretch="Fill" Height="80" Width="100" VerticalAlignment="Bottom"> + <Image.RenderTransform> + <RotateTransform Angle="180"/> + </Image.RenderTransform> + </Image> + </StackPanel> + <StackPanel DockPanel.Dock="Right" VerticalAlignment="Bottom" Orientation="Horizontal" Margin="0 0 0 -20"> + <Image RenderOptions.BitmapScalingMode="Fant" Source="../Images/arrow_right.png" DockPanel.Dock="Right" Stretch="Fill" Height="80" Width="100" VerticalAlignment="Bottom" /> + <Grid VerticalAlignment="Bottom" Margin="20 0 0 14"> + <StackPanel> + <Grid Margin="0 -70 -300 0" Width="200"> + <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="40" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> + <material:TimePicker SelectedTime="{Binding EndTime}" Is24Hours="True" VerticalAlignment="Center" Width="150" material:HintAssist.Hint="End Time (All Day)" /> + </Grid> + <Grid Width="250"> + <Polygon Stroke="{StaticResource FSE_PrimaryAccentBrush}" StrokeThickness="1" Stretch="Fill" Height="50" Points="0,15 15,0 285,0 300,15 285,30 15,30"></Polygon> + <DatePicker DisplayDateStart="{Binding MinDate}" DisplayDateEnd="{Binding MaxDate}" SelectedDate="{Binding EndDate}" VerticalAlignment="Center" Width="200" material:HintAssist.Hint="End Date (Today)" /> + </Grid> + </StackPanel> + </Grid> + </StackPanel> + <Image RenderOptions.BitmapScalingMode="Fant" Margin="40 0" Source="../Images/time.png" Stretch="Uniform" Width="100" /> + </DockPanel> + <Button Command="{Binding GetInsightsCommand}" HorizontalAlignment="Center" Width="220" Style="{StaticResource FSE_Button_Polygon}" Height="40" FontSize="14" Margin="0 20 0 0" IsEnabled="{Binding MachineProvider.IsPPCAvailable}">Get Insights</Button> + </StackPanel> </Grid> - </DockPanel> + + <controls:ToggleIconButton x:Name="chkSearchBar" Cursor="Hand" CheckedIcon="ChevronUpCircle" UncheckedIcon="ChevronDownCircle" Width="32" Height="32" VerticalAlignment="Bottom" Margin="0 0 0 -15" IsChecked="{Binding IsSearchBarOpened}" /> + </Grid> </Grid> </Grid> </UserControl> diff --git a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml.cs b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml.cs index 3d17caa97..e9107e100 100644 --- a/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml.cs +++ b/Software/Visual_Studio/FSE/Modules/Tango.FSE.Insights/Views/InsightsView.xaml.cs @@ -1,4 +1,5 @@ -using System; +using SciChart.Charting.Visuals; +using System; using System.Collections.Generic; using System.Linq; using System.Text; @@ -12,17 +13,42 @@ using System.Windows.Media; using System.Windows.Media.Imaging; using System.Windows.Navigation; using System.Windows.Shapes; +using Tango.FSE.Insights.Contracts; namespace Tango.FSE.Insights.Views { /// <summary> /// Interaction logic for InsightsView.xaml /// </summary> - public partial class InsightsView : UserControl + public partial class InsightsView : UserControl, IInsightsView { public InsightsView() { InitializeComponent(); + this.Register<IInsightsView>(); + } + + private void SciChartSurface_Loaded(object sender, RoutedEventArgs e) + { + Grid grid = sender as Grid; + + if (grid != null) + { + SciChartSurface chart = grid.FindChild<SciChartSurface>(); + + if (chart != null) + { + chart.ZoomExtents(); + } + } + } + + public void ZoomExtents() + { + foreach (var chart in chartsItemsControl.FindVisualChildren<SciChartSurface>()) + { + chart.ZoomExtents(); + } } } } diff --git a/Software/Visual_Studio/FSE/Tango.FSE.BL/EntityFrameworkExtensionsHelper.cs b/Software/Visual_Studio/FSE/Tango.FSE.BL/EntityFrameworkExtensionsHelper.cs new file mode 100644 index 000000000..0f5ce3cf1 --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.BL/EntityFrameworkExtensionsHelper.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Tango.FSE.BL +{ + public static class EntityFrameworkExtensionsHelper + { + public static void SetupLicense(String licenseName, String licenseKey) + { + Z.EntityFramework.Extensions.LicenseManager.AddLicense(licenseName, licenseKey); + + string licenseErrorMessage; + if (!Z.EntityFramework.Extensions.LicenseManager.ValidateLicense(out licenseErrorMessage)) + { + throw new Exception(licenseErrorMessage); + } + } + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.BL/Tango.FSE.BL.csproj b/Software/Visual_Studio/FSE/Tango.FSE.BL/Tango.FSE.BL.csproj index b1b0b300e..b28f8b45a 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.BL/Tango.FSE.BL.csproj +++ b/Software/Visual_Studio/FSE/Tango.FSE.BL/Tango.FSE.BL.csproj @@ -83,6 +83,7 @@ <Compile Include="AuthorizationException.cs" /> <Compile Include="CacheEntities\CachedEventType.cs" /> <Compile Include="CacheEntities\CachedPublishedProcedureProject.cs" /> + <Compile Include="EntityFrameworkExtensionsHelper.cs" /> <Compile Include="EntityRepositoryBase.cs" /> <Compile Include="MemoryCacheDictionary.cs" /> <Compile Include="CacheEntities\CachedBugInfoResponse.cs" /> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/FSEViewModel.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/FSEViewModel.cs index 07d2a7a5b..efe9e877a 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/FSEViewModel.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/FSEViewModel.cs @@ -44,6 +44,7 @@ using Tango.FSE.Common.RemoteJob; using Tango.FSE.Common.WindowsManager; using Tango.FSE.Common.DemoMode; using Tango.FSE.Common.FileAssociation; +using Tango.FSE.Common.Insights; namespace Tango.FSE.Common { @@ -236,6 +237,12 @@ namespace Tango.FSE.Common public IFileAssociationProvider FileAssociationProvider { get; set; } /// <summary> + /// Gets or sets the insights provider. + /// </summary> + [TangoInject] + public IInsightsProvider InsightsProvider { get; set; } + + /// <summary> /// Gets or sets the FSE service. /// </summary> [TangoInject] diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/FileSystem/IFileSystemProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/FileSystem/IFileSystemProvider.cs index a97a44f81..32c795ffc 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/FileSystem/IFileSystemProvider.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/FileSystem/IFileSystemProvider.cs @@ -49,9 +49,19 @@ namespace Tango.FSE.Common.FileSystem /// </summary> /// <param name="item">The file or folder.</param> /// <param name="localTargetFolderOrFile">The local target folder or file.</param> - /// <param name="isSingleFile">Indicates whether the localTargetFolder is a file.</param> + /// <param name="isLocaTargetFile">Indicates whether the localTargetFolder is a file.</param> /// <returns></returns> - Task<FileSystemHandler> Download(FileSystemItem item, String localTargetFolderOrFile, bool isSingleFile = false); + Task<FileSystemHandler> Download(FileSystemItem item, String localTargetFolderOrFile, bool isLocaTargetFile = false); + + /// <summary> + /// Downloads the specified file or folder item. + /// </summary> + /// <param name="remotePath">The remote file or folder.</param> + /// <param name="isRemotePathFile">Indicates whether the remote path is a file.</param> + /// <param name="localTargetFolderOrFile">The local target folder or file.</param> + /// <param name="isLocalTargetFile">Indicates whether the localTargetFolder is a file.</param> + /// <returns></returns> + Task<FileSystemHandler> Download(String remotePath, bool isRemotePathFile, String localTargetFolderOrFile, bool isLocalTargetFile = false); /// <summary> /// Uploads the specified local file or folder. diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/IInsightsProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/IInsightsProvider.cs new file mode 100644 index 000000000..f90e398fd --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/IInsightsProvider.cs @@ -0,0 +1,13 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Tango.FSE.Common.Insights +{ + public interface IInsightsProvider + { + Task<InsightsHandler> GetInsights(DateTime startDateUTC, DateTime endTimeUTC); + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsHandler.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsHandler.cs new file mode 100644 index 000000000..a263a50bb --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsHandler.cs @@ -0,0 +1,103 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Tango.Core; + +namespace Tango.FSE.Common.Insights +{ + public class InsightsHandler : ExtendedObject + { + private Action _abortAction; + private TaskCompletionSource<InsightsPackage> _completionSource; + private bool _completed; + + public event EventHandler<InsightsHandlerStatus> StatusChanged; + public event EventHandler<TangoProgressChangedEventArgs<double>> ProgressChanged; + public event EventHandler<InsightsPackage> Completed; + + + private InsightsHandlerStatus _status; + public InsightsHandlerStatus Status + { + get { return _status; } + set + { + if (_status != value) + { + _status = value; + RaisePropertyChangedAuto(); + StatusChanged?.Invoke(this, _status); + } + } + } + + private TangoProgress<double> _progress; + public TangoProgress<double> Progress + { + get { return _progress; } + set + { + _progress = value; RaisePropertyChangedAuto(); + + if (_progress != null) + { + ProgressChanged?.Invoke(this, new TangoProgressChangedEventArgs<double>(_progress)); + } + } + } + + private Exception _failedException; + public Exception FailedException + { + get { return _failedException; } + set { _failedException = value; RaisePropertyChangedAuto(); } + } + + public InsightsHandler(Action abortAction) + { + _completionSource = new TaskCompletionSource<InsightsPackage>(); + _abortAction = abortAction; + Progress = new TangoProgress<double>("Initializing..."); + } + + public void Abort() + { + if (!_completed) + { + _completed = true; + _abortAction?.Invoke(); + Status = InsightsHandlerStatus.Aborted; + _completionSource.SetException(new OperationCanceledException()); + } + } + + public void RaiseFailed(Exception ex) + { + if (!_completed) + { + _completed = true; + FailedException = ex; + Status = InsightsHandlerStatus.Failed; + _completionSource.SetException(ex); + } + } + + public void RaiseCompleted(InsightsPackage package) + { + if (!_completed) + { + _completed = true; + Status = InsightsHandlerStatus.Completed; + Completed?.Invoke(this, package); + _completionSource.SetResult(package); + } + } + + public Task<InsightsPackage> WaitForCompletion() + { + return _completionSource.Task; + } + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsHandlerStatus.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsHandlerStatus.cs new file mode 100644 index 000000000..ec911b836 --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsHandlerStatus.cs @@ -0,0 +1,18 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Tango.FSE.Common.Insights +{ + public enum InsightsHandlerStatus + { + Initializing, + Downloading, + Composing, + Completed, + Failed, + Aborted, + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsPackage.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsPackage.cs new file mode 100644 index 000000000..96718f6bf --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsPackage.cs @@ -0,0 +1,22 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Tango.BL.Entities; +using Tango.Insights; + +namespace Tango.FSE.Common.Insights +{ + public class InsightsPackage + { + public List<InsightsReadyFrame> Frames { get; set; } + public List<InsightsReadyEvent> Events { get; set; } + + public InsightsPackage() + { + Frames = new List<InsightsReadyFrame>(); + Events = new List<InsightsReadyEvent>(); + } + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsReadyEvent.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsReadyEvent.cs new file mode 100644 index 000000000..0378e6a5a --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsReadyEvent.cs @@ -0,0 +1,20 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Tango.BL.Entities; + +namespace Tango.FSE.Common.Insights +{ + public class InsightsReadyEvent + { + public DateTime Time { get; set; } + public EventType EventType { get; set; } + + public override string ToString() + { + return $"{Time}: {EventType.Name}"; + } + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsReadyFrame.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsReadyFrame.cs new file mode 100644 index 000000000..b4ad8ec50 --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Insights/InsightsReadyFrame.cs @@ -0,0 +1,27 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Tango.Insights; +using Tango.PMR.Insights; + +namespace Tango.FSE.Common.Insights +{ + public class InsightsReadyFrame + { + public InsightsFrame Frame { get; private set; } + public InsightsMonitors Monitors { get; private set; } + + public InsightsReadyFrame(InsightsFrame frame) + { + Frame = frame; + Monitors = frame.ToInsightsMonitors(); + } + + public override string ToString() + { + return $"{Frame.Time}: {Monitors.ToString()}"; + } + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/INotificationProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/INotificationProvider.cs index 5fff158fd..1a5026e8e 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/INotificationProvider.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/INotificationProvider.cs @@ -257,8 +257,10 @@ namespace Tango.FSE.Common.Notifications /// Pushes the task item with the specified message. /// </summary> /// <param name="message">The message.</param> + /// <param name="canCancel">Indicates whether the cancel button will be enabled.</param> + /// <param name="cancelAction">Specify the action to execute when cancel button is pressed.</param> /// <returns></returns> - TaskItem PushTaskItem(String message); + TaskItem PushTaskItem(String message, bool canCancel = false, Action cancelAction = null); /// <summary> /// Pops the task item. diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/TaskItem.cs b/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/TaskItem.cs index 048374727..9492433f6 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/TaskItem.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Notifications/TaskItem.cs @@ -22,10 +22,10 @@ namespace Tango.FSE.Common.Notifications } private bool _hasCancel; - public bool HasCancel + public bool CanCancel { get { return _hasCancel; } - set { _hasCancel = value; RaisePropertyChangedAuto(); } + set { _hasCancel = value; RaisePropertyChangedAuto(); CancelCommand?.RaiseCanExecuteChanged(); } } public RelayCommand CancelCommand { get; set; } @@ -43,7 +43,12 @@ namespace Tango.FSE.Common.Notifications public TaskItem(String message, Action cancelAction) : this(message) { _cancelAction = cancelAction; - HasCancel = true; + CancelCommand = new RelayCommand(() => + { + CanCancel = false; + cancelAction?.Invoke(); + }, () => CanCancel); + CanCancel = true; } public void UpdateProgress(String message, double value = 0, double maximum = 100, bool isIndeterminate = true) diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Resources/Converters.xaml b/Software/Visual_Studio/FSE/Tango.FSE.Common/Resources/Converters.xaml index dce8bea15..922790d5e 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/Resources/Converters.xaml +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Resources/Converters.xaml @@ -44,4 +44,5 @@ <localConverters:TimeSpanHumanizeConverter x:Key="TimeSpanHumanizeConverter" /> <localConverters:JobProgressToPositionConverter x:Key="JobProgressToPositionConverter" /> <localConverters:FilePathToIconConverter x:Key="FilePathToIconConverter" /> + <converters:BooleanToYesNoConverter x:Key="BooleanToYesNoConverter" /> </ResourceDictionary>
\ No newline at end of file diff --git a/Software/Visual_Studio/FSE/Tango.FSE.Common/Tango.FSE.Common.csproj b/Software/Visual_Studio/FSE/Tango.FSE.Common/Tango.FSE.Common.csproj index 0584d2e0b..d2208615b 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.Common/Tango.FSE.Common.csproj +++ b/Software/Visual_Studio/FSE/Tango.FSE.Common/Tango.FSE.Common.csproj @@ -85,6 +85,34 @@ <HintPath>..\..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath> </Reference> <Reference Include="PresentationFramework.Aero" /> + <Reference Include="SciChart.Charting, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Charting.dll</HintPath> + </Reference> + <Reference Include="SciChart.Charting.DrawingTools, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Charting.DrawingTools.dll</HintPath> + </Reference> + <Reference Include="SciChart.Charting3D, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Charting3D.dll</HintPath> + </Reference> + <Reference Include="SciChart.Core, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Core.dll</HintPath> + </Reference> + <Reference Include="SciChart.Data, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Data.dll</HintPath> + </Reference> + <Reference Include="SciChart.Drawing, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Drawing.dll</HintPath> + </Reference> + <Reference Include="SciChart.Drawing.DirectX, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Drawing.DirectX.dll</HintPath> + </Reference> <Reference Include="System" /> <Reference Include="System.ComponentModel.DataAnnotations" /> <Reference Include="System.Data" /> @@ -198,6 +226,12 @@ <Compile Include="Helpers\ResourceHelper.cs" /> <Compile Include="INotifyApplicationStarted.cs" /> <Compile Include="INotifyApplicationReady.cs" /> + <Compile Include="Insights\IInsightsProvider.cs" /> + <Compile Include="Insights\InsightsReadyEvent.cs" /> + <Compile Include="Insights\InsightsHandler.cs" /> + <Compile Include="Insights\InsightsHandlerStatus.cs" /> + <Compile Include="Insights\InsightsPackage.cs" /> + <Compile Include="Insights\InsightsReadyFrame.cs" /> <Compile Include="Logging\ILoggingProvider.cs" /> <Compile Include="Logging\RemoteLogFileModel.cs" /> <Compile Include="Logging\RemoteLogFileStatus.cs" /> @@ -470,6 +504,10 @@ <Project>{c6ebbbbe-2123-44dc-aef7-a0d47d736ac0}</Project> <Name>Tango.FileSystem</Name> </ProjectReference> + <ProjectReference Include="..\..\Tango.Insights\Tango.Insights.csproj"> + <Project>{4A55C185-3F8D-41B0-8815-C15F6213A14A}</Project> + <Name>Tango.Insights</Name> + </ProjectReference> <ProjectReference Include="..\..\Tango.Integration\Tango.Integration.csproj"> <Project>{4206ac58-3b57-4699-8835-90bf6db01a61}</Project> <Name>Tango.Integration</Name> @@ -569,6 +607,7 @@ <Resource Include="Images\shadow_right.png" /> <Resource Include="Images\shadow_top.png" /> </ItemGroup> + <ItemGroup /> <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> <PropertyGroup> <PreBuildEvent> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml b/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml index 73680103b..fc6f427c1 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml @@ -3,6 +3,7 @@ xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml" xmlns:materialDesign="http://materialdesigninxaml.net/winfx/xaml/themes" xmlns:dragablz="clr-namespace:Dragablz;assembly=Dragablz" + xmlns:s="http://schemas.abtsoftware.co.uk/scichart" xmlns:local="clr-namespace:Tango.FSE.UI" StartupUri="MainWindow.xaml"> <Application.Resources> @@ -92,12 +93,24 @@ <SolidColorBrush x:Key="MahApps.Metro.Brushes.ToggleSwitchButton.OnSwitchMouseOverBrush.Win10" Color="{DynamicResource Primary400}" /> <SolidColorBrush x:Key="MahApps.Metro.Brushes.ToggleSwitchButton.ThumbIndicatorCheckedBrush.Win10" Color="{DynamicResource Primary500Foreground}" /> </ResourceDictionary> + </ResourceDictionary.MergedDictionaries> <!-- tell Dragablz tab control to use the Material Design theme --> <Style TargetType="{x:Type dragablz:TabablzControl}" BasedOn="{StaticResource MaterialDesignTabablzControlStyle}"> <Setter Property="BorderBrush" Value="Transparent"></Setter> </Style> + + <!--SciChart--> + <Style TargetType="{x:Type s:SciChartSurface}"> + <Setter Property="s:VisualXcceleratorEngine.IsEnabled" Value="True"/> + <Setter Property="s:VisualXcceleratorEngine.DowngradeWithoutException" Value="True"/> + <!-- Change this to True for some examples, e.g. the Billion Point demo --> + <Setter Property="s:VisualXcceleratorEngine.EnableImpossibleMode" Value="False"/> + <!-- Choose a renderer to downgrade to if directx is not available --> + <Setter Property="s:VisualXcceleratorEngine.FallbackType" Value="{x:Type s:HighQualityRenderSurface}"/> + </Style> + <!--SciChart--> </ResourceDictionary> </Application.Resources> </Application> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml.cs b/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml.cs index de0594703..047df9f50 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/App.xaml.cs @@ -1,4 +1,5 @@ using Newtonsoft.Json; +using SciChart.Charting.Visuals; using System; using System.Collections.Generic; using System.Configuration; @@ -13,6 +14,7 @@ using System.Windows; using System.Windows.Markup; using Tango.Core.DI; using Tango.Core.Helpers; +using Tango.FSE.BL; using Tango.FSE.Common; using Tango.FSE.Common.BugReporting; using Tango.FSE.Common.FileAssociation; @@ -131,6 +133,24 @@ namespace Tango.FSE.UI WebRequest.DefaultWebProxy = null; + try + { + EntityFrameworkExtensionsHelper.SetupLicense("4578;101-twine-s.com", "9d23b66f-1101-b253-7f8a-59ae011b2ee8"); + } + catch (Exception ex) + { + LogManager.Log(ex, "Error performing EF extensions license setup."); + } + + try + { + SciChartSurface.SetRuntimeLicenseKey("27FuI+bWcfmLHSBlM4B8nUs23aeeXvft2+7Pxj0fOrcnruWXyOm/swjI2PpoBPOKS9dNVtw60E4Xdpq4Ts8UgMWQHU8qcJtPoAyNQqbVMQNOr/sv1QpSD2mRjogERcrGty+tvlCHMGhkw/TOiL5DPnw5rOPqGfymyRuJRNFTTYB/hCIAiCt7VIlyHhO+uo0DOfxIC+gNVKoWyGd0xdQ3xSUmfdNvUigW7ZkUKDkAIBpRcmOLx5wV4y77I/4MghTl3FAZlhhFoBdAUKLZWpbISU8xfAUkI1s/md0mAztMTbqzkRT94AsSI1/KPnH7fuuH82ABJcp0UnKWh8aIlkbjD2vVCKXn9omMBEBRmTx68IuHoP4iT5mTyd6R3OfnEM6Vc6AZ9SLytjoP7Iu2hPKR7uqGJW/2KZ0jIZ4Hn+bJfl23fBexgJl4jK33aeIIkw/Og67w/CRK4MgiHtSLp7x1I3Fsmw8EYbQ2nZe3lA4SH1DU"); + } + catch (Exception ex) + { + LogManager.Log(ex, "Error settings SciChart runtime license."); + } + base.OnStartup(e); exceptionTrapper = new WpfGlobalExceptionTrapper(); diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/Connection/DefaultMachineProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.UI/Connection/DefaultMachineProvider.cs index 6e1ec93a6..55866361b 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/Connection/DefaultMachineProvider.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/Connection/DefaultMachineProvider.cs @@ -162,7 +162,7 @@ namespace Tango.FSE.UI.Connection { _machineEventsStateProvider = new FSEMachineEventsStateProvider(); - MachineOperator = new ExternalBridgeTcpClient("N/A", "N/A"); + MachineOperator = new ExternalBridgeTcpClient("N/A", "N/A", false); MachineOperator.MachineEventsStateProvider = _machineEventsStateProvider; MachineOperator.StateChanged += MachineOperator_StateChanged; MachineOperator.As<ExternalBridgeTcpClient>().SessionClosed += DefaultMachineProvider_SessionClosed; @@ -185,7 +185,7 @@ namespace Tango.FSE.UI.Connection { try { - LogManager.Log($"Connecting to machine '{machine.GetType().Name}' => '{machine.SerialNumber}' => '{machine.Adapter?.Address}'..."); + LogManager.Log($"Connecting to machine '{machine.GetType().Name}' => '{machine.SerialNumber}' => '{machine.Adapter?.Address}' => {(machine.CompressionEnabled ? "Compression Enabled" : "Compression Disabled")}..."); IsBusy = true; diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/Controls/NotificationsControl.xaml b/Software/Visual_Studio/FSE/Tango.FSE.UI/Controls/NotificationsControl.xaml index a0715a96f..4e6ada6b5 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/Controls/NotificationsControl.xaml +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/Controls/NotificationsControl.xaml @@ -267,7 +267,7 @@ <Grid Grid.Row="2"> <ProgressBar VerticalAlignment="Top" Maximum="{Binding Progress.Maximum}" Value="{Binding Progress.Value}" IsIndeterminate="{Binding Progress.IsIndeterminate}" Height="2"></ProgressBar> <StackPanel HorizontalAlignment="Right" Margin="10" Orientation="Horizontal"> - <Button MinWidth="150" Height="Auto" Style="{StaticResource FSE_RaisedButton_Dark_Hover}" Command="{Binding CancelCommand}" Content="CANCEL" IsEnabled="{Binding HasCancel}"></Button> + <Button MinWidth="150" Height="Auto" Style="{StaticResource FSE_RaisedButton_Dark_Hover}" Command="{Binding CancelCommand}" Content="CANCEL" IsEnabled="{Binding CanCancel}"></Button> </StackPanel> </Grid> </Grid> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/FileSystem/DefaultFileSystemProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.UI/FileSystem/DefaultFileSystemProvider.cs index 6673a5ae3..e7f9772ff 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/FileSystem/DefaultFileSystemProvider.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/FileSystem/DefaultFileSystemProvider.cs @@ -167,7 +167,10 @@ namespace Tango.FSE.UI.FileSystem Priority = QueuePriority.Low }); - _webRtcTransporter = new BasicTransporter(new WebRtcTransportAdapter(_machineProvider.MachineOperator, WebRtcTransportAdapterMode.Active, WEB_RTC_CHANNEL_NAME)); + _webRtcTransporter = new BasicTransporter(new WebRtcTransportAdapter(_machineProvider.MachineOperator, WebRtcTransportAdapterMode.Active, WEB_RTC_CHANNEL_NAME) + { + EnableCompression = _machineProvider.MachineOperator.CompressionEnabled, + }); _webRtcTransporter.UseKeepAlive = false; _webRtcTransporter.ComponentName = "File System Active WebRTC Transporter"; await _webRtcTransporter.Connect(); @@ -272,11 +275,12 @@ namespace Tango.FSE.UI.FileSystem /// <summary> /// Downloads the specified file or folder item. /// </summary> - /// <param name="item">The file or folder.</param> + /// <param name="remotePath">The remote file or folder.</param> + /// <param name="isRemotePathFile">Indicates whether the remote path is a file.</param> /// <param name="localTargetFolderOrFile">The local target folder or file.</param> - /// <param name="isSingleFile">Indicates whether the localTargetFolder is a file.</param> + /// <param name="isLocalTargetFile">Indicates whether the localTargetFolder is a file.</param> /// <returns></returns> - public Task<FileSystemHandler> Download(FileSystemItem item, String localTargetFolderOrFile, bool isSingleFile = false) + public Task<FileSystemHandler> Download(FileSystemItem item, String localTargetFolderOrFile, bool isLocalTargetFile = false) { AuthenticationProvider.ThrowIfNoPermission(Permissions.FSE_PPCFileSystemRead); @@ -289,7 +293,7 @@ namespace Tango.FSE.UI.FileSystem FileSystemHandler handler = null; - if (isSingleFile) + if (isLocalTargetFile) { destination = localTargetFolderOrFile; } @@ -537,6 +541,32 @@ namespace Tango.FSE.UI.FileSystem } /// <summary> + /// Downloads the specified file or folder item. + /// </summary> + /// <param name="remotePath">The remote file or folder.</param> + /// <param name="isRemotePathFile">Indicates whether the remote path is a file.</param> + /// <param name="localTargetFolderOrFile">The local target folder or file.</param> + /// <param name="isLocalTargetFile">Indicates whether the localTargetFolder is a file.</param> + /// <returns></returns> + public Task<FileSystemHandler> Download(String remotePath, bool isRemotePathFile, String localTargetFolderOrFile, bool isLocalTargetFile = false) + { + FileSystemItem item = null; + + if (isRemotePathFile) + { + item = new FileItem(); + } + else + { + item = new FolderItem(); + } + + item.Path = remotePath; + + return Download(item, localTargetFolderOrFile, isLocalTargetFile); + } + + /// <summary> /// Uploads the specified local file or folder. /// </summary> /// <param name="localSourcePath">The local source path.</param> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/Insights/DefaultInsightsProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.UI/Insights/DefaultInsightsProvider.cs new file mode 100644 index 000000000..1e9996bd2 --- /dev/null +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/Insights/DefaultInsightsProvider.cs @@ -0,0 +1,136 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using Tango.BL.Entities; +using Tango.Core; +using Tango.Core.DI; +using Tango.FSE.BL; +using Tango.FSE.Common.Connection; +using Tango.FSE.Common.FileSystem; +using Tango.FSE.Common.Insights; +using Tango.Insights; +using Tango.PPC.Shared.Insights; + +namespace Tango.FSE.UI.Insights +{ + public class DefaultInsightsProvider : ExtendedObject, IInsightsProvider + { + [TangoInject] + private IMachineProvider MachineProvider { get; set; } + + [TangoInject] + private IFileSystemProvider FileSystemProvider { get; set; } + + [TangoInject] + private FSEServicesContainer Services { get; set; } + + public async Task<InsightsHandler> GetInsights(DateTime startDateUTC, DateTime endTimeUTC) + { + InsightsHandler handler = null; + + var response = await MachineProvider.MachineOperator.SendGenericRequest<InsightsRequest, InsightsResponse>(new InsightsRequest() + { + StartDateUTC = startDateUTC, + EndDateUTC = endTimeUTC + }, new Transport.TransportRequestConfig() + { + Timeout = TimeSpan.FromMinutes(1), + }); + + var insightsFilePath = TemporaryManager.CreateImaginaryFile(".insights"); + var fileSystemHandler = await FileSystemProvider.Download(response.InisightsFilePath, true, insightsFilePath, true); + + handler = new InsightsHandler(() => + { + fileSystemHandler.Abort(); + }); + + fileSystemHandler.StatusChanged += (x, status) => + { + if (status == FileSystemHandlerStatus.Downloading) + { + handler.Status = InsightsHandlerStatus.Downloading; + } + else if (status == FileSystemHandlerStatus.Completed) + { + Task.Factory.StartNew(() => + { + try + { + handler.Progress = new TangoProgress<double>("Composing insights..."); + + handler.Status = InsightsHandlerStatus.Composing; + + var package = new InsightsPackage(); + + var insightsFile = InsightsFile.FromFile(insightsFilePath); + + int progress = 0; + + foreach (var frame in insightsFile.Frames.OrderBy(xx => xx.Time)) + { + if (handler.Status == InsightsHandlerStatus.Aborted) + { + return; + } + + package.Frames.Add(new InsightsReadyFrame(frame)); + progress++; + handler.Progress = new TangoProgress<double>("Composing insights...", false, progress, insightsFile.Frames.Count); + } + + handler.Progress = new TangoProgress<double>("Composing insights..."); + + progress = 0; + + var eventTypes = Services.MachineEventsService.GetAllEventTypes().Result; + Dictionary<int, EventType> eventsDictionary = new Dictionary<int, EventType>(); + foreach (var eventType in eventTypes) + { + eventsDictionary.Add(eventType.Code, eventType); + } + + foreach (var ev in insightsFile.Events.OrderBy(xx => xx.Time)) + { + if (handler.Status == InsightsHandlerStatus.Aborted) + { + return; + } + + EventType eventType = eventsDictionary[ev.EventCode]; + package.Events.Add(new InsightsReadyEvent() + { + Time = ev.Time, + EventType = eventType, + }); + + progress++; + handler.Progress = new TangoProgress<double>("Composing insights...", false, progress, insightsFile.Events.Count); + } + + handler.RaiseCompleted(package); + } + catch (Exception ex) + { + handler.RaiseFailed(ex); + } + }); + } + else if (status == FileSystemHandlerStatus.Failed) + { + handler.RaiseFailed(fileSystemHandler.FailedException); + } + }; + + fileSystemHandler.ProgressChanged += (x, e) => + { + e.Progress.Message = "Getting insights from the remote machine..."; + handler.Progress = e.Progress; + }; + + return handler; + } + } +} diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/Notifications/DefaultNotificationProvider.cs b/Software/Visual_Studio/FSE/Tango.FSE.UI/Notifications/DefaultNotificationProvider.cs index 368752120..0ebf457eb 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/Notifications/DefaultNotificationProvider.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/Notifications/DefaultNotificationProvider.cs @@ -667,13 +667,22 @@ namespace Tango.FSE.UI.Notifications } /// <summary> - /// Pushes the task item. + /// Pushes the task item with the specified message. /// </summary> - /// <typeparam name="T"></typeparam> + /// <param name="message">The message.</param> + /// <param name="canCancel">Indicates whether the cancel button will be enabled.</param> + /// <param name="cancelAction">Specify the action to execute when cancel button is pressed.</param> /// <returns></returns> - public TaskItem PushTaskItem(String message) + public TaskItem PushTaskItem(String message, bool canCancel = false, Action cancelAction = null) { - return PushTaskItem(new TaskItem(message)); + if (canCancel || cancelAction != null) + { + return PushTaskItem(new TaskItem(message, cancelAction)); + } + else + { + return PushTaskItem(new TaskItem(message)); + } } /// <summary> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/Panes/ConnectedMachinePane.xaml b/Software/Visual_Studio/FSE/Tango.FSE.UI/Panes/ConnectedMachinePane.xaml index e5791f23c..db2559a9d 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/Panes/ConnectedMachinePane.xaml +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/Panes/ConnectedMachinePane.xaml @@ -79,6 +79,8 @@ <Run Text="{Binding MachineProvider.MachineOperator.Adapter.TransferRate,Converter={StaticResource ByteArrayToFileSizeConverter},Mode=OneWay}"></Run> <Run Text="/ sec"></Run> </TextBlock> + <TextBlock FontWeight="SemiBold" Text="Compression:" /> + <TextBlock Text="{Binding MachineProvider.MachineOperator.Adapter.EnableCompression,Mode=OneWay,Converter={StaticResource BooleanToYesNoConverter}}" /> <TextBlock FontWeight="SemiBold" Text="Diagnostics Frame Rate:" /> <TextBlock> <Run Text="{Binding DiagnosticsProvider.FrameRate,Mode=OneWay}"></Run> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/Tango.FSE.UI.csproj b/Software/Visual_Studio/FSE/Tango.FSE.UI/Tango.FSE.UI.csproj index ee1b0bd29..24cbfd55f 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/Tango.FSE.UI.csproj +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/Tango.FSE.UI.csproj @@ -98,6 +98,34 @@ <Reference Include="Newtonsoft.Json, Version=9.0.0.0, Culture=neutral, PublicKeyToken=30ad4fe6b2a6aeed, processorArchitecture=MSIL"> <HintPath>..\..\packages\Newtonsoft.Json.9.0.1\lib\net45\Newtonsoft.Json.dll</HintPath> </Reference> + <Reference Include="SciChart.Charting, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Charting.dll</HintPath> + </Reference> + <Reference Include="SciChart.Charting.DrawingTools, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Charting.DrawingTools.dll</HintPath> + </Reference> + <Reference Include="SciChart.Charting3D, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Charting3D.dll</HintPath> + </Reference> + <Reference Include="SciChart.Core, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Core.dll</HintPath> + </Reference> + <Reference Include="SciChart.Data, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Data.dll</HintPath> + </Reference> + <Reference Include="SciChart.Drawing, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Drawing.dll</HintPath> + </Reference> + <Reference Include="SciChart.Drawing.DirectX, Version=6.2.1.13304, Culture=neutral, PublicKeyToken=b55dd9efe817e823, processorArchitecture=MSIL"> + <SpecificVersion>False</SpecificVersion> + <HintPath>..\..\Referenced Assemblies\SciChart\SciChart.Drawing.DirectX.dll</HintPath> + </Reference> <Reference Include="System" /> <Reference Include="System.AppContext, Version=4.0.0.0, Culture=neutral, PublicKeyToken=b03f5f7f11d50a3a, processorArchitecture=MSIL"> <HintPath>..\..\packages\System.AppContext.4.3.0\lib\net46\System.AppContext.dll</HintPath> @@ -277,6 +305,7 @@ <Compile Include="FileAssociation\DefaultFileAssociationProvider.cs" /> <Compile Include="FileSystem\DefaultFileSystemProvider.cs" /> <Compile Include="Firmware\DefaultFirmwareStorageProvider.cs" /> + <Compile Include="Insights\DefaultInsightsProvider.cs" /> <Compile Include="InternalModule.cs" /> <Compile Include="Logging\DefaultLoggingProvider.cs" /> <Compile Include="MainWindowVM.cs" /> @@ -613,6 +642,10 @@ <Project>{c6ebbbbe-2123-44dc-aef7-a0d47d736ac0}</Project> <Name>Tango.FileSystem</Name> </ProjectReference> + <ProjectReference Include="..\..\Tango.Insights\Tango.Insights.csproj"> + <Project>{4A55C185-3F8D-41B0-8815-C15F6213A14A}</Project> + <Name>Tango.Insights</Name> + </ProjectReference> <ProjectReference Include="..\..\Tango.Integration\Tango.Integration.csproj"> <Project>{4206AC58-3B57-4699-8835-90BF6DB01A61}</Project> <Name>Tango.Integration</Name> diff --git a/Software/Visual_Studio/FSE/Tango.FSE.UI/ViewModelLocator.cs b/Software/Visual_Studio/FSE/Tango.FSE.UI/ViewModelLocator.cs index 25d0b45c9..5da32809f 100644 --- a/Software/Visual_Studio/FSE/Tango.FSE.UI/ViewModelLocator.cs +++ b/Software/Visual_Studio/FSE/Tango.FSE.UI/ViewModelLocator.cs @@ -66,6 +66,8 @@ using Tango.FSE.Common.SQL; using Tango.FSE.UI.SQL; using Tango.FSE.Common.FileAssociation; using Tango.FSE.UI.FileAssociation; +using Tango.FSE.Common.Insights; +using Tango.FSE.UI.Insights; namespace Tango.FSE.UI { @@ -104,6 +106,7 @@ namespace Tango.FSE.UI TangoIOC.Default.Unregister<IDemoModeManager>(); TangoIOC.Default.Unregister<IRemoteSqlProvider>(); TangoIOC.Default.Unregister<IFileAssociationProvider>(); + TangoIOC.Default.Unregister<IInsightsProvider>(); //TangoIOC.Default.Unregister<ExternalBridgeScanner>(); //TangoIOC.Default.Unregister<IDiagnosticsFrameProvider>(); //TangoIOC.Default.Unregister<IEventLogger>(); @@ -142,6 +145,7 @@ namespace Tango.FSE.UI TangoIOC.Default.Register<IDemoModeManager, DefaultDemoModeManager>(); TangoIOC.Default.Register<IRemoteSqlProvider, DefaultRemoteSqlProvider>(); TangoIOC.Default.Register<IFileAssociationProvider, DefaultFileAssociationProvider>(); + TangoIOC.Default.Register<IInsightsProvider, DefaultInsightsProvider>(); TangoIOC.Default.Register<MainWindowVM>(); diff --git a/Software/Visual_Studio/PPC/Modules/Tango.PPC.MachineSettings/Views/MainView.xaml b/Software/Visual_Studio/PPC/Modules/Tango.PPC.MachineSettings/Views/MainView.xaml index 4f7385513..d436c58b7 100644 --- a/Software/Visual_Studio/PPC/Modules/Tango.PPC.MachineSettings/Views/MainView.xaml +++ b/Software/Visual_Studio/PPC/Modules/Tango.PPC.MachineSettings/Views/MainView.xaml @@ -297,11 +297,16 @@ </DockPanel> <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> + <TextBlock VerticalAlignment="Center">External Bridge Transport Compression</TextBlock> + <touch:TouchToggleSlider IsChecked="{Binding Settings.EnableExternalBridgeTransportCompression}" Margin="0 0 100 0" DockPanel.Dock="Right" Style="{StaticResource TangoToggleButtonGrayAccent}" HorizontalAlignment="Right" Width="90"></touch:TouchToggleSlider> + </DockPanel> + + <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> <TextBlock VerticalAlignment="Center">Enable External Bridge SignalR</TextBlock> <touch:TouchToggleSlider IsChecked="{Binding Settings.EnableExternalBridgeSignalR}" Margin="0 0 100 0" DockPanel.Dock="Right" Style="{StaticResource TangoToggleButtonGrayAccent}" HorizontalAlignment="Right" Width="90"></touch:TouchToggleSlider> </DockPanel> - <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> + <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> <TextBlock VerticalAlignment="Center">External Bridge SignalR Hub</TextBlock> <touch:TouchTextBox KeyboardContainer="{Binding ElementName=Container}" Text="{Binding Settings.ExternalBridgeSignalRHub}" Margin="0 0 100 0" DockPanel.Dock="Right" HorizontalAlignment="Right" Width="Auto" MinWidth="90"></touch:TouchTextBox> </DockPanel> @@ -328,6 +333,26 @@ </touch:TouchComboBox> </DockPanel> + <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> + <TextBlock VerticalAlignment="Center">Enable Insights</TextBlock> + <touch:TouchToggleSlider IsChecked="{Binding Settings.InsightsEnabled}" Margin="0 0 100 0" DockPanel.Dock="Right" Style="{StaticResource TangoToggleButtonGrayAccent}" HorizontalAlignment="Right" Width="90"></touch:TouchToggleSlider> + </DockPanel> + + <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> + <TextBlock VerticalAlignment="Center">Insights Sampling Interval (sec)</TextBlock> + <touch:TouchNumericTextBox Minimum="1" Maximum="300" KeyboardContainer="{Binding ElementName=Container}" Value="{Binding Settings.InsightsSamplingInterval,Converter={StaticResource TimeSpanToSecondsConverter}}" Margin="0 0 100 0" DockPanel.Dock="Right" HorizontalAlignment="Right" Width="90"></touch:TouchNumericTextBox> + </DockPanel> + + <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> + <TextBlock VerticalAlignment="Center">Insights Storage Cleanup Interval (min)</TextBlock> + <touch:TouchNumericTextBox Minimum="5" Maximum="120" KeyboardContainer="{Binding ElementName=Container}" Value="{Binding Settings.InsightsStorageCleanupInterval,Converter={StaticResource TimeSpanToMinutesConverter}}" Margin="0 0 100 0" DockPanel.Dock="Right" HorizontalAlignment="Right" Width="90"></touch:TouchNumericTextBox> + </DockPanel> + + <DockPanel Margin="0 20 0 0" TextElement.FontSize="{StaticResource TangoDefaultFontSize}"> + <TextBlock VerticalAlignment="Center">Insights Max Storage Duration (days)</TextBlock> + <touch:TouchNumericTextBox Minimum="5" Maximum="120" KeyboardContainer="{Binding ElementName=Container}" Value="{Binding Settings.InsightsMaxStorageDuration,Converter={StaticResource TimeSpanToDaysConverter}}" Margin="0 0 100 0" DockPanel.Dock="Right" HorizontalAlignment="Right" Width="90"></touch:TouchNumericTextBox> + </DockPanel> + <DockPanel Margin="0 20 0 0"> <touch:TouchIcon VerticalAlignment="Top" Icon="InformationOutline" Foreground="{StaticResource TangoGrayTextBrush}"></touch:TouchIcon> <TextBlock Margin="10 0 0 0" VerticalAlignment="Top" TextWrapping="Wrap" FontSize="{StaticResource TangoSmallFontSize}" Foreground="{StaticResource TangoGrayTextBrush}"> diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/ExternalBridge/PPCExternalBridgeService.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/ExternalBridge/PPCExternalBridgeService.cs index 6eaeb58a0..236c066e3 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/ExternalBridge/PPCExternalBridgeService.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/ExternalBridge/PPCExternalBridgeService.cs @@ -53,6 +53,7 @@ namespace Tango.PPC.Common.ExternalBridge applicationManager.ApplicationReady += (_, __) => { var settings = SettingsManager.Default.GetOrCreate<PPCSettings>(); + EnableTransportCompression = settings.EnableExternalBridgeTransportCompression; MachineOperator = machineProvider.MachineOperator; Machine = machineProvider.Machine; SignalRConfiguration.Enabled = settings.EnableExternalBridgeSignalR; diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/FileSystem/DefaultFileSystemService.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/FileSystem/DefaultFileSystemService.cs index 86506abcf..958c1aa12 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/FileSystem/DefaultFileSystemService.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/FileSystem/DefaultFileSystemService.cs @@ -15,6 +15,7 @@ using Tango.Integration.Operation; using Tango.Logging; using Tango.PPC.Common.ExternalBridge; using Tango.PPC.Shared.Logs; +using Tango.Settings; using Tango.Transport; using Tango.Transport.Transporters; using Tango.WebRTC; @@ -33,6 +34,7 @@ namespace Tango.PPC.Common.FileSystem private FileSystemManager _manager; private Dictionary<String, FileSystemOperation> _operations; private Dictionary<ExternalBridgeReceiver, BasicTransporter> _webRtcClients; + private bool _enableCompression; public bool Enabled { get; set; } = true; public bool EnableWebRTC { get; set; } = true; @@ -43,6 +45,7 @@ namespace Tango.PPC.Common.FileSystem _manager = new FileSystemManager(); _operations = new Dictionary<string, FileSystemOperation>(); externalBridge.RegisterRequestHandler(this); + _enableCompression = SettingsManager.Default.GetOrCreate<PPCSettings>().EnableExternalBridgeTransportCompression; } [ExternalBridgeRequestHandlerMethod(typeof(InitWebRtcRequest), RequestHandlerLoggingMode.LogRequestNameAndContent)] @@ -66,7 +69,10 @@ namespace Tango.PPC.Common.FileSystem } LogManager.Log("Initializing WebRTC transport adapter on 'Passive' mode."); - var webRtcAdapter = new WebRtcTransportAdapter(receiver, WebRtcTransportAdapterMode.Passive, request.DataChannelName); + var webRtcAdapter = new WebRtcTransportAdapter(receiver, WebRtcTransportAdapterMode.Passive, request.DataChannelName) + { + EnableCompression = _enableCompression + }; webRtcAdapter.Ready += (x, e) => { LogManager.Log("The file system service WebRTC channel is ready."); diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/Insights/DefaultInsightsService.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/Insights/DefaultInsightsService.cs index bfbf7114f..24852d853 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/Insights/DefaultInsightsService.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/Insights/DefaultInsightsService.cs @@ -4,6 +4,7 @@ using System.IO; using System.Linq; using System.Text; using System.Threading.Tasks; +using Tango.BL; using Tango.Core; using Tango.Core.DI; using Tango.Insights; @@ -74,6 +75,8 @@ namespace Tango.PPC.Common.Insights { var frames = InsightsManager.Default.GetFrames(request.StartDateUTC, request.EndDateUTC); insightsFile.Frames = frames; + insightsFile.Events = InsightsManager.Default.GetEvents(request.StartDateUTC, request.EndDateUTC); + insightsFile.ToFile(filePath); }); diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/PPCSettings.cs b/Software/Visual_Studio/PPC/Tango.PPC.Common/PPCSettings.cs index 9afbb52b6..bd21b3bb0 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/PPCSettings.cs +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/PPCSettings.cs @@ -61,6 +61,11 @@ namespace Tango.PPC.Common public String ExternalBridgePassword { get; set; } /// <summary> + /// Gets or sets a value indicating whether to enable transport compression for external bridge clients. + /// </summary> + public bool EnableExternalBridgeTransportCompression { get; set; } + + /// <summary> /// Gets or sets a value indicating whether [enable hot spot]. /// </summary> public bool EnableHotSpot { get; set; } @@ -296,6 +301,7 @@ namespace Tango.PPC.Common EmbeddedComPort = "COM10"; EmbeddedDeviceHint = "Tango USB Serial Port"; ExternalBridgePassword = "Aa123456"; + EnableExternalBridgeTransportCompression = true; HotSpotPassword = "Aa123456"; LockScreenTimeout = TimeSpan.FromMinutes(10); LockScreenPassword = "1111"; diff --git a/Software/Visual_Studio/PPC/Tango.PPC.Common/Resources/Merged.xaml b/Software/Visual_Studio/PPC/Tango.PPC.Common/Resources/Merged.xaml index 955a584c2..806a94bb0 100644 --- a/Software/Visual_Studio/PPC/Tango.PPC.Common/Resources/Merged.xaml +++ b/Software/Visual_Studio/PPC/Tango.PPC.Common/Resources/Merged.xaml @@ -54,6 +54,7 @@ <converters:DateTimeUTCToShortDateTimeConverter x:Key="DateTimeUTCToShortDateTimeConverter" /> <converters:TimeSpanToMinutesConverter x:Key="TimeSpanToMinutesConverter" /> <converters:TimeSpanToSecondsConverter x:Key="TimeSpanToSecondsConverter" /> + <converters:TimeSpanToDaysConverter x:Key="TimeSpanToDaysConverter" /> <converters:BooleanToYesNoConverter x:Key="BooleanToYesNoConverter" /> <Style TargetType="FrameworkElement"> diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.DrawingTools.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.DrawingTools.dll Binary files differnew file mode 100644 index 000000000..0bb8fe9e4 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.DrawingTools.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.DrawingTools.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.DrawingTools.xml new file mode 100644 index 000000000..5fa594f99 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.DrawingTools.xml @@ -0,0 +1,1189 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Charting.DrawingTools</name> + </assembly> + <members> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation"> + <summary> + Defines brush annotation, which may be placed on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.StrokeProperty"> + <summary> + Defines Stroke dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.StrokeThicknessProperty"> + <summary> + Defines StrokeThikness dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.InitialBasePointsProperty"> + <summary> + Defines InitialBasePoints dependency property. + </summary> + </member> + <member name="E:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.AnnotationCreated"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.InitialBasePoints"> + <summary> + Gets or Sets initial base points of type Observable collection of (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.StrokeThickness"> + <summary> + Gets or sets the stroke thickness. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.Stroke"> + <summary> + Gets or sets the stroke brush. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.IsCreated"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.OnApplyTemplate"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.GetBaseDataValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.SetCashedBasePoints"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.OnAnnotationPointerPressed(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.GetBasePoints(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.GetSelectedCursor"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.MoveAnnotationTo(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,System.Double,System.Double)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.MakeInvisible"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.OnAttached"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.OnDetached"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation.OnAnnotationCreated"> + <summary> + Raises when <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation" /> creation is finished. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation"> + <summary> + Defines an (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />), which may be placed on the chart. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase"> + <summary> + Provides a base class for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />) annotation to be rendered over the chart + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.TextStyleProperty"> + <summary> + Defines TextStyle dependency property. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <summary> + Called internally to set base point with the (<paramref name="index" />) param at (<paramref name="xDataValue" />) and (<paramref name="yDataValue" />) coordinates. + </summary> + <param name="xDataValue"></param> + <param name="yDataValue"></param> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.DetachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationBase.AttachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation"> + <summary> + Defines an extended line annotation, that is derived from <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotation" /> and which may be placed on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.IdProperty"> + <summary> + Defines the Id dependency property + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.Id"> + <summary> + Gets or Sets Id property + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.OnApplyTemplate"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.GetCoordinates"> + <summary> + Gets annotation coordinates. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.SetActualCoordinates(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Sets actual annotation coordinates + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.MakeInvisible"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation.PlaceAnnotation(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotation"> + <summary> + Defines an (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotation" />), which may be placed on the chart. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotation" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase"> + <summary> + /// Provides a base class for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase" />). + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotationBase.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine"> + <summary> + Interaction logic for FibonacciRatioLine.xaml + </summary> + <summary> + FibonacciRatioLine + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine.InitializeComponent"> + <summary> + InitializeComponent + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineBase"> + <summary> + Defines an (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />), which may be placed on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineBase.LineLevelProperty"> + <summary> + Defines LineLevel dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineBase.NextLineLevelProperty"> + <summary> + Defines NextLineLevelProperty + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineBase.NextLineLevel"> + <summary> + Gets or Sets NextLineLevel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineBase.LineLevel"> + <summary> + Gets or Sets LineLevel. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineViewModel"> + <summary> + Defines viewmodel for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />), which may be placed on the chart. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineViewModel.#ctor(System.Double,System.Windows.Media.Brush)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" /> class, at (<paramref name="y1" />) value level + and with (<paramref name="stroke" />) brush. + </summary> + <param name="y1"></param> + <param name="stroke"></param> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineViewModel.LineLevel"> + <summary> + Gets or Sets LineLevel value for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLineViewModel.Stroke"> + <summary> + Gets or Sets Stroke brush for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />). + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation"> + <summary> + Defines an (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation" />), which may be placed on the chart. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotationBase"> + <summary> + Provides a base class for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation" />). + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotationBase.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotationBase.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotationBase.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotationBase.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotationBase.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTableAnnotation"> + <summary> + Interaction logic for FibonacciTableAnnotation.xaml + </summary> + <summary> + FibonacciTableAnnotation + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTableAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTableAnnotation" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTableAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTableAnnotation.GetBasePoints(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTableAnnotation.InitializeComponent"> + <summary> + InitializeComponent + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel"> + <summary> + Interaction logic for FibonacciTextLevel.xaml + </summary> + <summary> + FibonacciTextLevel + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel.OnApplyTemplate"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel.FocusInputTextArea"> + <summary> + Focuses the text input area on the <see cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /></summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel.RemoveFocusInputTextArea"> + <summary> + Remove focus from input text area. Applicable only for Text and label annotation + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciTextLevel.InitializeComponent"> + <summary> + InitializeComponent + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.IFibonacciRetracementAnnotation"> + <summary> + Defines the interface to an FibonacciRetracementAnnotation, that is a special type of drawingToolsAnnotation, a custom drawable element over or under the SciChartSurface. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.IFibonacciRetracementAnnotation.MovingLinesPartAnnotations"> + <summary> + Returns collection of moving lines annotations. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation"> + <summary> + Defines an head and shoulders annotation, which may be placed on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.FillProperty"> + <summary> + Defines Fill dependency property. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.Fill"> + <summary> + Gets or sets Fill brush. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.UpdatePolygonById(System.String)"> + <summary> + Update polygon coordinates by Id of the polygon + </summary> + <param name="id">Polygon id</param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.GetPolygonAnnotation(System.String)"> + <summary> + Returns polygon annotation, that corresponds to (<paramref name="id" />) parameter. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.GetTextAnnotation(System.String)"> + <summary> + Returns text annotation. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.DetachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation.AttachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation"> + <summary> + Defines the interface to an drawing tool, that is a special type of annotation, a custom drawable element over or under the SciChartSurface. + </summary> + </member> + <member name="E:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation.AnnotationCreated"> + <summary> + Occurs when an annotation creation operation is finished and annotation created + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation.IsCreated"> + <summary> + Gets whether the current annotation is created. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <summary> + Called to set the base point at the specified position at (<paramref name="x" />) and (<paramref name="y" />). Programmatically sets an adorner point position + NOTICE: method should be called after annotation was added to SciChartSurface.Annotations collection. + </summary> + <param name="x"></param> + <param name="y"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <summary> + Called to update the position of (<paramref name="index" />) point to a new position at (<paramref name="x" />) and (<paramref name="y" />). + This method uses to update base points(and adorners also) that forces drawing tools annotation to re-draw. + </summary> + <param name="index"></param> + <param name="x"></param> + <param name="y"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation.GetBaseDataValues"> + <summary> + Gets the adorner data value positions + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ITradingAnnotation.SetCashedBasePoints"> + <summary></summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint"> + <summary> + Represents an x- and y-DataValue pair in two-dimensional space. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint.X"> + <summary> + Gets or sets X DataValue + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint.Y"> + <summary> + Gets or sets Y DataValue + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint.#ctor(System.IComparable,System.IComparable)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.IFibLevel"> + <summary> + Defines the interface to an <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />, that is used for storing line levels. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.Models.IFibLevel.LineLevel"> + <summary> + Gets or sets LineLevel value. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.Models.IFibLevel.NextLineLevel"> + <summary> + Gets or sets NextLineLevel value. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.RatioModel"> + <summary> + Defines model for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />) that is used in (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation" />) and in (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotation" />). + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.Models.RatioModel.#ctor(System.Double,System.Windows.Media.Brush)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.RatioModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.Models.RatioModel.Value"> + <summary> + Gets or sets the Value that is used for displaying Level of the (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />) + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.Models.RatioModel.Brush"> + <summary> + Gets or sets brush that is used for coloring (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRatioLine" />) + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation"> + <summary> + Defines the pitchfork annotation, which may be placed on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.SidesFillProperty"> + <summary> + Defines SidesFill dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.MiddleFillProperty"> + <summary> + Defines MiddleFill dependency property. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.MiddleFill"> + <summary> + Gets or sets the brush that is used for filling side middle "fork" section. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.SidesFill"> + <summary> + Gets or sets the brush that is used for filling side "fork" sections. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <summary> + Called internally to set base point with the (<paramref name="index" />) param at (<paramref name="xDataValue" />) and (<paramref name="yDataValue" />) coordinates. + </summary> + <param name="xDataValue"></param> + <param name="yDataValue"></param> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.GetExtendedLineAnnotation(System.String)"> + <summary> + Returns <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ExtendedLineAnnotation" /> instance with corresponding (<paramref name="id" />). + </summary> + <param name="id"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.GetPolygonAnnotation(System.String)"> + <summary> + Returns <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation" /> instance with corresponding (<paramref name="id" />). + </summary> + <param name="id"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.DetachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation.AttachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.GetBaseDataValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.SetCashedBasePoints"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.OnApplyTemplate"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.GetBasePoints(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.GetSelectedCursor"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.OnAnnotationPointerPressed(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.OnAnnotationPointerReleased(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.OnAnnotationPointerMoved(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.MakeInvisible"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.MoveAnnotationTo(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,System.Double,System.Double)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation.UpdateBasePoint(System.Int32,System.Double,System.Double)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase"> + <summary> + Provides a base class for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase" />) to be rendered over the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.IsMouseOverParentAnnotationProperty"> + <summary> + Defines the IsMouseOverParentAnnotation attached property, that recognizes if mouse is over the parent composite annotation. + this is used to let parent annotation know that it's hovered by the mouse + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.IsFilledAreaHitTestVisibleProperty"> + <summary> + Defines the IsFilledAreaHitTestVisibleProperty attached property + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetIsMouseOverParentAnnotation(SciChart.Charting.Visuals.Annotations.AnnotationBase,System.Boolean)"> + <summary> + Sets the IsMouseOverParentAnnotation attached property. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.GetIsMouseOverParentAnnotation(SciChart.Charting.Visuals.Annotations.AnnotationBase)"> + <summary> + Gets the IsMouseOverParentAnnotation attached property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.BasePointsCountProperty"> + <summary> + Defines BasePointsCount dependency property + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetMovingPart(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the MovingPart attached property. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.GetMovingPart(System.Windows.DependencyObject)"> + <summary> + Gets the MovingPart attached property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.InitialBasePointsProperty"> + <summary> + Defines InitialBasePoints dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.StrokeProperty"> + <summary> + Defines Stroke dependency property that specifies the Stroke brush of the trading annotation. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.LineStyleProperty"> + <summary> + Defines the LineStyle dependency property. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.BasePointsCount"> + <summary> + Gets or Sets base points count. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.InitialBasePoints"> + <summary> + Gets or Sets initial base points of type Observable collection of (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.Models.ComparablePoint" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.IsFilledAreaHitTestVisible"> + <summary> + Gets or sets a value that declares whether this element can possibly be returned as a hit test result. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.IsCreated"> + <summary> + Gets whether the current annotation is created + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.Stroke"> + <summary> + Gets or sets the Stroke property + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.LineStyle"> + <summary> + Gets or sets the LineStyle property + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness property + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.MovingLinesPartAnnotations"> + <summary> + Gets the MovingLinesPartAnnotations collection with child annotations that are moving. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.IsReadyToUpdateAfterUnload"> + <summary> + Gets if annotation is ready to update after unload + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates the coordinate calculators and refreshes the annotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="xCoordinateCalculator">The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + <param name="yCoordinateCalculator">The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.OnLoaded(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Called when trading annotation is loaded. + </summary> + <param name="sender"></param> + <param name="routedEventArgs"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.UpdatePolygonById(System.String)"> + <summary> + Update polygon coordinates by Id of the polygon + </summary> + <param name="id">Polygon id</param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.UpdateTextAnnotationBasePoint(SciChart.Charting.Visuals.Annotations.IAnnotation,System.Windows.Point,System.Windows.Point,System.Windows.Point)"> + <summary> + Called to update position of the TextAnnotation + </summary> + <param name="textAnnotation"></param> + <param name="currentBasePoint"></param> + <param name="previousBasePoint"></param> + <param name="nextBasePoint"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetOnTop(System.Boolean)"> + <summary> + Changes Z-index of trading annotation. + </summary> + <param name="isMouseOver"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.OnAnnotationPointerPressed(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.MoveBasePointTo(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.MoveAnnotationTo(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,System.Double,System.Double)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.GetBasePoints(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.GetBaseDataValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <summary> + Called internally to set base point with the (<paramref name="index" />) param at (<paramref name="xDataValue" />) and (<paramref name="yDataValue" />) coordinates. + </summary> + <param name="xDataValue"></param> + <param name="yDataValue"></param> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetCashedBasePoints"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.OnAnnotationCreated"> + <summary> + Rises when trading annotation is created. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.OnAttached"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.OnDetached"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.WriteXml(System.Xml.XmlWriter)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase.ReadXml(System.Xml.XmlReader)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.HeadAndShouldersAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.PitchforkAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.PitchforkAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.XabcdAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciExtensionAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciExtensionAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.FibonacciExtensionAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciExtensionAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciExtensionAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciRetracementAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciAnnotation.FibonacciRetracementAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.FibonacciRetracementAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciRetracementAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.FibonacciRetracementAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ITradingAnnotationViewModel"> + <summary> + Defines the interface to an trading annotation ViewModel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ITradingAnnotationViewModel.Annotation"> + <summary> + Gets or Sets an instance of (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase" />). + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel"> + <summary> + Provides a base class for trading annotation viewmodels. + </summary> + </member> + <member name="E:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.AnnotationCreated"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.SciChart#Charting#DrawingTools#TradingAnnotations#ViewModels#ITradingAnnotationViewModel#Annotation"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.LineStyle"> + <summary> + Gets or Sets the line style for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.IsCreated"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.Stroke"> + <summary> + Gets or Sets the Stroke brush for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.FontSize"> + <summary> + Gets or Sets Font size for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.StrokeThickness"> + <summary> + Gets or Sets the StrokeThickness value for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.TradingAnnotationBase" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.Annotations"> + <summary> + Gets or Sets collection of annotations. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.GetBaseDataValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.TradingAnnotationViewModel.SetCashedBasePoints"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel"> + <summary> + Provides a class for BrushAnnotation viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.SciChart#Charting#DrawingTools#TradingAnnotations#ViewModels#ITradingAnnotationViewModel#Annotation"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.IsCreated"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.Stroke"> + <summary> + Gets or Sets the Stroke brush for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.StrokeThickness"> + <summary> + Gets or Sets the StrokeThickness value for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.BrushAnnotation" />). + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.GetBaseDataValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.SetCashedBasePoints"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.BrushAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationBaseViewModel"> + <summary> + Provides a class for EllioWaveAnnotationBase viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationBaseViewModel.TextStyle"> + <summary> + Gets or Sets text style for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationBaseViewModel.FontFamily"> + <summary> + Gets or Sets Font family for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationBaseViewModel.FontWeight"> + <summary> + Gets or Sets Font weight for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationBaseViewModel.Foreground"> + <summary> + Gets or Sets foreground for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.ElliotWaveAnnotation" />). + </summary> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationViewModel"> + <summary> + Provides a class for EllioWaveAnnotation viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.ElliotWaveAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.HeadAndShouldersAnnotationViewModel"> + <summary> + Provides a class for EllioWaveAnnotation viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.HeadAndShouldersAnnotationViewModel.Fill"> + <summary> + Gets or Sets the Fill brush for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.HeadAndShouldersAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.HeadAndShouldersAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.PitchforkAnnotationViewModel"> + <summary> + Provides a class for PitchforkAnnotation viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.PitchforkAnnotationViewModel.MiddleFill"> + <summary> + Gets or sets the brush that is used for filling the middle "fork" section. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.PitchforkAnnotationViewModel.SidesFill"> + <summary> + Gets or sets the brush that is used for filling side "fork" sections. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.PitchforkAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.XabcdAnnotationViewModel"> + <summary> + Provides a class for XabcdAnnotatio viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.XabcdAnnotationViewModel.Fill"> + <summary> + Gets or Sets the Fill brush for (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation" />). + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.XabcdAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.FibonacciExtensionAnnotationViewModel"> + <summary> + Provides a class for FibonacciExtensionAnnotation viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.FibonacciExtensionAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.FibonacciRetracementAnnotationViewModel"> + <summary> + Provides a class for FibonacciRetracementAnnotation viewmodel. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.ViewModels.FibonacciRetracementAnnotationViewModel.ViewType"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation"> + <summary> + Defines an XABCD annotation, which may be placed on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.FillProperty"> + <summary> + Defines the Fill dependency property. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.Fill"> + <summary> + Gets or sets the Fill brush that is used for filling inner (<see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation" />). + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.GetPolygonAnnotation(System.String)"> + <summary> + Returns an <see cref="T:SciChart.Charting.DrawingTools.TradingAnnotations.PolygonAnnotation" /> with corresponding (<paramref name="id" />). + </summary> + <param name="id"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.SetBasePoint(System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.UpdateBasePoint(System.Int32,System.IComparable,System.IComparable)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.SetBasePoint(System.IComparable,System.IComparable,System.Int32)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.UpdatePolygonById(System.String)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.DetachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingAnnotations.XabcdAnnotation.AttachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier"> + <summary> + A custom <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> to be used in conjunction with the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" />. The <see cref="T:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier" /> + allows creation of drawing tools annotations on mouse-click and drag. See the example of use [ Trade Annotations ] in the examples-suite. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier.OnIsEnabledChanged"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifierMvvm"> + <summary> + A custom <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> to be used in conjunction with the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" />. The <see cref="T:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifier" /> + allows creation of drawing tools annotations on mouse-click and drag. See the example of use [ Trade Annotations ] in the examples-suite. + </summary> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifierMvvm.OnIsEnabledChanged"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifierMvvm.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifierMvvm.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.DrawingTools.TradingModifiers.TradingAnnotationCreationModifierMvvm.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.dll Binary files differnew file mode 100644 index 000000000..44277d25f --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.xml new file mode 100644 index 000000000..9bc645dda --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting.xml @@ -0,0 +1,36951 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Charting</name> + </assembly> + <members> + <member name="T:SciChart.Charting.ChartModifiers.AnnotationCreationArgs"> + <summary> + Event args used by event <see cref="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.OnAnnotationCreated" /> event + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationArgs.NewAnnotation"> + <summary> + Get's new <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> that was created. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationArgs.#ctor(SciChart.Charting.Visuals.Annotations.AnnotationBase)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.AnnotationCreationArgs" /> class. + </summary> + <param name="annotation">The new annotation.</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.ChartModifiers.AnnotationCreationModifier"> + <summary> + A custom <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> to be used in conjunction with the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" />. The <see cref="T:SciChart.Charting.ChartModifiers.AnnotationCreationModifier" /> + allows creation of annotations on mouse-click and drag. See the example of use CreateAnnotationsDynamically in the examples-suite + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.YAxisIdProperty"> + <summary>Defines the YAxisId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.XAxisIdProperty"> + <summary>Defines the XAxisId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.AnnotationTypeProperty"> + <summary>Defines the Annotation Type DependencyProperty</summary> + </member> + <member name="E:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.AnnotationCreated"> + <summary> + Event raised when an annotation is created + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.AnnotationType"> + <summary> + Gets or sets the type of the annotation to create + </summary> + <value> + The type of the annotation. + </value> + <exception cref="T:System.ArgumentOutOfRangeException">value</exception> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.AnnotationStyle"> + <summary> + Gets or sets a <see cref="T:System.Windows.Style" /> to apply to the annotation being created + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.Annotation"> + <summary> + Gets the newly created <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.OnAnnotationCreated"> + <summary> + Called when [annotation created]. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="mouseEventArgs">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="mouseButtonEventArgs">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifier.CreateAnnotation(System.Type,System.Windows.Style)"> + <summary> + Creates an annotation of the specified Type and applies the style to it + </summary> + <param name="annotationType">The Type of annotation to create</param> + <param name="annotationStyle">The style to apply to the annotation</param> + <returns>The annotation instance</returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.AnnotationCreationMVVMArgs"> + <summary> + Event parameters passed to the <see cref="E:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.AnnotationCreated" /> event handler. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationMVVMArgs.NewAnnotationViewModel"> + <summary> + <see cref="T:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel" /> of the newly created annotation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationMVVMArgs.#ctor(SciChart.Charting.Model.ChartSeries.IAnnotationViewModel)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.ChartModifiers.AnnotationCreationMVVMArgs" />. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM"> + <summary> + A custom <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> to be used in conjunction with the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" />. The <see cref="T:SciChart.Charting.ChartModifiers.AnnotationCreationModifier" /> + allows creation of annotations on mouse-click and drag. See the example of use CreateAnnotationsDynamically in the examples-suite + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.YAxisIdProperty"> + <summary>Defines the YAxisId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.XAxisIdProperty"> + <summary>Defines the XAxisId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.AnnotationViewModelTypeProperty"> + <summary>Defines the AnnotationType DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.AnnotationViewModelsCollectionProperty"> + <summary>Defines the AnnotationViewModelsCollection DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.#ctor"> + <summary> + Initializes a new instance of <see cref="T:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM" />. + </summary> + </member> + <member name="E:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.AnnotationCreated"> + <summary> + Event raised when an annotation is created + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.AnnotationViewModelType"> + <summary> + Gets or sets the type of the annotation to create + </summary> + <value> + The type of the annotation. + </value> + <exception cref="T:System.ArgumentOutOfRangeException">value</exception> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.AnnotationViewModelsCollection"> + <summary> + Gets a collection of <see cref="T:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel" /> that represent annotations created by this modifier. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.Annotation"> + <summary> + Gets the newly created <see cref="T:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.OnAnnotationCreated"> + <summary> + Called when [annotation created]. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="mouseEventArgs">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="mouseButtonEventArgs">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AnnotationCreationModifierMVVM.CreateAnnotation(System.Type)"> + <summary> + Creates an annotation of the specified Type and applies the style to it + </summary> + <param name="annotationType">The Type of annotation to create</param> + <returns>The annotation instance</returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ApiElementBase"> + <summary> + Base class to expose properties and methods for <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> derived types and <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> derived types + </summary> + </member> + <member name="E:SciChart.Charting.ChartModifiers.ApiElementBase.PropertyChanged"> + <summary> + Occurs when a property changes in the <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to perform operations on + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.XAxes"> + <summary> + Returns the XAxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.YAxes"> + <summary> + Returns the YAxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.YAxis"> + <summary> + Gets the primary YAxis instance from the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /> collection + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.XAxis"> + <summary> + Gets the primary XAxis instance from the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /> collection + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.Services"> + <summary> + Gets or sets a <see cref="T:SciChart.Core.Utility.IServiceContainer" /> container + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.ModifierSurface"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, which acts as a canvas to place UIElements + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.IsAttached"> + <summary> + Gets or sets whether this Element is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <value> + <c>true</c> if this instance is attached; otherwise, <c>false</c>.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ApiElementBase.RootGrid"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IMainGrid" /> which is the root component for the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, + containing the XAxis, YAxes, ModifierSurface, RenderSurface and GridLinesPanel + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.GetYAxis(System.String)"> + <summary> + Gets the YAxis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> at the specified <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.GetXAxis(System.String)"> + <summary> + Gets the XAxis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> at the specified <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.OnInvalidateParentSurface"> + <summary> + Raises the <see cref="T:SciChart.Charting.Utility.InvalidateSciChartMessage" /> which causes the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to invalidate + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ApiElementBase.OnPropertyChanged(System.String)"> + <summary> + Raises the PropertyChanged event, as part of <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.AxisDragCursor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.AxisDragCursor" /> class. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AxisDragCursor.AngleProperty"> + <summary> + Defines the Angle DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragCursor.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.YAxisDragModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AxisDragCursor.Angle"> + <summary> + Defines by what Angle to rotate AxisDragCursor + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.AxisDragModifierBase"> + <summary> + Provides base class for dragging operations on axes + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AxisDragModifierBase.AxisIdProperty"> + <summary> + Defines the YAxisId DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AxisDragModifierBase.DragModeProperty"> + <summary> + Defines the DragMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.AxisDragModifierBase.MinTouchAreaProperty"> + <summary> + Defines the MinTouchArea DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.AxisDragModifierBase" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AxisDragModifierBase.DragMode"> + <summary> + Gets or sets the DragMode of the <see cref="T:SciChart.Charting.ChartModifiers.YAxisDragModifier" />. This modifier may be used to scale the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> + or pan the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> creating a scrolling or vertical pan effect. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AxisDragModifierBase.AxisId"> + <summary> + Defines which YAxis to bind the YAxisDragModifier to, matching by string Id + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AxisDragModifierBase.MinTouchArea"> + <summary> + Gets or sets minimal area of recognition (min height for horizontal axis or min width for vertical), where user click or touch triggers zoom behavior. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.AxisDragModifierBase.IsDragging"> + <summary> + Gets a value indicating whether the user is currently dragging the axis + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.GetAxisById(System.String)"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance, which current modifier is associated with, on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.GetApplicableAxes"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> which this modifier may be applicable on + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.GetIsSecondHalf(System.Windows.Point,System.Windows.Rect,System.Boolean)"> + <summary> + Gets whether the specified mouse point is within the second (right-most or top-most) half of the Axis bounds + </summary> + <param name="point">The mouse point</param> + <param name="axisBounds">The axis bounds</param> + <param name="isHorizontalAxis">Value, which indicates whether current axis is horizontal or not</param> + <returns>True if the point is within the second (right-most or top-most) half of the axis bounds, else false</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.GetUsedCursor(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Depending on axis orientation, returns a Cursor to show during mouse-over of the axis + </summary> + <param name="axis">The axis instance</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> or mouse capture is lost. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.PerformPan(System.Windows.Point,System.Windows.Point)"> + <summary> + Peforms a pan on the assocaited <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />. The pan is considered to be a drag from <paramref name="currentPoint" /> to <paramref name="lastPoint" /></summary> + <param name="currentPoint">The current mouse point</param> + <param name="lastPoint">The last mouse point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.PerformScale(System.Windows.Point,System.Windows.Point,System.Boolean)"> + <summary> + Performs a Scale on the associated <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />. The scale is considered to be a drag from <paramref name="currentPoint" /> to <paramref name="lastPoint" /></summary> + <param name="currentPoint">The current mouse point</param> + <param name="lastPoint">The last mouse point</param> + <param name="isSecondHalf">Boolean flag to determine which side of the axis is scaled</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.CalculateScaledRange(System.Windows.Point,System.Windows.Point,System.Boolean,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + When overriden in a derived class, calculates an output <see cref="T:SciChart.Data.Model.IRange" /> to apply to the associated <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase">Axis</see>, + given the input parameters + </summary> + <param name="currentPoint">The current mouse position</param> + <param name="lastPoint">The last mouse position</param> + <param name="isSecondHalf">A flag, which determines how the scale operates, e.g. which half of the axis (top or bottom, left or right) was dragged</param> + <param name="axis">The axis being operated on</param> + <returns>The output <see cref="T:SciChart.Data.Model.IRange" /></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.AxisDragModifierBase.CalculateRelativeRange(SciChart.Data.Model.IRange,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + When overriden in a derived class, calculates an output <see cref="T:SciChart.Data.Model.IRange" /> to apply to the associated <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase">Axis</see>, + given the input parameters. + </summary> + <remarks>A Relative-Range is defined as one that affects the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" />, not the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" />. This + is used in cases where the YAxis or XAxis has <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.AutoRange" /> set to Always, and you still want to be able to drag the axis to + set a constant, relative margin of spacing around the upper and lower bounds of the data</remarks> + <param name="fromRange">The input range, expecting a VisibleRange</param> + <param name="axis">The axis being operated on</param> + <returns>The output <see cref="T:SciChart.Data.Model.IRange" /> which can then be applied to the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> property to get the same affect as applying the input visible-range</returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ChartModifierBase"> + <summary> + Defines the base class to a Chart Modifier, which can be used to extend the interactivity or rendering of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <seealso cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ChartModifierBase.ReceiveHandledEventsProperty"> + <summary> + Defines the ReceiveHandledEvents DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ChartModifierBase.IsEnabledProperty"> + <summary> + Defines the IsEnabled Attached Property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ChartModifierBase.IsSynchronizedProperty"> + <summary> + Defines the IsSynchronized DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ChartModifierBase.ExecuteOnProperty"> + <summary> + Defines the ExecuteOn DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.CanReceiveMouseEvents"> + <summary> + Returns a value indicating whether mouse events should be propagated to the mouse target. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.ResetKeyboardFocus"> + <summary> + Sets a keyboard focus on a parent root element of the mouse target. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.IsEnabled"> + <summary> + Gets or sets a value indicating whether this element is enabled in the user interface (UI). + </summary> + <returns>true if the element is enabled; otherwise, false. The default value is true.</returns> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.IsSynchronized"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ExecuteOn"> + <summary> + Determines when the <see cref="T:SciChart.Charting.ChartModifiers.ZoomExtentsModifier" /> executes, + e.g. <see cref="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseDoubleClick" /> will cause a zoom extents on mouse double + click of the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ReceiveHandledEvents"> + <summary> + Gets or sets a value, indicates whether current modifier handles events + which have already been marked as handled + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ModifierName"> + <summary> + Gets modifier name + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.IsMouseLeftButtonDown"> + <summary> + Gets if the Left mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.IsMouseMiddleButtonDown"> + <summary> + Gets if the Middle mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.IsMouseRightButtonDown"> + <summary> + Gets of the right mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup"> + <summary> + Gets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchManipulationStarting(SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchManipulationStarted(SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchManipulationCompleted(SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs)"> + <summary> + Called when a manipulation is completed + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierTouchManipulationInertiaStarting(SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs)"> + <summary> + Called when a manipulation inertia is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to perform operations on + </summary> + <value>The parent surface.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.GetPointRelativeTo(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Transforms the input point relative to the <see cref="T:SciChart.Core.Framework.IHitTestable" /> element. Can be used to transform + points relative to the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" />, or <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxis" /> for instance. + </summary> + <param name="point">The input point</param> + <param name="relativeTo">The <see cref="T:SciChart.Core.Framework.IHitTestable" /> element to translate points relative to</param> + <returns>The output point</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.IsPointWithinBounds(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation) + </summary> + <param name="mousePoint"></param> + <param name="hitTestable"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.IsPointWithinBounds(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Determines whether the <see cref="P:SciChart.Core.Utility.Mouse.ModifierMouseArgs.MousePoint" /> is within the Viewport bounds. + Takes into account master/slave modifier relationships e.g. if the event came from + </summary> + <param name="e">The <see cref="T:SciChart.Core.Utility.Mouse.ModifierMouseArgs" /> containing mouse event data.</param> + <returns>True if the point is within bounds</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.GetRelativePosition(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + OBSOLETE + </summary> + <param name="point"></param> + <param name="relativeTo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes. Overridden in derived classes. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes. Overridden in derived classes. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes. Overridden in derived classes. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.GetSiblingModifiers``1(System.Boolean)"> + <summary> + Gets the sibling modifiers with the same <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" /> as this one + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnParentSurfaceResized(SciChart.Charting.Utility.SciChartResizedMessage)"> + <summary> + Called when the parent SciChartSurface is resized + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartResizedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.SetCursor(System.Windows.Input.Cursor)"> + <summary> + Sets the Cursor on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="cursor"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.SetZoomState(SciChart.Charting.Visuals.ZoomStates)"> + <summary> + Sets the Cursor on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnDataContextChanged(System.Object,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the DataContext of the <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> changes + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the mouse leaves the Master of current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnParentSurfaceMouseEnter"> + <summary> + Called when the mouse enters the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.OnSelectedSeriesChanged(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries},System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries})"> + <summary> + Called when the parent surface SelectedSeries collection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.MatchesExecuteOn(SciChart.Core.Utility.Mouse.MouseButtons,SciChart.Charting.ChartModifiers.ExecuteOn)"> + <summary> + Determines whether the currently pressed mouse buttons matches the <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ExecuteOn" />. Used to + filter events such as zoom or pan on right mouse button + </summary> + <param name="mouseButtons"></param> + <param name="executeOn"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.SciChart#Charting#ChartModifiers#IChartModifier#OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.SciChart#Charting#ChartModifiers#IChartModifier#OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.SciChart#Charting#ChartModifiers#IChartModifier#OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ChartModifierBase.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.CursorSnappingMode"> + <summary> + Defines the snapping modes for the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" />. It changes the way the crosshair and tooltips behave. + See <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.SnappingModeProperty" />, <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.SnapToSeriesProperty" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorSnappingMode.CrosshairToSeries"> + <summary> + Specifies that both the crosshair and the tooltips should snap to the X,Y hit location of the series, + which has <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.SnapToSeriesProperty" /> set to True. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorSnappingMode.CrosshairToSeriesX"> + <summary> + Specifies that both the crosshair and the tooltips should snap to the X-ONLY hit location of the series, + which has <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.SnapToSeriesProperty" /> set to True. + Requires that the <see cref="P:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.UseInterpolation" /> property is FALSE + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorSnappingMode.TooltipToSeries"> + <summary> + Specifies that the tooltip should snap to the hit location of the series, + which has <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.SnapToSeriesProperty" /> set to True. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorSnappingMode.TooltipToCrosshair"> + <summary> + Specifies that the tooltip should snap to the location of the crosshair. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.CursorModifier"> + <summary> + The CursorModifier provides a cross-hairs (cursor) plus tooltip with X,Y data values under the mouse as the mouse moves. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to True to enable this behaviour. + </summary> + <example> + <code title="CursorModifier usage (XAML)" description="Shows how to assign a CursorModifier to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/SciChart" --> + <s:SciChartSurface> + <s:SciChartSurface.ChartModifier> + <s:ModifierGroup> + <s:CursorModifier IsEnabled="True" ShowAxisLabels="True" + ShowTooltip="True" ShowTooltipOn="MouseOver" + SnappingMode="TooltipToSeries"/> + </s:ModifierGroup> + </s:SciChartSurface.ChartModifier> + </s:SciChartSurface> + </code> + <code title="CursorModifier usage (C#)" description="Shows how to assign a CursorModifier to a SciChartSurface in C#" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.ChartModifier = new ModifierGroup(new CursorModifier() + { + IsEnabled = true, + ShowAxisLabels = true, + ShowTooltip = true, + ShowTooltipOn = ShowTooltipOptions.MouseOver, + SnappingMode = CursorSnappingMode.TooltipToSeries, + }); + </code> + </example> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.TooltipContainerStyleProperty"> + <summary> + Defines the TooltipContainerStyle dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.TooltipTemplateProperty"> + <summary> + Defines the TooltipTemplate attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.SetTooltipTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets a DataTemplate which defines how the <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> from <paramref name="series" /> would appear inside the tooltip. + See <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetTooltipTemplate(System.Windows.DependencyObject)"> + <summary> + Gets a DataTemplate which defines how the <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> from <paramref name="series" /> would appear inside the tooltip. + See <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.ShowTooltipProperty"> + <summary> + Defines the ShowTooltip dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.AxisLabelTemplateProperty"> + <summary> + Defines the AxisLabelTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.SetAxisLabelTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets a DataTemplate which defines how the <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" /> from <paramref name="axis" /> would appear inside the axis tooltip. + See <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetAxisLabelTemplate(System.Windows.DependencyObject)"> + <summary> + Gets a DataTemplate which defines how the <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" /> from <paramref name="axis" /> would appear inside the axis tooltip. + See <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.AxisLabelContainerStyleProperty"> + <summary> + Defines the AxisLabelContainerStyle attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.SetAxisLabelContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets a style for the axis tooltip on <paramref name="axis" />. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetAxisLabelContainerStyle(System.Windows.DependencyObject)"> + <summary> + Sets a style for the axis tooltip on <paramref name="axis" />. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.AxisLabelProperty"> + <summary> + Defines the AxisLabel attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.SetAxisLabel(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Reserved for internal usage. Is used to store a cached AxisLabel. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetAxisLabel(System.Windows.DependencyObject)"> + <summary> + Reserved for internal usage. Is used to store a cached AxisLabel. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.IncludeSeriesProperty"> + <summary> + Defines the IncludeSeries attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets whether <paramref name="series" /> can be inspected by <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets whether <paramref name="series" /> can be inspected by <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.SnappingModeProperty"> + <summary> + Defines the SnappingMode dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.CursorModifier.SnapToSeriesProperty"> + <summary> + Defines the SnapToSeries attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetSnapToSeries(System.Windows.DependencyObject)"> + <summary> + Gets whether <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> is snapped to <paramref name="series" />. + See the <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.SnappingMode" /> property to configure this behavior. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.SetSnapToSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets whether <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> is snapped to <paramref name="series" />. + See the <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.SnappingMode" /> property to configure this behavior. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo"> + <summary> + Provides a collection of <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" /> structs, which may be data-bound to in the UI defined by the <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.AxisLabelTemplateProperty" /> DataTemplate. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.XAxisInfo"> + <summary> + Provides an <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" /> object, which may be data-bound to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.YAxisInfo"> + <summary> + Provides an <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" /> object, which may be data-bound to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.TooltipUsageMode"> + <summary> + Gets or sets the value which defines how to render tooltips. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.TooltipContainerStyle"> + <summary> + Gets or sets a style for the cursor tooltip. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.CursorLabelControl" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.ShowTooltip"> + <summary> + Gets or sets value, indicating whether to show the cursor tooltip or not. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.SnappingMode"> + <summary> + Gets or sets snapping mode for the crosshair and the tooltip, which specifies their location. + To snap to any series, set <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.SnapToSeriesProperty" /> on the corresponding <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.CursorModifier.HoverDelay"> + <summary> + Gets or sets delay(in milliseconds) for the tooltip to appear, if <see cref="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.ShowTooltipOnProperty" /> is set to <see cref="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.MouseHover" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetAxisLabelTemplate(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Gets the <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.AxisLabelTemplateProperty" /> DataTemplate from <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetAxisLabelContainerStyle(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Gets the <see cref="F:SciChart.Charting.ChartModifiers.CursorModifier.AxisLabelContainerStyleProperty" /> Style from <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetCachedAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns the cached axis label for <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.CacheAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches <paramref name="axisLabel" /> for <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.OnAttached"> + <summary> + Called when <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> is attached to the <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.OnDetached"> + <summary> + Called immediately before <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> is detached from the <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.OnParentSurfaceMouseEnter"> + <summary> + Called when the mouse enters the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event. + </summary> + <param name="mousePoint">The current Mouse-point.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.OnTooltipUsageModeChanged"> + <summary> + Raises when TooltipUsageMode property has been changed + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetSnappingPoint(System.Windows.Point)"> + <summary> + Given a mouse-point input, get the point to snap the cursormodifier to + </summary> + <param name="defaultLocation"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects at this point. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.GetAxesData(System.Windows.Point)"> + <summary> + Performs a hit-test on all axes and aggregates the data into <see cref="P:SciChart.Charting.ChartModifiers.CursorModifier.AxisInfo" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.ShowCrosshairCursor(System.Windows.Point,System.Boolean,System.Boolean)"> + <summary> + Draws crosshair lines. + </summary> + <param name="mousePoint">Location of the crosshair.</param> + <param name="drawHorizontalLine">Specifies whether horizontal line should be drawn.</param> + <param name="drawVerticalLine">Specifies whether vertical line should be drawn.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.HandleSlaveMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Slave <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event. + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.CursorModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" />. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.DataPointInfo"> + <summary> + Represents a single data point. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointInfo.#ctor(System.Int32,SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.ChartModifiers.DataPointInfo" />. + </summary> + <param name="dataPointIndex"></param> + <param name="renderSeries"></param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.DataPointIndex"> + <summary> + Gets the DataPointIndex of this data point inside <see cref="P:SciChart.Charting.ChartModifiers.DataPointInfo.DataSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.RenderableSeries"> + <summary> + Gets <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which this data point belongs to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.DataSeries"> + <summary> + Gets <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> which this data point belongs to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.DataSeriesName"> + <summary> + Gets the Name of the <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> which this data point belongs to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.XValue"> + <summary> + Gets the X Value of this data point. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.YValue"> + <summary> + Gets the Y Value of this data point. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointInfo.DataPointMetadata"> + <summary> + Gets <see cref="T:SciChart.Charting.Model.DataSeries.IPointMetadata" /> for the data point. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointInfo.Equals(System.Object)"> + <summary> + Compares this object instance to another object for equality. + </summary> + <param name="obj">The other object to be used in the comparison.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointInfo.Equals(SciChart.Charting.ChartModifiers.DataPointInfo)"> + <summary> + Returns <value>True</value> if <param name="other" /> is equal to the current instance. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointInfo.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.SelectionMode"> + <summary> + Defines constants which represents different selection modes of <see cref="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SelectionMode.Union"> + <summary> + Chosen points become selected. They are added to the previously selected ones. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SelectionMode.Inverse"> + <summary> + Chosen points become selected and added to the previously selected ones, except those which has been selected already. + Selection on such gets canceled. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SelectionMode.Replace"> + <summary> + Chosen points become selected and they replace the previously selected ones. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier"> + <summary> + Provides the ability to select Point Markers via a Chart Modifier + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.IncludeSeriesProperty"> + <summary> + Defines the XAxisId DependencyProperty, used to define if this series is included in DataPointSelectionModifier operations or not + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.XAxisIdProperty"> + <summary> + Defines the IncludeSeries AttachedProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectionFillProperty"> + <summary> + Defines the SelectionFiil DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectionStrokeProperty"> + <summary> + Defines the SelectionStroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.AllowsMultiSelectionProperty"> + <summary> + Defines the AllowsMultiSelection DependencyProperty + </summary> + </member> + <member name="E:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectionChanged"> + <summary> + Event raised when the selection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Gets the <see cref="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.IncludeSeriesProperty" /> attached property value, used to define if this series is included in DataPointSelectionModifier operations or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Sets the <see cref="F:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.IncludeSeriesProperty" /> attached property value, used to define if this series is included in DataPointSelectionModifier operations or not + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.XAxisId"> + <summary> + Defines which XAxis to bind the <see cref="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier" /> to, matching by string Id. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectionStroke"> + <summary> + Gets or sets the <see cref="T:System.Windows.Media.Brush" /> instance which is used to draw the border of the reticule. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectionFill"> + <summary> + Gets or sets the <see cref="T:System.Windows.Media.Brush" /> instance which is used to fill the reticule. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.AllowsMultiSelection"> + <summary> + Gets or sets whether instance of <see cref="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier" /> allows to do multiselection + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectedPointMarkers"> + <summary> + Get's an information about the points which have been selected. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.GetSelectionMode(SciChart.Core.Utility.Mouse.MouseModifier,System.Boolean)"> + <summary> + When overriden in derived classes, is used to override the default selection behavior. + </summary> + <param name="modifierKey">The modifier key which has been pressed.</param> + <param name="isAreaSelection"> + <value>True</value> when selection was performed by dragging a reticule, othetwise <value>False</value>.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectSinglePoint(System.Windows.Point,SciChart.Charting.ChartModifiers.SelectionMode)"> + <summary> + When overriden in derived classes, called to perform selection of all the PointMarkers located at mouse point. + </summary> + <param name="mousePoint">The hit-test mouse point, translated relative to <see cref="P:SciChart.Charting.ChartModifiers.ApiElementBase.ModifierSurface" />.</param> + <param name="selectionMode">Determines selection behavior.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point. + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.IsSeriesValid(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> inside the <see cref="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + <param name="series"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.IsHitPointValid(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.DeselectAllPointMarkers"> + <summary> + Deselectes all the data-points that have been selected previously. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectManyPoints(System.Windows.Point,System.Windows.Point,SciChart.Charting.ChartModifiers.SelectionMode)"> + <summary> + When overriden in derived classes, called to perform selection of all the PointMarkers located inside the rectangle, + formed by <paramref name="startPoint" /> and <paramref name="endPoint" />. + </summary> + <param name="endPoint">he mouse point where selection ended, translated relative to <see cref="P:SciChart.Charting.ChartModifiers.ApiElementBase.ModifierSurface" />.</param> + <param name="startPoint">The mouse point where selection started, translated relative to <see cref="P:SciChart.Charting.ChartModifiers.ApiElementBase.ModifierSurface" />.</param> + <param name="selectionMode">Determines selection behavior.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.UpdateState"> + <summary> + Should be called to notify <see cref="s:DataPointSelectionModifier" /> about any changes in the <see cref="s:RenderableSeries" /> collection. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.OnSelectionChanged"> + <summary> + When overriden in derived classes, called to raise the <see cref="E:SciChart.Charting.ChartModifiers.DataPointSelectionModifier.SelectionChanged" /> event. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ExecuteOn"> + <summary> + Defines constants for when a <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> operation occurs + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseLeftButton"> + <summary> + Execute on MouseRightButton + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseMiddleButton"> + <summary> + Execute on MouseRightButton + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseRightButton"> + <summary> + Execute on MouseRightButton + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseDoubleClick"> + <summary> + Execute on MouseDoubleClick + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseMove"> + <summary> + Execute on MouseMove + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.IChartModifier"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" />, which can be used to extend the interactivity or rendering of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifier.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to perform operations on + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifier.XAxis"> + <summary> + Gets the XAxis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifier.YAxes"> + <summary> + Returns the YAxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifier.YAxis"> + <summary> + Gets the primary YAxis, this is the first axis in the YAxes collection + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifier.IsSynchronized"> + <summary> + Gets or sets a value indicating whether this modifier receives events from other modifiers within the same <see cref="!:MouseManager.MouseEventGroup" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifier.GetYAxis(System.String)"> + <summary> + Gets the YAxis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> with the specified Id + </summary> + <param name="axisId">The Id of the axis to get</param> + <returns>The Axis instance</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifier.IsPointWithinBounds(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation) + </summary> + <param name="mousePoint"></param> + <param name="hitTestable"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifier.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifier.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifier.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifier.OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.IChartModifierBase"> + <summary> + A Base interface for common shared properties between ChartModifiers in the 2D and 3D SciChart libraries + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifierBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifierBase.ModifierSurface"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, which acts as a canvas to place UIElements + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifierBase.ModifierName"> + <summary> + Gets modifier name + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifierBase.IsAttached"> + <summary> + Gets or sets whether this Chart Modifier is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifierBase.DataContext"> + <summary> + Gets or sets the DataContext for this Chart Modifier + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IChartModifierBase.ReceiveHandledEvents"> + <summary> + If true, this <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" /> can receive handled events. Chart modifiers work similarly to mouse event handlers in WPF and Silverlight. If a modifier + further up the stack receives an event and handles it, then subsequent modifiers do not receive the event. This property overrides this behaviour. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifierBase.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IChartModifierBase.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.InertialZoomPanModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.InertialZoomPanModifier" /> provides a mouse drag to pan the X and Y axes. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InertialZoomPanModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.InertialZoomPanModifier" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InertialZoomPanModifier.Pan(System.Windows.Point,System.Windows.Point,System.Windows.Point)"> + <summary> + Receives zoom command from the user. + </summary> + <param name="currentPoint">Current point of zoom gesture.</param> + <param name="lastPoint">Previous point of zoom gesture.</param> + <param name="startPoint">Start point of zoom gesture.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InertialZoomPanModifier.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.SourceMode"> + <summary> + Defines constants for different series sources in <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SourceMode.AllSeries"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase" /> uses All Series as inputs + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SourceMode.AllVisibleSeries"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase" /> uses All Visible Series as inputs + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SourceMode.SelectedSeries"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase" /> uses Selected series as inputs + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SourceMode.UnselectedSeries"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase" /> uses Unselected series as inputs + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase"> + <summary> + An abstract base class which factors out handling of Axis and Chart Label templates which are shared in the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" />. + </summary> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.UseInterpolationProperty"> + <summary> + Defines the UseInterpolation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.SourceModeProperty"> + <summary> + Defines the RolloverMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.SeriesDataProperty"> + <summary> + Defines the SeriesData Dependency property which you may bind to in your applications to show cursor updates on mouse-move + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.CurrentPoint"> + <summary> + The Current MousePoint on the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase._isMaster"> + <summary> + Indicates whether the current modifier is master + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase._isInMasterBounds"> + <summary> + Indicates whether the current modifier is inside the master bounds + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase._master"> + <summary> + Defines the master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.SeriesData"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Model.ChartData.ChartDataObject" /> which may be bound to, to provide feedback to the user of cursor updates + </summary> + <value>The series data.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.UseInterpolation"> + <summary> + Gets or sets whether the interaction should use interpolation + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.SourceMode"> + <summary> + Gets or sets type of series on which interaction is performed + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.HandleMouseEvent(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + General logic for processing mouse events + </summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.HandleSlaveMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Slave <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.HitTestAxis(SciChart.Charting.Visuals.Axes.IAxis,System.Windows.Point)"> + <summary> + Performs hit-test on <paramref name="axis" />, used internally by modifiers + </summary> + <param name="axis"></param> + <param name="atPoint"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point,System.Double)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + <param name="point"></param> + <param name="hitTestRadius"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Func{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo})"> + <summary> + Called internally, gets the SeriesInfo on all RenderableSeries using the provided hit-test function + </summary> + <param name="hitTestMethod">The hit-test function</param> + <returns>The SeriesInfo list</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.IsHitPointValid(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.IsSeriesValid(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> inside the <see cref="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.LegendPlacement"> + <summary> + Enumeration constants to define label placement + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.TopLeft"> + <summary> + Places at the upper left corner + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.TopRight"> + <summary> + Places at the upper right corner + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.BottomLeft"> + <summary> + Places at the bottom left corner + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.BottomRight"> + <summary> + Places at the bottom right corner + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.Top"> + <summary> + Places above the surface + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.Bottom"> + <summary> + Places below the surface + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.Left"> + <summary> + Places to the left of the surface + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.Right"> + <summary> + Places to the right of the surface + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendPlacement.Inside"> + <summary> + Places inside the ParentSurface + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.LegendModifier"> + <summary> + Defines a custom chart modifier which shows a Legend on the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and also can provide a data-source via <see cref="F:SciChart.Charting.ChartModifiers.LegendModifier.LegendDataProperty" /> + which provides a collection of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> ViewModels which bind to items in the legend control + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.LegendDataProperty"> + <summary> + Defines the LegendData DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.GetLegendDataForProperty"> + <summary> + Defines the GetLegendDataFor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.LegendPlacementProperty"> + <summary> + Defines the LegendPlacement DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.LegendItemTemplateProperty"> + <summary> + Defines the LegendTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.OrientationProperty"> + <summary> + Defines the LegendOrientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.ShowSeriesMarkersProperty"> + <summary> + Defines the ShowSeriesMarkers DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.ShowVisibilityCheckboxesProperty"> + <summary> + Defines the ShowVisibilityCheckboxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegendProperty"> + <summary> + Defines the ShowLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.LegendTemplateProperty"> + <summary> + Defines the SciChartLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.LegendModifier.IncludeSeriesProperty"> + <summary> + Defined IncludeSeries Attached Property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.LegendModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowVisibilityCheckboxes"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. If true, shows the Visibility Checkboxes in the automatically generated legend. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowSeriesMarkers"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. If true, shows the Series Markers in the automatically generated legend + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.LegendPlacement"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. Defines the placement of the auto-generated legend + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.LegendItemTemplate"> + <summary> + Gets or sets the Legend Item Template, which provides UI that binds to a single <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> instance. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.LegendData"> + <summary> + The LegendData object provides a collection of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> which can be bound to in ItemsControls or SciChartLegend control. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.Orientation"> + <summary> + Gets or sets the Orientation of the Legend Items, e.g. Vertical, or Horizontal + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend"> + <summary> + If true, then the LegendModifier automatically shows and hosts a <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> inside the chart surface, according to <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.LegendPlacement" />. If false, then the user may provide an alternative legend control + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.LegendTemplate"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. An optional control template for the auto-generated <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> control + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.LegendModifier.GetLegendDataFor"> + <summary> + Gets or sets an enumeration constant defining which series to interrogate for the legend data source + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.HandleSlaveMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Slave <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.UpdateLegend"> + <summary> + Refreshes the legend with up-to-date <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> with series names, latest values + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.IsSeriesValid(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> + inside the <see cref="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + <param name="series"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.GetSeriesInfo(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries})"> + <summary> + Gets the SeriesInfo for all the RenderableSeries passed in + </summary> + <param name="allSeries"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.LegendModifier.FillWithIncludedSeries(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.SeriesInfo},System.Collections.ObjectModel.ObservableCollection{SciChart.Charting.Model.ChartData.SeriesInfo})"> + <summary> + Fills <paramref name="seriesInfos" /> collection with series info which are included to modifier + </summary> + <param name="infos">The input SeriesInfo collection</param> + <param name="seriesInfos">The output SeriesInfo collection</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier"> + <summary> + Provides a base class for Linked Chart Modifiers. Classes that inherit this allow mouse events and interaction to occur across Chart Panes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled + </summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveChartModifier.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled + </summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MasterSlaveTernaryChartModifier.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierGroup"> + <summary> + Allows a collection of modifiers to be set on the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.ChartModifier" /> property. Child modifiers are stored in the + <see cref="P:SciChart.Charting.ChartModifiers.ModifierGroup.ChildModifiers" /> collection, which is backed by a DependencyProperty so may be bound to in Xaml. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ModifierGroup.ChildModifiersProperty"> + <summary> + Defines the ChildModifiers DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.#ctor(SciChart.Charting.ChartModifiers.IChartModifier[])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> class. + </summary> + <param name="childModifiers">The child modifier collection.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierGroup.ChildModifiers"> + <summary> + Gets or sets a collection of child modifiers in this group + </summary> + <value>The child modifiers.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierGroup.Item(System.String)"> + <summary> + Gets the <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" /> with the specified name. + </summary> + <value> + The <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" />. + </value> + <param name="name">The name.</param> + <returns></returns> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierGroup.Item(System.Int32)"> + <summary> + Gets the <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" /> at the specified index. + </summary> + <value> + The <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" />. + </value> + <param name="index">The index.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the mouse leaves the Master of current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchManipulationStarting(SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchManipulationStarted(SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchManipulationCompleted(SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs)"> + <summary> + Called when a manipulation is completed + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierTouchManipulationInertiaStarting(SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs)"> + <summary> + Called when a manipulation inertia is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.HasModifier(System.Type)"> + <summary> + Determines whether the current <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> has a child modifier of the desired type + </summary> + <param name="desiredType">The type of child modifier to search for</param> + <returns> + <c>true</c> if the current <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> has a chlid modifier by this type; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierGroup.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier" /> provides zooming (or shrinking) of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> on mouse wheel scroll + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier.ActionTypeProperty"> + <summary> + Defines the ActionType DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier.ActionType"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier.ActionType" /> to perform on mouse-wheel interaction + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier.OverrideKeyboardAction(SciChart.Core.Utility.Mouse.MouseModifier)"> + <summary> + Overrides Modifier action when a specific Modifier Key is pressed. + </summary> + <param name="btn">Pressed <see cref="T:SciChart.Core.Utility.Mouse.MouseModifier" /> key.</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.NullModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.NullModifier" /> can be attached to consume mouse events but perform no action + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.PinchZoomModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.PinchZoomModifier" /> provides zooming of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> with the pinch gesture + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.PinchZoomModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.PinchZoomModifier" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.PinchZoomModifier.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.IRadarChartModifier"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.ChartModifiers.RadarChartModifierBase" />, which can be used to extend the interactivity or rendering of the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IRadarChartModifier.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> to perform operations on. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IRadarChartModifier.ModifierSurface"> + <summary> + Gets the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />, which acts as a canvas to place UIElements. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.IRadarChartModifier.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> instance. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IRadarChartModifier.OnDetached"> + <summary> + Called immediately before a modifier gets detached from a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.IRadarChartModifier.OnAttached"> + <summary> + Called when a modifier gets attached to a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RadarChartModifierBase"> + <summary> + Defines the base class for all chart modifiers, which can be used to extend the interactivity or rendering of a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarChartModifierBase.ModifierSurface"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />, which acts as a canvas to place UIElements. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarChartModifierBase.Services"> + <summary> + Gets or sets a <see cref="T:SciChart.Core.Utility.IServiceContainer" /> container. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarChartModifierBase.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> to perform operations on. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.CanReceiveMouseEvents"> + <summary> + Returns a value indicating whether mouse events should be propagated to the mouse target. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.ResetKeyboardFocus"> + <summary> + Sets a keyboard focus on a parent root element of the mouse target. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarChartModifierBase.MouseEventGroup"> + <summary> + Gets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierMouseEnter(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is entered the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is left the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary>TODO + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.RadarChartModifierBase.MouseEventGroup" /><param name="e">Arguments detailing the key event</param></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary>TODO + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.RadarChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnAttached"> + <summary> + Called when a modifier gets attached to a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnDetached"> + <summary> + Called immediately before a modifier gets detached from a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.OnInvalidateParentSurface"> + <summary> + Raises the <see cref="T:SciChart.Charting.Utility.InvalidateSciChartMessage" /> which causes the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> to invalidate. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarChartModifierBase.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RadarDataPointSelectionModifier"> + <summary></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarDataPointSelectionModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Is called in response to the <see cref="E:System.Windows.UIElement.MouseDown" /> event. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarDataPointSelectionModifier.GetSeriesInfo(System.Windows.Point)"> + <summary></summary> + <param name="mousePoint"></param> + <returns></returns> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarDragDataPointModifier.IsDragging"> + <summary> + Gets whether the user is currently dragging the chart + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RadarLegendModifier"> + <summary> + Defines a custom chart modifier which shows a Legend on the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> and also can provide a data-source + which provides a collection of <see cref="T:SciChart.Charting.Model.ChartData.RadarSeriesInfo" /> ViewModels which bind to items in the legend control + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.OrientationProperty"> + <summary> + Defines the Orientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendPlacementProperty"> + <summary> + Defines the LegendPlacement DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendItemTemplateProperty"> + <summary> + Defines the LegendItemTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendTemplateProperty"> + <summary> + Defines the SciChartLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowLegendProperty"> + <summary> + Defines the ShowLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowVisibilityCheckboxesProperty"> + <summary> + Defines the ShowVisibilityCheckboxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowSeriesMarkersProperty"> + <summary> + Defines the ShowSeriesMarkers DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.SourceModeProperty"> + <summary> + Defines the RolloverMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendDataProperty"> + <summary> + Defines the SeriesData Dependency property which you may bind to in your applications to show cursor updates on mouse-move + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarLegendModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.RadarLegendModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendData"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Model.ChartData.RadarChartDataObject" /> which may be bound to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendTemplate"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. An optional control template for the auto-generated <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> control + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.Orientation"> + <summary> + Gets or sets the Orientation of the Legend Items, e.g. Vertical, or Horizontal + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowLegend"> + <summary> + If true, then the RadarLegendModifier automatically shows and hosts legend inside the chart surface, according to <see cref="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendPlacement" />. If false, then the user may provide an alternative legend control + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowSeriesMarkers"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. If true, shows the Series Markers in the automatically generated legend + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowVisibilityCheckboxes"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. If true, shows the Visibility Checkboxes in the automatically generated legend. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendItemTemplate"> + <summary> + Gets or sets template for legend items + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.LegendPlacement"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.ShowLegend" /> = true. Defines the placement of the auto-generated legend + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarLegendModifier.SourceMode"> + <summary></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarLegendModifier.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarLegendModifier.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier"> + <summary> + Provides the ability to select a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> with a mouse-click. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.ExecuteWhenProperty"> + <summary> + Defines the ExecuteWhen DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.AllowsMultiSelectionProperty"> + <summary> + Defines the AllowsMultiSelection DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.AllowsMultiSelection"> + <summary> + Gets or sets whether instance of <see cref="T:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier" /> allows to do multiselection + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.ExecuteWhen"> + <summary> + Determines which keyboard modifiers filter when the <see cref="T:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier" /> executes, + e.g. <see cref="F:SciChart.Core.Utility.Mouse.MouseModifier.Shift" /> will cause the modifier to only work if SHIFT is pressed + when the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> is focussed + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.OnAttached"> + <summary> + Called when a modifier gets attached to a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.OnDetached"> + <summary> + Called immediately before a modifier gets detached from a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarSeriesSelectionModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RadarTooltipModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.RadarTooltipModifier" /> provides a mouse-over tooltip to a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />, outputting a single <see cref="T:SciChart.Charting.Model.ChartData.RadarSeriesInfo" /> object to bind to, which updates as the mouse moves over data-points. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarTooltipModifier.TooltipTemplateProperty"> + <summary> + Defines the RadarTooltipTemplate DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarTooltipModifier.ShowTooltipProperty"> + <summary> + Defines the ShowTooltip DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarTooltipModifier.TooltipContainerStyleProperty"> + <summary> + Defines the TooltipContainerStyle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarTooltipModifier.StikerLineStyleProperty"> + <summary> + Defines the StikerLineStyle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RadarTooltipModifier.SnappingModeProperty"> + <summary> + Defines the SnappingMode DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarTooltipModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.RadarTooltipModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarTooltipModifier.TooltipContainerStyle"> + <summary> + Gets or sets a container style for the tooltip. See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarTooltipControl" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarTooltipModifier.ShowTooltip"> + <summary> + Gets or sets the value indicating whether to show the tooltip over a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RadarTooltipModifier.TooltipTemplate"> + <summary> + Gets or sets a data template for the tooltip. See <see cref="T:SciChart.Charting.Model.ChartData.IRadarSeriesInfo" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarTooltipModifier.GetNearestDataPointSeriesInfo(System.Windows.Point)"> + <summary></summary> + <param name="mousePoint"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarTooltipModifier.OnAttached"> + <summary> + Called when a modifier gets attached to a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RadarTooltipModifier.OnDetached"> + <summary> + Called immediately before a modifier gets detached from a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase"> + <summary> + Defines the base class to modifiers which performs relative zoom, such as the <see cref="T:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.PinchZoomModifier" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase.XyDirectionProperty"> + <summary> + Defines the XyDirection dependency property + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase.XyDirection"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase.XyDirection" /> to restrict zoom interactivity to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase.GrowFactor"> + <summary> + Gets or sets the grow factor to scale (or shrink) both axes on mouse wheel + </summary> + <value>The grow factor.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase.PerformZoom(System.Windows.Point,System.Double,System.Double)"> + <summary> + Performs a zoom on all X and Y Axis around the <paramref name="mousePoint" /> by the specified X and Y factor + </summary> + <param name="mousePoint">The mouse point.</param> + <param name="xValue">The x zoom factor.</param> + <param name="yValue">The y zoom factor.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RelativeZoomModifierBase.GrowBy(System.Windows.Point,SciChart.Charting.Visuals.Axes.IAxis,System.Double)"> + <summary> + Performs a zoom on a specific axis around the <paramref name="mousePoint" /> by the specified scale factor + </summary> + <param name="mousePoint">The mouse point.</param> + <param name="axis">The axis.</param> + <param name="fraction">The scale factor.</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RolloverModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> provides a mouse-over hit-test to a chart, plus a collection of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects to bind to which updates as the mouse moves. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + <example> + <code title="RolloverModifier usage (XAML)" description="Shows how to assign a RolloverModifier to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/SciChart" --> + <s:SciChartSurface> + <s:SciChartSurface.ChartModifier> + <s:ModifierGroup> + <s:RolloverModifier IsEnabled="True" DrawVerticalLine="True" + ShowTooltipOn="Always" SourceMode="AllSeries"/> + </s:ModifierGroup> + </s:SciChartSurface.ChartModifier> + </s:SciChartSurface> + </code> + <code title="RolloverModifier usage (C#)" description="Shows how to assign a RolloverModifier to a SciChartSurface in C#" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.ChartModifier = new ModifierGroup(new RolloverModifier() + { + IsEnabled = true, + ShowTooltipOn = ShowTooltipOptions.Always, + DrawVerticalLine = true, + SourceMode = SourceMode.AllSeries, + }); + </code> + </example> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.TooltipTemplateProperty"> + <summary> + Defines TooltipTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.SetTooltipTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets TooltipTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetTooltipTemplate(System.Windows.DependencyObject)"> + <summary> + Gets TooltipTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.TooltipContainerStyleProperty"> + <summary> + Defines TooltipContainerStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.SetTooltipContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets TooltipContainerStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetTooltipContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets TooltipContainerStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.AxisLabelProperty"> + <summary> + Defines AxisLabel attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.SetAxisLabel(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Sets AxisLabel Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetAxisLabel(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabel Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.AxisLabelTemplateProperty"> + <summary> + Defines AxisLabelTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.SetAxisLabelTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets AxisLabelTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetAxisLabelTemplate(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabelTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.AxisLabelContainerStyleProperty"> + <summary> + Defines AxisLabelStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.SetAxisLabelContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Gets AxisLabelStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetAxisLabelContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabelStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.IncludeSeriesProperty"> + <summary> + Defined IncludeSeries Attached Property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the include Series or not + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RolloverModifier.DrawVerticalLineProperty"> + <summary> + Defines the DrawVerticalLine DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RolloverModifier.TooltipUsageMode"> + <summary> + Gets or sets the value which defines how to render tooltips. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RolloverModifier.DrawVerticalLine"> + <summary> + Gets or sets whether a Vertical Line should be drawn at the rollover location + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetTooltipItemTemplate(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Returns Tooltip DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetTooltipStyle(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Returns Tooltip Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetAxisLabelTemplate(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetAxisLabelContainerStyle(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetCachedAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns axis label cached in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.CacheAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.FillWithIncludedSeries(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.SeriesInfo},System.Collections.ObjectModel.ObservableCollection{SciChart.Charting.Model.ChartData.SeriesInfo})"> + <summary> + Fills <paramref name="seriesInfos" /> collection with series info which are included to modifier + </summary> + <param name="infos">The input SeriesInfo collection</param> + <param name="seriesInfos">The output SeriesInfo collection</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetRolloverMarkerFrom(SciChart.Charting.Model.ChartData.SeriesInfo)"> + <summary> + Get rollover marker from <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> to place on chart + </summary> + <param name="seriesInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.OnSelectedSeriesChanged(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries},System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries})"> + <summary> + Called when the parent surface SelectedSeries collection changes + </summary> + <param name="oldSeries"></param> + <param name="newSeries"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.OnTooltipUsageModeChanged"> + <summary> + Raises when TooltipUsageMode property has been changed + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to get the splitted SeriesInfo for the current point + </summary> + <param name="point">The current Mouse-point</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.UpdateTooltipLabels(System.Collections.Generic.IEnumerable{System.Windows.FrameworkElement})"> + <summary> + Updates Rollover labels. + </summary> + <param name="overlappedMarkers">Markers collection</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RolloverModifier.ClearTooltipLabels"> + <summary> + Removes all tooltip labels + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier" /> provides a mouse drag to zoom into a rectangular region, or horizontal section of the chart. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.IsAnimatedProperty"> + <summary> + Defines the IsAnimated DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.RubberBandFillProperty"> + <summary> + Defines the RubberBandFill dependency property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.RubberBandStrokeProperty"> + <summary> + Defines the RubberBandStroke dependency property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.RubberBandStrokeDashArrayProperty"> + <summary> + Defines the RubberBandStrokeDashArray dependency property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.IsXAxisOnlyProperty"> + <summary> + Defines the IsXAxisOnly dependency property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.ZoomExtentsYProperty"> + <summary> + Defines the ZoomExtentsY DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.MinDragSensitivityProperty"> + <summary> + Defines the MinDragSensitivity DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.IsAnimated"> + <summary> + Gets or sets whether zoom operations should be animated. Default true + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.RubberBandFill"> + <summary> + Gets or sets the Fill brush of the recticule drawn on the screen as the user zooms + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.RubberBandStroke"> + <summary> + Gets or sets the Stroke brush of the recticule drawn on the screen as the user zooms + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.RubberBandStrokeDashArray"> + <summary> + Gets or sets the StrokeDashArray, used to set a dashed outline for the rubber band rectangle. + See the <see cref="P:System.Windows.Shapes.Shape.StrokeDashArray" /> property for usage + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.IsXAxisOnly"> + <summary> + Gets or sets whether the RubberBand should zoom the X-Axis only. + If true, then the effect will be instead of a rectangle drawn under the mouse, an horizontal section of the + entire chart will be selected + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.ZoomExtentsY"> + <summary> + If true, zooms to extents on the Y-Axis on each zoom operation. Use in conjuction with <see cref="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.IsXAxisOnly" /> to achieve different zooming effects + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.MinDragSensitivity"> + <summary> + Gets or sets the drag sensitivity - rectangles dragged smaller than this size in the diagonal will be ignored when zooming. Default is 10 pixels + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.IsDragging"> + <summary> + Gets whether the user is currently dragging the mouse + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnDetached"> + <summary> + Called when the Chart Modifier is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> or mouse capture is lost. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier.PerformZoom(System.Windows.Point,System.Windows.Point)"> + <summary> + Performs the zoom operation from the Start mouse point (screen coordinate) to the End mouse point (screen coordinate) + </summary> + <param name="startPoint">The start mouse point in screen coordinates.</param> + <param name="endPoint">The end mouse point in screen coordinates.</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.SeriesSelectionModifier"> + <summary> + Provides the ability to select series via a Chart Modifier + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SelectedSeriesStyleProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SelectedSeriesStyle" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.IncludeSeriesProperty"> + <summary> + Defines the <see cref="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)" /> AttachedProperty + </summary> + </member> + <member name="E:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SelectionChanged"> + <summary> + Event raised when the selection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.SeriesSelectionModifier" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets whether this series is included in SeriesSelection operations. Default true + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.GetIncludeSeries(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Gets whether this series is included in SeriesSelection operations. Default true + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SelectedSeriesStyle"> + <summary> + Gets or sets a style for selected series. + </summary> + <value>The style of the selected series.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.OnSelectedSeriesChanged(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries},System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries})"> + <summary> + Called when the parent surface SelectedSeries collection changes + </summary> + <param name="oldSeries"></param> + <param name="newSeries"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.HandleSlaveMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Slave <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.DeselectAllBut(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Deselects all selected series except for passed series + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.PerformSelection(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Tries to apply selection for the series + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.DeselectAll"> + <summary> + Deselects all selected series + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.TrySetStyle(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Tries to apply <see cref="P:SciChart.Charting.ChartModifiers.SeriesSelectionModifier.SelectedSeriesStyle" /> for the series + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.SeriesValueModifier"> + <summary> + A custom <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> which places an <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> on the YAxis for each + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> in the chart, showing the current <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> latest Y-value. + + E.g. for each series, place one axis-marker with the latest Y-value of the series + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.AxisMarkerStyleProperty"> + <summary> + The axis marker style DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.YAxisIdProperty"> + <summary> + Defines the YAxisId DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IncludeSeriesProperty"> + <summary> + The IsSeriesValueModifier DependencyProperty. When Set to True on a RenderableSeries, this series will be included in the SeriesValueModifier processing, else it will be excluded + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.SetIncludeSeries(System.Windows.UIElement,System.Boolean)"> + <summary> + Sets the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IncludeSeriesProperty" /> Attached Property property on the element. + When Set to True on a RenderableSeries, this series will be included in the SeriesValueModifier processing, else it will be excluded + </summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> this series will be included in the SeriesValueModifier processing, else it will be excluded.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.GetIncludeSeries(System.Windows.UIElement)"> + <summary> + Gets the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IncludeSeriesProperty" /> property on the element. + When Set to True on a RenderableSeries, this series will be included in the SeriesValueModifier processing, else it will be excluded + </summary> + <param name="element">The element.</param> + <returns>if set to <c>true</c> this series will be included in the SeriesValueModifier processing, else it will be excluded.</returns> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IsRenderableSeriesInViewportProperty"> + <summary> + Defines the IsRenderableSeriesInViewport attached property. It is used to hide the AxisMarker associated with a renderable series when it goes outside the viewport. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.GetIsRenderableSeriesInViewport(System.Windows.DependencyObject)"> + <summary> + Gets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IsRenderableSeriesInViewportProperty" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.SetIsRenderableSeriesInViewport(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Gets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IsRenderableSeriesInViewportProperty" /></summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IsLastPointInViewportProperty"> + <summary> + Defines the IsLastPointInViewportProperty attached property. It is used to change the opacity of AxisMarker + associated with a renderable series when the last point it goes outside the viewport. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.GetIsLastPointInViewport(System.Windows.DependencyObject)"> + <summary> + Gets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IsLastPointInViewportProperty" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.SetIsLastPointInViewport(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.IsLastPointInViewportProperty" /></summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.SeriesMarkerStrokeProperty"> + <summary> + Defines the SeriesMarkerStroke attached property. Holds the stroke color of the last visible bar in a viewport for a RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.GetSeriesMarkerStroke(System.Windows.DependencyObject)"> + <summary> + Gets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.SeriesMarkerStrokeProperty" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.SetSeriesMarkerStroke(System.Windows.DependencyObject,System.Windows.Media.Color)"> + <summary> + Sets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.SeriesMarkerStrokeProperty" /></summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.SeriesMarkerFillProperty"> + <summary> + Defines the SeriesMarkerFill attached property. Holds the color of the last visible bar in a viewport for a RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.GetSeriesMarkerFill(System.Windows.DependencyObject)"> + <summary> + Gets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.SeriesMarkerFillProperty" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.SetSeriesMarkerFill(System.Windows.DependencyObject,System.Windows.Media.Brush)"> + <summary> + Sets the value of the <see cref="F:SciChart.Charting.ChartModifiers.SeriesValueModifier.SeriesMarkerFillProperty" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.SeriesValueModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.SeriesValueModifier.AnnotationsBySeries"> + <summary> + Stores <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> instances keyed by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.SeriesValueModifier.AxisMarkerStyle"> + <summary> + Gets or sets a Style to apply to Axis Markers. + See remarks for implementation + </summary> + <remarks> + NOTE: If you intend to override the AxisMarkerStyle, assume the DataContext is the RenderableSeries and you should include bindings of AxisMarker.Y1 to the RenderableSeries.DataSeries.LatestValue</remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.SeriesValueModifier.YAxisId"> + <summary> + Defines which YAxis to bind the <see cref="T:SciChart.Charting.ChartModifiers.SeriesValueModifier" /> to, matching by string Id + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.SeriesValueModifier" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.SeriesValueModifier.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ITernaryChartModifier"> + <summary> + A Base interface for common shared properties between ChartModifiers in Ternary SciChart libraries + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ITernaryChartModifier.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> to perform operations on + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ITernaryChartModifier.XAxis"> + <summary> + Gets the XAxis <see cref="T:SciChart.Charting.Visuals.Axes.ITernaryAxis" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ITernaryChartModifier.YAxis"> + <summary> + Gets the primary YAxis, this is the first axis in the YAxes collection + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ITernaryChartModifier.ZAxis"> + <summary> + Gets the primary YAxis, this is the first axis in the YAxes collection + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ITernaryChartModifier.IsPointWithinBounds(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation) + </summary> + <param name="mousePoint"></param> + <param name="hitTestable"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ITernaryChartModifier.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ITernaryChartModifier.OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase"> + <summary> + Defines the base class to a Chart Modifier, which can be used to extend the interactivity or rendering of the <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryModifierGroup" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ReceiveHandledEventsProperty"> + <summary> + Defines the ReceiveHandledEvents DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsEnabledProperty"> + <summary> + Defines the IsEnabled Attached Property + </summary> + </member> + <member name="E:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.PropertyChanged"> + <summary> + Occurs when a property changes in the <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> to perform operations on + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.YAxis"> + <summary> + Gets the YAxis instance + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.XAxis"> + <summary> + Gets the XAxis instance + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ZAxis"> + <summary> + Gets the YAxis instance + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ModifierSurface"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" />, which acts as a canvas to place UIElements + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsAttached"> + <summary> + Gets or sets whether this Element is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <value> + <c>true</c> if this instance is attached; otherwise, <c>false</c>.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.RootGrid"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IMainGrid" /> which is the root component for the <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" />, + containing the XAxis, YAxes, ZAxes, ModifierSurface, RenderSurface and GridLinesPanel + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnInvalidateParentSurface"> + <summary> + Raises the <see cref="T:SciChart.Charting.Utility.InvalidateSciChartMessage" /> which causes the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> to invalidate + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnPropertyChanged(System.String)"> + <summary> + Raises the PropertyChanged event, as part of <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.CanReceiveMouseEvents"> + <summary> + Returns a value indicating whether mouse events should be propagated to the mouse target. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ResetKeyboardFocus"> + <summary> + Sets a keyboard focus on a parent root element of the mouse target. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsEnabled"> + <summary> + Gets or sets a value indicating whether this element is enabled in the user interface (UI). + </summary> + <returns>true if the element is enabled; otherwise, false. The default value is true.</returns> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ReceiveHandledEvents"> + <summary> + Gets or sets a value, indicates whether current modifier handles events + which have already been marked as handled + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ModifierName"> + <summary> + Gets modifier name + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsMouseLeftButtonDown"> + <summary> + Gets if the Left mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsMouseMiddleButtonDown"> + <summary> + Gets if the Middle mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsMouseRightButtonDown"> + <summary> + Gets of the right mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup"> + <summary> + Gets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchManipulationStarting(SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchManipulationStarted(SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchManipulationCompleted(SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs)"> + <summary> + Called when a manipulation is completed + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierTouchManipulationInertiaStarting(SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs)"> + <summary> + Called when a manipulation inertia is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.TernaryAxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.GetPointRelativeTo(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Transforms the input point relative to the <see cref="T:SciChart.Core.Framework.IHitTestable" /> element. Can be used to transform + points relative to the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" />, or <see cref="P:SciChart.Charting.Visuals.SciChartTernarySurface.XAxis" /> for instance. + </summary> + <param name="point">The input point</param> + <param name="relativeTo">The <see cref="T:SciChart.Core.Framework.IHitTestable" /> element to translate points relative to</param> + <returns>The output point</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsPointWithinBounds(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation) + </summary> + <param name="mousePoint"></param> + <param name="hitTestable"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.IsPointWithinBounds(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Determines whether the <see cref="P:SciChart.Core.Utility.Mouse.ModifierMouseArgs.MousePoint" /> is within the Viewport bounds. + Takes into account master/slave modifier relationships e.g. if the event came from + </summary> + <param name="e">The <see cref="T:SciChart.Core.Utility.Mouse.ModifierMouseArgs" /> containing mouse event data.</param> + <returns>True if the point is within bounds</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.GetRelativePosition(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + OBSOLETE + </summary> + <param name="point"></param> + <param name="relativeTo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes. Overridden in derived classes. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnParentSurfaceResized(SciChart.Charting.Utility.SciChartResizedMessage)"> + <summary> + Called when the parent SciChartSurface is resized + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartResizedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.SetCursor(System.Windows.Input.Cursor)"> + <summary> + Sets the Cursor on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="cursor"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnDataContextChanged(System.Object,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the DataContext of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> changes + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the mouse leaves the Master of current <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup" /></summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnParentSurfaceMouseEnter"> + <summary> + Called when the mouse enters the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.OnSelectedSeriesChanged(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries},System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries})"> + <summary> + Called when the parent surface SelectedSeries collection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.SciChart#Charting#ChartModifiers#ITernaryChartModifier#OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier"> + <summary> + The TernaryCursorModifier provides a cross-hairs (cursor) plus tooltip with X, Y and Z data values under the mouse as the mouse moves. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> and set IsEnabled to True to enable this behaviour. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryCursorModifier.AxisLabelTemplateProperty"> + <summary> + Defines the AxisLabelTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.SetAxisLabelTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets a DataTemplate which defines how the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> from <paramref name="axis" /> would appear inside the axis tooltip. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.GetAxisLabelTemplate(System.Windows.DependencyObject)"> + <summary> + Gets a DataTemplate which defines how the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> from <paramref name="axis" /> would appear inside the axis tooltip. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryCursorModifier.AxisLabelContainerStyleProperty"> + <summary> + Defines the AxisLabelContainerStyle attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.SetAxisLabelContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets a style for the axis tooltip on <paramref name="axis" />. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.GetAxisLabelContainerStyle(System.Windows.DependencyObject)"> + <summary> + Sets a style for the axis tooltip on <paramref name="axis" />. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryCursorModifier.AxisLabelProperty"> + <summary> + Defines the AxisLabel attached property. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.SetAxisLabel(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Reserved for internal usage. Is used to store a cached AxisLabel. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.GetAxisLabel(System.Windows.DependencyObject)"> + <summary> + Reserved for internal usage. Is used to store a cached AxisLabel. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryCursorModifier.XAxisInfo"> + <summary> + Provides an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> object, which may be data-bound to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryCursorModifier.ZAxisInfo"> + <summary> + Provides an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> object, which may be data-bound to. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryCursorModifier.YAxisInfo"> + <summary> + Provides an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> object, which may be data-bound to. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.GetLabelOnAxisTemplate(SciChart.Charting.Visuals.Axes.TernaryAxisBase)"> + <summary> + Gets the <see cref="F:SciChart.Charting.ChartModifiers.TernaryCursorModifier.AxisLabelTemplateProperty" /> DataTemplate from <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.GetLabelOnAxisContainerStyle(SciChart.Charting.Visuals.Axes.TernaryAxisBase)"> + <summary> + Gets the <see cref="F:SciChart.Charting.ChartModifiers.TernaryCursorModifier.AxisLabelContainerStyleProperty" /> Style from <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.GetCachedAxisLabel(SciChart.Charting.Visuals.Axes.TernaryAxisBase)"> + <summary> + Returns the cached axis label for <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.CacheAxisLabel(SciChart.Charting.Visuals.Axes.TernaryAxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches <paramref name="axisLabel" /> for <paramref name="axis" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.OnAttached"> + <summary> + Called when <see cref="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier" /> is attached to the <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ParentSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.OnDetached"> + <summary> + Called immediately before <see cref="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier" /> is detached from the <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ParentSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.OnParentSurfaceMouseEnter"> + <summary> + Called when the mouse enters the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> MouseMove event. + </summary> + <param name="mousePoint">The current Mouse-point.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryCursorModifier.ClearAxesOverlay"> + <summary> + Clears Axis Overlays on the X and Y Axes + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TernaryLegendModifier"> + <summary> + Defines a custom chart modifier which shows a Legend on the <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> and also can provide a data-source via <see cref="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendDataProperty" /> + which provides a collection of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> ViewModels which bind to items in the legend control + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendDataProperty"> + <summary> + Defines the LegendData DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.GetLegendDataForProperty"> + <summary> + Defines the GetLegendDataFor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendPlacementProperty"> + <summary> + Defines the TernaryLegendPlacement DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendItemTemplateProperty"> + <summary> + Defines the LegendTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.OrientationProperty"> + <summary> + Defines the LegendOrientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowSeriesMarkersProperty"> + <summary> + Defines the ShowSeriesMarkers DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowVisibilityCheckboxesProperty"> + <summary> + Defines the ShowVisibilityCheckboxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowLegendProperty"> + <summary> + Defines the ShowLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendTemplateProperty"> + <summary> + Defines the LegendTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryLegendModifier.SeriesDataProperty"> + <summary> + Defines the SeriesData Dependency property which you may bind to in your applications to show cursor updates on mouse-move + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryLegendModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowVisibilityCheckboxes"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowLegend" /> = true. If true, shows the Visibility Checkboxes in the automatically generated legend. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowSeriesMarkers"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowLegend" /> = true. If true, shows the Series Markers in the automatically generated legend + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendPlacement"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowLegend" /> = true. Defines the placement of the auto-generated legend + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendItemTemplate"> + <summary> + Gets or sets the Legend Item Template, which provides UI that binds to a single <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> instance. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendData"> + <summary> + The LegendData object provides a collection of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> which can be bound to in ItemsControls or SciChartLegend control. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.Orientation"> + <summary> + Gets or sets the Orientation of the Legend Items, e.g. Vertical, or Horizontal + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowLegend"> + <summary> + If true, then the TernaryLegendModifier automatically shows and hosts a <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> inside the chart surface, according to <see cref="!:TernaryLegendPlacement" />. If false, then the user may provide an alternative legend control + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.LegendTemplate"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.ShowLegend" /> = true. An optional control template for the auto-generated <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> control + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.GetLegendDataFor"> + <summary> + Gets or sets an enumeration constant defining which series to interrogate for the legend data source + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryLegendModifier.SeriesData"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Model.ChartData.ChartDataObject" /> which may be bound to, to provide feedback to the user of cursor updates + </summary> + <value>The series data.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.UpdateLegend"> + <summary> + Refreshes the legend with up-to-date <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> with series names, latest values + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.IsSeriesValid(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /></summary> + <param name="series"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryLegendModifier.GetSeriesInfo(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries})"> + <summary> + Gets the SeriesInfo for all the RenderableSeries passed in + </summary> + <param name="allSeries"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TernaryModifierGroup"> + <summary> + Allows a collection of modifiers to be set on the <see cref="P:SciChart.Charting.Visuals.SciChartTernarySurface.ChartModifier" /> property. Child modifiers are stored in the + <see cref="P:SciChart.Charting.ChartModifiers.TernaryModifierGroup.ChildModifiers" /> collection, which is backed by a DependencyProperty so may be bound to in Xaml. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryModifierGroup.ChildModifiersProperty"> + <summary> + Defines the ChildModifiers DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryModifierGroup" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.#ctor(SciChart.Charting.ChartModifiers.ITernaryChartModifier[])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryModifierGroup" /> class. + </summary> + <param name="childModifiers">The child modifier collection.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryModifierGroup.ChildModifiers"> + <summary> + Gets or sets a collection of child modifiers in this group + </summary> + <value>The child modifiers.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryModifierGroup.Item(System.String)"> + <summary> + Gets the <see cref="T:SciChart.Charting.ChartModifiers.ITernaryChartModifier" /> with the specified name. + </summary> + <value> + The <see cref="T:SciChart.Charting.ChartModifiers.ITernaryChartModifier" />. + </value> + <param name="name">The name.</param> + <returns></returns> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryModifierGroup.Item(System.Int32)"> + <summary> + Gets the <see cref="T:SciChart.Charting.ChartModifiers.ITernaryChartModifier" /> at the specified index. + </summary> + <value> + The <see cref="T:SciChart.Charting.ChartModifiers.ITernaryChartModifier" />. + </value> + <param name="index">The index.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnAnnotationCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the AnnotationCollection changes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the mouse leaves the Master of current <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup" /></summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.HasModifier(System.Type)"> + <summary> + Determines whether the current <see cref="T:SciChart.Charting.ChartModifiers.TernaryModifierGroup" /> has a child modifier of the desired type + </summary> + <param name="desiredType">The type of child modifier to search for</param> + <returns> + <c>true</c> if the current <see cref="T:SciChart.Charting.ChartModifiers.TernaryModifierGroup" /> has a chlid modifier by this type; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.OnDataContextChanged(System.Object,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the DataContext of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryModifierGroup.ResetInertia"> + <summary> + Instantly stops any inertia that can be associated with this modifier. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifier" /> provides a mouse-over tooltip to a chart, outputting a single <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> object to bind to which updates as the mouse moves over data-points. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.TooltipProperty"> + <summary> + Defines Tooltip attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.SetTooltip(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.TooltipControl)"> + <summary> + Sets Tooltip Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.GetTooltip(System.Windows.DependencyObject)"> + <summary> + Gets Tooltip Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.TooltipTemplateProperty"> + <summary> + Defines TooltipTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.SetTooltipTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets TooltipTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.GetTooltipTemplate(System.Windows.DependencyObject)"> + <summary> + Gets TooltipTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.TooltipContainerStyleProperty"> + <summary> + Defines TooltipContainerStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.SetTooltipContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets TooltipContainerStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.GetTooltipContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets TooltipContainerStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.TooltipLabelDataContextSelectorProperty"> + <summary> + Defines the TooltipLabelDataContextSelector DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.TooltipLabelDataContextSelector"> + <summary> + Gets or sets the function which is called internally to get a DataContext for a particular data point + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifier" /> class + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifier.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase" /> is part of the ChartModifier API, which factors out handling of Axis and Chart Label templates, + and provides a mouse-over templated tooltip to bind to a custom DataContext, provided by the output of the Hit-Test operation on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /></summary> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifier" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.LineOverlayStyleProperty"> + <summary> + Defines the LineOverlayStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.ShowAxisLabelsProperty"> + <summary> + Defines the ShowAxisLabels DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.SeriesDataProperty"> + <summary> + Defines the SeriesData Dependency property which you may bind to in your applications to show cursor updates on mouse-move + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.CurrentPoint"> + <summary> + The Current MousePoint on the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.SeriesData"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Model.ChartData.ChartDataObject" /> which may be bound to, to provide feedback to the user of cursor updates + </summary> + <value>The series data.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.LineOverlayStyle"> + <summary> + Gets or sets the style applied to the modifier overlays (TargetType=Line) + </summary> + <value>The crosshairs style.</value> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.ShowAxisLabels"> + <summary> + Gets or sets value, indicates whether show labels on axes or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> instance + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.GetSeriesInfoAt(System.Windows.Point,System.Double)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.TernaryChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + <param name="point"></param> + <param name="hitTestRadius"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.GetSeriesInfoAt(System.Func{SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo})"> + <summary> + Called internally, gets the SeriesInfo on all RenderableSeries using the provided hit-test function + </summary> + <param name="hitTestMethod">The hit-test function</param> + <returns>The seriesinfo list</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.IsSeriesValid(SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> inside the <see cref="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.OnParentSurfaceRendered(SciChart.Charting.Utility.SciChartRenderedMessage)"> + <summary> + Called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> is rendered + </summary> + <param name="e">The <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> which contains the event arg data</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.HandleMouseEvent(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + General logic for processing mouse events + </summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.TernaryChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.IsHitPointValid(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" />. + </summary> + <param name="hitTestInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TernaryTooltipModifierBase.CreateFromTemplate``1(System.Windows.DataTemplate,System.Object)"> + <summary> + Creates instances of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TemplatableControl" /></summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TooltipModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> provides a mouse-over tooltip to a chart, outputting a single <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> object to bind to which updates as the mouse moves over data-points. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + <example> + <code title="TooltipModifier usage (XAML)" description="Shows how to assign a TooltipModifier to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/SciChart" --> + <s:SciChartSurface> + <s:SciChartSurface.ChartModifier> + <s:ModifierGroup> + <s:TooltipModifier IsEnabled="True"/> + </s:ModifierGroup> + </s:SciChartSurface.ChartModifier> + </s:SciChartSurface> + </code> + <code title="TooltipModifier usage (C#)" description="Shows how to assign a TooltipModifier to a SciChartSurface in C#" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.ChartModifier = new ModifierGroup(new TooltipModifier() + { + IsEnabled = true, + }); + </code> + </example> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.TooltipProperty"> + <summary> + Defines Tooltip attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetTooltip(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.TooltipControl)"> + <summary> + Sets Tooltip Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetTooltip(System.Windows.DependencyObject)"> + <summary> + Gets Tooltip Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.TooltipTemplateProperty"> + <summary> + Defines TooltipTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetTooltipTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets TooltipTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetTooltipTemplate(System.Windows.DependencyObject)"> + <summary> + Gets TooltipTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.TooltipContainerStyleProperty"> + <summary> + Defines TooltipStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetTooltipContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets TooltipStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetTooltipContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets TooltipStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.AxisLabelProperty"> + <summary> + Defines AxisLabel attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetAxisLabel(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Sets AxisLabel Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetAxisLabel(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabel Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.AxisLabelTemplateProperty"> + <summary> + Defines AxisLabelTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetAxisLabelTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets AxisLabelTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetAxisLabelTemplate(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabelTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.AxisLabelContainerStyleProperty"> + <summary> + Defines AxisLabelStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetAxisLabelContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Gets AxisLabelStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetAxisLabelContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabelStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.IncludeSeriesProperty"> + <summary> + Defined IncludeSeries Attached Property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the include Series or not + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifier.TooltipLabelDataContextSelectorProperty"> + <summary> + Defines the TooltipLabelDataContext DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifier.TooltipLabelDataContextSelector"> + <summary> + Gets or sets the function which is called internally to get a DataContext for a particular data point + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifier.TooltipUsageMode"> + <summary> + Gets or sets the value which defines how to render tooltips. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> class + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifier.HoverDelay"> + <summary> + Gets or sets delay for showing of tooltips in milliseconds + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetAxisLabelTemplate(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetAxisLabelContainerStyle(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.GetCachedAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns axis label cached in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.CacheAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.HandleSlaveMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Slave <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.IsSeriesValid(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> inside the <see cref="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.IsHitPointValid(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + <param name="hitTestInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifier.OnTooltipUsageModeChanged"> + <summary> + Raises when TooltipUsageMode property has been changed + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ShowTooltipOptions"> + <summary> + Specifies actions that cause rollover tooltip to be shown + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.MouseOver"> + <summary> + Show tooltip when mouse is over point + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.MouseHover"> + <summary> + Show tooltip when mouse hovers over the surface + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.Always"> + <summary> + Show tooltip always + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.MouseLeftButtonDown"> + <summary> + Show tooltip when mouse left button is pressed + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.MouseRightButtonDown"> + <summary> + Show tooltip when mouse right button is pressed + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.MouseMiddleButtonDown"> + <summary> + Show tooltip when mouse middle button is pressed + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ShowTooltipOptions.Never"> + <summary> + Never show tooltips + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TooltipUsageMode"> + <summary> + Declares possible rendering modes for modifier tooltips. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipUsageMode.TooltipControl"> + <summary> + Shows a tooltip as a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TooltipControl" />, + which is placed inside a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> on the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" />. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipUsageMode.Popup"> + <summary> + Shows a tooltip as a <see cref="T:System.Windows.Controls.Primitives.Popup" />. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TooltipPlacement"> + <summary> + Declares possible placement positions for modifier tooltips. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipPlacement.Right"> + <summary> + Show a tooltip to the right of cursor. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipPlacement.Left"> + <summary> + Show a tooltip to the left of cursor. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.TooltipModifierBase"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.TooltipModifierBase" /> is part of the ChartModifier API, which factors out handling of Axis and Chart Label templates, and provides a mouse-over templated tooltip to bind to a custom DataContext, provided by the output of the Hit-Test operation on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + <seealso cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.ShowTooltipOnProperty"> + <summary> + Defines the ShowTooltipOn DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.LineOverlayStyleProperty"> + <summary> + Defines the LineOverlayStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.ShowAxisLabelsProperty"> + <summary> + Defines the ShowAxisLabels DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.HoverDelayProperty"> + <summary> + Defines HoverDelay DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.TooltipUsageModeProperty"> + <summary> + Defines the PopupIsEnabled DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.TooltipPlacementProperty"> + <summary> + Defines the PopupPlacement DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase.TooltipOffset"> + <summary> + Defines the default X and Y offset for tooltips. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase._tooltipLabelCache"> + <summary> + Defines the cached TemplatableControl. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.TooltipModifierBase._tooltipPopup"> + <summary> + Defines the popup for rendering tooltip as top-most element. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.HoverDelay"> + <summary> + Gets or sets delay for showing of tooltips in milliseconds. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.ShowTooltipOn"> + <summary> + Gets or sets when to show tooltips. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.LineOverlayStyle"> + <summary> + Gets or sets the style applied to the modifier overlays (TargetType=Line). + </summary> + <value>The crosshairs style.</value> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.ShowAxisLabels"> + <summary> + Gets or sets value, indicates whether show labels on axes or not. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.TooltipPlacement"> + <summary> + Gets or sets the value which specifies tooltip placement. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.IsTooltipControl"> + <summary> + Gets the value which indicates whether tooltip is a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TooltipControl" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.InitializeModifierPopup"> + <summary> + Called by inherited modifiers + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnTooltipUsageModeChanged"> + <summary> + Raises when TooltipUsageMode property has been changed + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.GetAxisLabelTemplate(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.GetAxisLabelContainerStyle(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.GetCachedAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns axis label cached in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.CacheAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.HasToShowTooltip"> + <summary> + Checks <see cref="P:SciChart.Charting.ChartModifiers.TooltipModifierBase.ShowTooltipOn" /> property and returns value, indicating whether the tooltip has to be shown + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.IsHitPointValid(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting.ChartModifiers.InspectSeriesModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + <param name="hitTestInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when [X axes collection changed]. + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when [Y axes collection changed]. + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.UpdateAxesOverlay(System.Windows.Point)"> + <summary> + Updates the Axes Overlays on the X and Y Axis + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.UpdateXAxesOverlay(System.Windows.Point)"> + <summary> + Updates the Axes Overlays on the X Axis + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.UpdateYAxesOverlay(System.Windows.Point)"> + <summary> + Updates the Axes Overlays on the Y Axis + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.PlaceOverlay(System.Windows.FrameworkElement,System.Windows.Point,System.Double)"> + <summary> + Calculates X and Y coordinates of placement point + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OpenPopup(System.Double,System.Double)"> + <summary> + Opens the popup which shows tooltips + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.OpenPopup"> + <summary> + Opens the popup which shows tooltips + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.ClosePopup"> + <summary> + Closes the popup which shows tooltips + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.ClearPopup"> + <summary> + Clears the content of the popup which shows tooltips + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.PopupAddChild(System.Windows.FrameworkElement)"> + <summary> + Adds an element to the popup which shows tooltips + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.ClearAxesOverlay"> + <summary> + Clears Axis Overlays on the X and Y Axes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.TooltipModifierBase.CreateFromTemplate``1(System.Windows.DataTemplate,System.Object)"> + <summary> + Creates instances of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TemplatableControl" /></summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /> provides drawing of vertical slices based on collection of <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /> + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set VerticalLines collection to enable this behaviour + </summary> + <example> + <code title="VerticalSliceModifier usage (XAML)" description="Shows how to assign a VerticalSliceModifier to a SciChartSurface in XAML" lang="xaml"> + <s:SciChartSurface> + + <!-- XAxis, YAxis, RenderableSeries omitted for brevity --> + + <s:SciChartSurface.ChartModifier> + <s:ModifierGroup> + <s:VerticalSliceModifier Name="sliceModifier"> + <s:VerticalSliceModifier.VerticalLines> + <s:VerticalLineAnnotation X1="1" /> + <s:VerticalLineAnnotation X1="3" /> + <s:VerticalLineAnnotation X1="5" /> + <s:VerticalLineAnnotation X1="7" /> + <s:VerticalLineAnnotation X1="9" /> + </s:VerticalSliceModifier.VerticalLines> + </s:VerticalSliceModifier> + </s:ModifierGroup> + </s:SciChartSurface.ChartModifier> + </s:SciChartSurface> + </code> + <code title="VerticalSliceModifier usage (C#)" description="Shows how to assign a VerticalSliceModifier to a SciChartSurface in C#" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.XAxis = new NumericAxis(); + sciChartSurface.YAxis = new NumericAxis(); + var verticalSliceModifier = new VerticalSliceModifier(); + verticalSliceModifier.VerticalLines.Add(new VerticalLineAnnotation() { X1 = 1 } ); + verticalSliceModifier.VerticalLines.Add(new VerticalLineAnnotation() { X1 = 3 } ); + sciChartSurface.ChartModifier = new ModifierGroup(verticalSliceModifier); + </code> + </example> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TooltipModifier" /> + </member> + <member name="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier.MarkerItem"> + <summary> + Represents a cached rollover marker + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.MarkerItem.VerticalLine"> + <summary> + Gets or sets the attached <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.MarkerItem.Marker"> + <summary> + Gets or sets the attached rollover marker + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem"> + <summary> + Represents a serializable vertical slice item + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem" /> class + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.IsSelected"> + <summary> + Gets or sets a value indicating whether the line is selected + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.ZIndex"> + <summary> + Gets the current Panel.ZIndex of tooltip labels + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.TooltipLabels"> + <summary> + Gets or sets the collection of tooltip labels + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.SeriesInfo"> + <summary> + Gets or sets the collection of series info items + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.RolloverMarkers"> + <summary> + Gets or sets the collection of rollover markers + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.VerticalLine"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /> line + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.Dispose"> + <summary> + Clears all collections + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.ClearMarkers"> + <summary> + Clears the collection of rollover markers + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.ClearSeriesInfos"> + <summary> + Clears the collection of series info items + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.ClearTooltips"> + <summary> + Clears the collection of tooltip labels + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem.SetZIndex(System.Int32,System.Int32)"> + <summary> + Sets Panel.ZIndex for tooltip labels + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.TooltipTemplateProperty"> + <summary> + Defines TooltipTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.SetTooltipTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets TooltipTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetTooltipTemplate(System.Windows.DependencyObject)"> + <summary> + Gets TooltipTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.TooltipContainerStyleProperty"> + <summary> + Defines TooltipStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.SetTooltipContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets TooltipStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetTooltipContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets TooltipStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.AxisLabelProperty"> + <summary> + Defines AxisLabel attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.SetAxisLabel(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Sets AxisLabel Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetAxisLabel(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabel Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.AxisLabelTemplateProperty"> + <summary> + Defines AxisLabelTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.SetAxisLabelTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets AxisLabelTemplate Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetAxisLabelTemplate(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabelTemplate Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.AxisLabelContainerStyleProperty"> + <summary> + Defines AxisLabelStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.SetAxisLabelContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Gets AxisLabelStyle Attached property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetAxisLabelContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets AxisLabelStyle Attached property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.IncludeSeriesProperty"> + <summary> + Defined IncludeSeries Attached Property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the include Series or not + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalLinesProperty"> + <summary> + Defines the VerticalLines DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalLines"> + <summary> + Gets or sets <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> of <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /> for making vertical slices + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetRolloverMarkerFrom(SciChart.Charting.Model.ChartData.SeriesInfo)"> + <summary> + Get rollover marker from <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> to place on chart + </summary> + <param name="seriesInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.DetachRolloverMarker(System.Windows.FrameworkElement)"> + <summary> + Detaches a RolloverMarker from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + <param name="rolloverMarker">The rollover marker.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetTooltipItemTemplate(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Returns Tooltip DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetTooltipStyle(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Returns Tooltip Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetAxisLabelTemplate(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetAxisLabelContainerStyle(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns XAxis Label Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.GetCachedAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + Returns axis label cached in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.CacheAxisLabel(SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresponding <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.OnTooltipUsageModeChanged"> + <summary> + Raises when TooltipUsageMode property has been changed + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.ClearTooltipLabels"> + <summary> + Removes all tooltip labels + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.RemoveMarkers"> + <summary> + Removes all rollover markers + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.CacheMarkerInRenderableSeries(SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem,System.Windows.FrameworkElement,SciChart.Charting.Model.ChartData.SeriesInfo)"> + <summary> + Caches rollover marker in <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + <param name="verticalSliceItem">Slice <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem" /></param> + <param name="rolloverMarker">The rollover marker</param> + <param name="seriesInfo"> + <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> of current rollover marker</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.CacheMarkerInVerticalLineAnnotation(SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem,System.Windows.FrameworkElement)"> + <summary> + Caches rollover marker in <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + <param name="verticalSliceItem">Slice <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem" /></param> + <param name="rolloverMarker">The rollover marker</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.UpdateTooltipLabels(System.Collections.Generic.IEnumerable{System.Windows.FrameworkElement})"> + <summary> + Updates tooltips labels + </summary> + <param name="overlappedMarkers">Markers collection</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifier.MergeTooltipLabelFor(System.Windows.FrameworkElement,SciChart.Charting.ChartModifiers.VerticalSliceModifier.VerticalSliceItem)"> + <summary> + Merges multiple marker tooltips in a single framework element + </summary> + <param name="rolloverMarker">The current rollover marker</param> + <param name="verticalSliceItem">The current vertical slice item</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase" /> is part of the ChartModifier API, which provides vertical slices on <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> and a mouse-over templated tooltip to bind to a custom DataContext, provided by the output of the Hit-Test operation on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase._rolloverMarkers"> + <summary> + Defines the collection of rollover markers + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase._tooltipLabels"> + <summary> + Defines the collection of rollover tooltips + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase._needToUpdateTooltips"> + <summary> + Indicates that rollover tooltips must be updated + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.#ctor"> + <summary> + Creates instance of <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetTooltipItemTemplate(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Returns Tooltip DataTemplate from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetTooltipStyle(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Returns Tooltip Style from attached property of child modifier + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.RemoveMarkers"> + <summary> + Removes all rollover markers + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.DetachRolloverMarker(System.Windows.FrameworkElement)"> + <summary> + Detaches a RolloverMarker from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + <param name="rolloverMarker">The rollover marker.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.RemoveLabelFor(System.Windows.FrameworkElement)"> + <summary> + Remove label for such rollover marker + </summary> + <param name="rolloverMarker">The rollover marker</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.IsHitPointValid(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.UpdateYAxesOverlay(System.Windows.Point)"> + <summary> + Updates the Axes Overlays on the Y Axis + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.HandleSlaveMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Slave <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.IsMouseOverMarker(System.Windows.FrameworkElement)"> + <summary> + Returns True if the Mouse is over a marker, regardless of Z index + </summary> + <param name="frameworkElement">The framework element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.FillWithIncludedSeries(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.SeriesInfo},System.Collections.ObjectModel.ObservableCollection{SciChart.Charting.Model.ChartData.SeriesInfo})"> + <summary> + Fills the target collection with <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> items from the source collection + </summary> + <param name="infos">The source collection</param> + <param name="seriesInfos">The target collection to fill</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates the RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetRolloverMarkerFrom(SciChart.Charting.Model.ChartData.SeriesInfo)"> + <summary> + Get rollover marker from <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> to place on chart + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.TryAddRolloverMarker(System.Windows.FrameworkElement,System.Windows.Point)"> + <summary> + Add rollover marker if it can + </summary> + <param name="rolloverMarker">The rollover marker</param> + <param name="showRolloverAt">Point for rollover marker</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.AttachRolloverMarker(System.Windows.FrameworkElement)"> + <summary> + Attach rollover marker on a ModifierSurface + </summary> + <param name="rolloverMarker">The rollover marker</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.CacheRolloverMarkerInRenderableSeries(System.Windows.FrameworkElement,SciChart.Charting.Model.ChartData.SeriesInfo)"> + <summary> + Caches rollover marker in renderable series + </summary> + <param name="rolloverMarker">The rollover marker</param> + <param name="seriesInfo"> + <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> of current rollover marker</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.ClearRolloverMarkersCache"> + <summary> + Clear rollover markers cache + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.UpdateOverlays(System.Windows.Point)"> + <summary> + Update tooltips only if in corresponding mode and markers exist + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.ClearTooltipLabels"> + <summary> + Removes all tooltip labels + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetRolloverMarkersAt(System.Windows.Point)"> + <summary> + Returns the collection of rollover markers at the current mouse point + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetRolloverMarkerRect(System.Windows.FrameworkElement)"> + <summary> + Get coordinates, height and width of rollover marker + </summary> + <param name="rolloverMarker">The rollover marker</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.UpdateTooltipLabels(System.Collections.Generic.IEnumerable{System.Windows.FrameworkElement})"> + <summary> + Updates tooltips labels + </summary> + <param name="overlappedMarkers">Markers collection</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.MergeTooltipLabelFor(System.Windows.FrameworkElement)"> + <summary> + Merges multiple marker tooltips in a single framework element + </summary> + <param name="rolloverMarker">The current rollover marker</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.GetTooltipLabelRect(System.Windows.FrameworkElement,System.Windows.Point,System.Windows.Rect,System.Windows.Rect)"> + <summary> + Get coordinates, height and width of tooltip label + </summary> + <param name="tooltip">Tooltip label</param> + <param name="point">Rollover marker coordinates</param> + <param name="markerRect">Rollover marker <see cref="T:System.Windows.Rect" /></param> + <param name="boundaryRect">Boundary <see cref="T:System.Windows.Rect" /></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.VerticalSliceModifierBase.OnSelectedSeriesChanged(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries},System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries})"> + <summary> + Called when the parent surface SelectedSeries collection changes + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.XAxisDragModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.XAxisDragModifier" /> provides a mouse drag to scale the X-Axis. + This behaviour scales the axis in a different direction depending on which half of the axis the user starts the operation in + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.XAxisDragModifier.ClipModeXProperty"> + <summary> + Defines the ClipToExtentsX Dependency Property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.XAxisDragModifier.IncludeAxisProperty"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a XAxisDragModifier operation. + By setting this property to false on an axis, you exclude the axis from the XAxisDragModifier operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.SetIncludeAxis(SciChart.Charting.Visuals.Axes.AxisBase,System.Boolean)"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a XAxisDragModifier operation. + By setting this property to false on an axis, you exclude the axis from the XAxisDragModifier operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.GetIncludeAxis(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a XAxisDragModifier operation. + By setting this property to false on an axis, you exclude the axis from the XAxisDragModifier operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.XAxisDragModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.XAxisDragModifier.ClipModeX"> + <summary> + Defines how panning behaves when you reach the edge of the X-Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the X-Axis, ClipMode.None allows panning outside + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.GetAxisById(System.String)"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance, which current modifier is associated with, on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.PerformPan(System.Windows.Point,System.Windows.Point)"> + <summary> + Peforms a pan on the assocaited <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />. The pan is considered to be a drag from <paramref name="currentPoint" /> to <paramref name="lastPoint" /></summary> + <param name="currentPoint">The current mouse point</param> + <param name="lastPoint">The last mouse point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.XAxisDragModifier.CalculateScaledRange(System.Windows.Point,System.Windows.Point,System.Boolean,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + When overriden in a derived class, calculates an output <see cref="T:SciChart.Data.Model.IRange" /> to apply to the associated <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase">Axis</see>, + given the input parameters + </summary> + <param name="currentPoint">The current mouse position</param> + <param name="lastPoint">The last mouse position</param> + <param name="isSecondHalf">A flag, which determines how the scale operates, e.g. which half of the axis (top or bottom, left or right) was dragged</param> + <param name="axis">The axis being operated on</param> + <returns> + The output <see cref="T:SciChart.Data.Model.IRange" /></returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.YAxisDragModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.YAxisDragModifier" /> provides a mouse drag to scale the Y-Axis. + This behaviour scales the axis in a different direction depending on which half of the axis the user starts the operation in + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.YAxisDragModifier.IncludeAxisProperty"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a XAxisDragModifier operation. + By setting this property to false on an axis, you exclude the axis from the XAxisDragModifier operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.SetIncludeAxis(SciChart.Charting.Visuals.Axes.AxisBase,System.Boolean)"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a XAxisDragModifier operation. + By setting this property to false on an axis, you exclude the axis from the XAxisDragModifier operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.GetIncludeAxis(SciChart.Charting.Visuals.Axes.AxisBase)"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a XAxisDragModifier operation. + By setting this property to false on an axis, you exclude the axis from the XAxisDragModifier operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.GetAxisById(System.String)"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance, which current modifier is associated with, on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.GetUsedCursor(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Depending on axis orientation and AxisAlignment, returns a Cursor to show during mouse-over of the axis + </summary> + <param name="axis">The axis instance</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.GetIsSecondHalf(System.Windows.Point,System.Windows.Rect,System.Boolean)"> + <summary> + Gets whether the specified mouse point is within the second (right-most or top-most) half of the Axis bounds + </summary> + <param name="point">The mouse point</param> + <param name="axisBounds">The axis bounds</param> + <param name="isHorizontalAxis">Value, which indicates whether current axis is horizontal or not</param> + <returns> + True if the point is within the second (right-most or top-most) half of the axis bounds, else false + </returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.PerformPan(System.Windows.Point,System.Windows.Point)"> + <summary> + Peforms a pan on the assocaited <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />. The pan is considered to be a drag from <paramref name="currentPoint" /> to <paramref name="lastPoint" /></summary> + <param name="currentPoint">The current mouse point</param> + <param name="lastPoint">The last mouse point</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.CalculateScaledRange(System.Windows.Point,System.Windows.Point,System.Boolean,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + When overriden in a derived class, calculates an output <see cref="T:SciChart.Data.Model.IRange" /> to apply to the associated <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase">Axis</see>, + given the input parameters + </summary> + <param name="currentPoint">The current mouse position</param> + <param name="lastPoint">The last mouse position</param> + <param name="isSecondHalf">A flag, which determines how the scale operates, e.g. which half of the axis (top or bottom, left or right) was dragged</param> + <param name="axis">The axis being operated on</param> + <returns> + The output <see cref="T:SciChart.Data.Model.IRange" /></returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.YAxisDragModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ZoomExtentsModifier"> + <summary> + Provides zoom to extents, or zoom to specific X and Y VisibleRange on mouse interaction + </summary> + <example> + The following example will create a modifier which zooms to extents on Mouse Double Click + + <code> + ZoomExtentsModifier z = new ZoomExtentsModifier(); + z.ExecuteOn = ExecuteOn.MouseDoubleClick; + </code></example> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.IsAnimatedProperty"> + <summary> + Defines the IsAnimated DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.XyDirectionProperty"> + <summary> + Defines the XyDirection dependency property + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ZoomExtentsModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.XyDirection"> + <summary> + Defines the direction of the ZoomExtentsModifier + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.IsAnimated"> + <summary> + Gets or sets whether zoom operations should be animated. Default true + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.PerformZoom"> + <summary> + Performs the zoom function. Called when the user double clicks (right mouse up). May be overridden in derived classes to customize what the zoom actually does + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.DoubleTapThreshold"> + <summary> + Gets or sets maximum time between taps to be considered as double tap. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomExtentsModifier.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ZoomPanModifier"> + <summary> + The <see cref="T:SciChart.Charting.ChartModifiers.ZoomPanModifier" /> provides a mouse drag to pan the X and Y axes. + Add to a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ZoomPanModifier.IncludeAxisProperty"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a ZoomPan operation. + By setting this property to false on an axis, you exclude the axis from the ZoomPan operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.SetIncludeAxis(System.Windows.DependencyObject,System.Boolean)"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a ZoomPan operation. + By setting this property to false on an axis, you exclude the axis from the ZoomPan operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.GetIncludeAxis(System.Windows.DependencyObject)"> + <summary> + The IncludeAxisProperty (default true) defines whether an axis should be included in a ZoomPan operation. + By setting this property to false on an axis, you exclude the axis from the ZoomPan operation. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ZoomPanModifier" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.Pan(System.Windows.Point,System.Windows.Point,System.Windows.Point)"> + <summary> + Receives zoom command from the user. + </summary> + <param name="currentPoint">Current point of zoom gesture.</param> + <param name="lastPoint">Previous point of zoom gesture.</param> + <param name="startPoint">Start point of zoom gesture.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifier.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ZoomPanModifierBase"> + <summary> + Base class for modifiers responsible for pan by mouse drag. + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.XyDirectionProperty"> + <summary> + Defines the XyDirection dependency property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.ClipModeXProperty"> + <summary> + Defines the ClipToExtentsX Dependency Property + </summary> + </member> + <member name="F:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.ZoomExtentsYProperty"> + <summary> + Defines the ZoomExtentsY DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.ZoomExtentsY"> + <summary> + If true, zooms to extents on the Y-Axis on each zoom operation when panning in X-Direction only. Use in conjunction with <see cref="P:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.XyDirection" /> to achieve different zooming effects + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.XyDirection"> + <summary> + Defines the direction of the InertialZoomPanModifier + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.ClipModeX"> + <summary> + Defines how panning behaves when you reach the edge of the X-Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the X-Axis, ClipMode.None allows panning outside + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.IsDragging"> + <summary> + Gets whether the user is currently dragging the chart + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ZoomPanModifierBase" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> or mouse capture is lost. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ZoomPanModifierBase.Pan(System.Windows.Point,System.Windows.Point,System.Windows.Point)"> + <summary> + Receives pan command from the user. + </summary> + <param name="currentPoint">Current point of the gesture.</param> + <param name="lastPoint">Previous point of the gesture.</param> + <param name="startPoint">Start point of the gesture.</param> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ZoomStateModifier"> + <summary> + The IsUserZooming modifier sets an attached property: <see cref="!:IsUserZoomingProperty" /> to true on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> if the user initiates a zoom or pan operation via one of the other ChartModifiers. + + This flag is reset to false when a DoubleClick occurs on the chart. This can be used in conjuction with your own code to perform speial handling of cases where user is zooming + </summary> + </member> + <member name="T:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper"> + <summary> + Attached properties to assist with Axis layout. Used internally by SciChart in the Themes + </summary> + </member> + <member name="F:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.AxisAlignmentProperty"> + <summary> + The axis alignment property + </summary> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.GetAxisAlignment(System.Windows.DependencyObject)"> + <summary> + Gets the axis alignment. + </summary> + <param name="obj">The object.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.SetAxisAlignment(System.Windows.DependencyObject,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Sets the axis alignment. + </summary> + <param name="obj">The object.</param> + <param name="value">The value.</param> + </member> + <member name="F:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.IsInsideItemProperty"> + <summary> + The is inside item property + </summary> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.GetIsInsideItem(System.Windows.DependencyObject)"> + <summary> + Gets the is inside item. + </summary> + <param name="obj">The object.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.SetIsInsideItem(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the is inside item. + </summary> + <param name="obj">The object.</param> + <param name="value">if set to <c>true</c> [value].</param> + </member> + <member name="F:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.IsOutsideItemProperty"> + <summary> + The is outside item property + </summary> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.GetIsOutsideItem(System.Windows.DependencyObject)"> + <summary> + Gets the is outside item. + </summary> + <param name="obj">The object.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.AxisLayoutHelper.SetIsOutsideItem(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the is outside item. + </summary> + <param name="obj">The object.</param> + <param name="value">if set to <c>true</c> [value].</param> + </member> + <member name="T:SciChart.Charting.Common.AttachedProperties.PerformanceHelper"> + <summary> + <para>A helper class to enable the C++ extreme resamplers</para> + <para>Usage: >SciChartSurface PerformanceHelper.EnableExtremeResamplers="True"/<</para> + </summary> + </member> + <member name="F:SciChart.Charting.Common.AttachedProperties.PerformanceHelper.EnableExtremeResamplersProperty"> + <summary>Defines the EnableExtremeResamplers attached property</summary> + </member> + <member name="F:SciChart.Charting.Common.AttachedProperties.PerformanceHelper.EnableExtremeDrawingManagerProperty"> + <summary>Defines the EnableExtremeDrawingManager attached property</summary> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.PerformanceHelper.SetEnableExtremeResamplers(SciChart.Charting.Visuals.SciChartSurface,System.Boolean)"> + <summary> + Sets the EnableExtremeResamplers attached property. When true, tries to apply C++ Resampling to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> tries to apply C++ resampling to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />.</param> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.PerformanceHelper.GetEnableExtremeResamplers(SciChart.Charting.Visuals.SciChartSurface)"> + <summary> + Gets the EnableExtremeResamplers attached property value + </summary> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.PerformanceHelper.SetEnableExtremeDrawingManager(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the EnableExtremeDrawingManager attached property. When true, tries to enable extreme drawing manager for the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance + </summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> tries to enable extreme drawing manager for the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />.</param> + </member> + <member name="M:SciChart.Charting.Common.AttachedProperties.PerformanceHelper.GetEnableExtremeDrawingManager(System.Windows.DependencyObject)"> + <summary> + Gets the EnableExtremeDrawingManager attached property value + </summary> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToAxisOrientationConverter"> + <summary> + Converts input <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> to <see cref="T:System.Windows.FlowDirection" />, is such a way that Left becomes RightToLeft and Right becomes LeftToRight + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToAxisOrientationConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToAxisOrientationConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToFlowDirectionConverter"> + <summary> + A converter to transform <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> enumeration values into <see cref="T:System.Windows.FlowDirection" /> for use in the Axis Text drawing + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToFlowDirectionConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToFlowDirectionConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToHorizontalAlignmentConverter"> + <summary> + Converts input <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> to <see cref="T:System.Windows.FlowDirection" />, is such a way that Left becomes RightToLeft and Right becomes LeftToRight + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToHorizontalAlignmentConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToHorizontalAlignmentConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToHorizontalAnchorPointConverter"> + <summary> + A Converter used by the Axis to align text and markers depending on <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /></summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToHorizontalAnchorPointConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToHorizontalAnchorPointConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToVerticalAlignmentConverter"> + <summary> + Converts input <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> to <see cref="T:System.Windows.FlowDirection" />, is such a way that Left becomes RightToLeft and Right becomes LeftToRight + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToVerticalAlignmentConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToVerticalAlignmentConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToVeticalAnchorPointConverter"> + <summary> + A Converter used by the Axis to align text and markers depending on <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /></summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToVeticalAnchorPointConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToVeticalAnchorPointConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.AxisAlignmentToVisibilityConverter"> + <summary> + A Converter used by the <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> to show or hide marker points depending on <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Databinding.AxisAlignmentToVisibilityConverter.IsLeftPointer"> + <summary> + If the <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> is pointing left or not + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToVisibilityConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.AxisAlignmentToVisibilityConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.BandSeriesInfoToYValueConverter"> + <summary> + A converter used to output Y-values from <see cref="T:SciChart.Charting.Model.ChartData.BandSeriesInfo" />, used as part of the Hit-Test API and + in the data-templates for <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /></summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BandSeriesInfoToYValueConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BandSeriesInfoToYValueConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.BooleanToDefaultAxisAlignmentConverter"> + <summary> + Converts given boolean value which indicates if axis is X or Y axis to the default alignment value, + <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Bottom" /> for XAxis and <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Right" /> for YAxis + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToDefaultAxisAlignmentConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToDefaultAxisAlignmentConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.BooleanToRotationTransformConverter"> + <summary> + Used internally by SciChart: Provides 90 Degree <see cref="T:System.Windows.Media.RotateTransform" /> if value is true, else 0 Degree + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToRotationTransformConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToRotationTransformConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.BooleanToSelectionMode"> + <summary> + Converts to Visibility.Collapsed if input value is null by default. Can be used with "Inverse" flag + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToSelectionMode.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToSelectionMode.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.BooleanToVisibilityConverter"> + <summary> + Converts to Visibility.Collapsed if input value is null by default. Can be used with "Inverse" flag + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToVisibilityConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.BooleanToVisibilityConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.CollapseIfNullOrEmptyStringConverter"> + <summary> + Converts to Visibility.Collapsed if input string is null or empty + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.CollapseIfNullOrEmptyStringConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.CollapseIfNullOrEmptyStringConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ColorToBrushConverter"> + <summary> + Converts from a Color to SolidColorBrush + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ColorToBrushConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ColorToBrushConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.CompositeCommandConverter"> + <summary> + Converts input collection of <see cref="T:SciChart.Charting.Common.Helpers.ActionCommand" /> items to a single <see cref="T:SciChart.Charting.Common.Helpers.ActionCommand" /> instance. + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.CompositeCommandConverter.Convert(System.Object[],System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.CompositeCommandConverter.ConvertBack(System.Object,System.Type[],System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetTypes">The types to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.DataTemplateToObjectConverter"> + <summary> + A TypeConverter which loads a <see cref="T:System.Windows.DataTemplate" /> and returns a <see cref="T:System.Windows.FrameworkElement" /></summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.DataTemplateToObjectConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.DataTemplateToObjectConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.DoubleToThicknessConverter"> + <summary> + Converts a double value to a <see cref="T:System.Windows.Thickness" /> with equal value all round + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.DoubleToThicknessConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.DoubleToThicknessConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.GradientStopsToLinearGradientBrushConverter"> + <summary> + Converts GradientStops collection value to a Brush + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.GradientStopsToLinearGradientBrushConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.GradientStopsToLinearGradientBrushConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.HorisontalOrientationVisibilityConverter"> + <summary> + Converts <see cref="T:System.Windows.Controls.Orientation" /> = Horisontal to <see cref="T:System.Windows.Visibility" /> = Visible + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.HorisontalOrientationVisibilityConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.HorisontalOrientationVisibilityConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.IComparableToObjectConverter"> + <summary> + ValueConverter to assist in marshalling <see cref="T:System.IComparable" /> types to object. Necessary because the XAML binding engine does not cope well with <see cref="T:System.IComparable" /> values + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.IComparableToObjectConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.IComparableToObjectConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.InverseOrientationConverter"> + <summary> + Converts from Axis <see cref="T:System.Windows.Controls.Orientation" /> to its inverse, e.g. Horizontal becomes Vertical and vice versa + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.InverseOrientationConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.InverseOrientationConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.InvertBooleanConverter"> + <summary> + Value converter which inverts a boolean + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.InvertBooleanConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.InvertBooleanConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.NullToVisibilityConverter"> + <summary> + Converts to Visibility.Collapsed if input value is null by default. Can be used with "Inverse" flag + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.NullToVisibilityConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.NullToVisibilityConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.OrientationToAxisLabelRotationConverter"> + <summary> + Converts from Axis <see cref="T:System.Windows.Controls.Orientation" /> to label rotation angle + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.OrientationToAxisLabelRotationConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.OrientationToAxisLabelRotationConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.RenderSurfaceFullSizeToTrianglePointMultiConverter"> + <summary> + Converts from a SciChartTernarySurface RenderSurface full size to triangle point. + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.RenderSurfaceFullSizeToTrianglePointMultiConverter.Convert(System.Object[],System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="values">The values produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.RenderSurfaceFullSizeToTrianglePointMultiConverter.ConvertBack(System.Object,System.Type[],System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetTypes">The types to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.RenderSurfaceSizeToTrianglePointConverter"> + <summary> + Converts from a SciChartTernarySurface RenderSurface size to triangle points. + </summary> + </member> + <member name="P:SciChart.Charting.Common.Databinding.RenderSurfaceSizeToTrianglePointConverter.IsFirstPoint"> + <summary> + True if it's first point + </summary> + </member> + <member name="P:SciChart.Charting.Common.Databinding.RenderSurfaceSizeToTrianglePointConverter.IsSecondPoint"> + <summary> + True if it's second point + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.RenderSurfaceSizeToTrianglePointConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.RenderSurfaceSizeToTrianglePointConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ShowVisibilityCheckboxesConverter"> + <summary> + Workaround converter to allow for cross-platform Ancestor binding to SciChartLegend in SL and WPF + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ShowVisibilityCheckboxesConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ShowVisibilityCheckboxesConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.StringToDoubleArrayTypeConverter"> + <summary> + Used to convert strings in XAML e.g. '0 1 2' to float arrays, for instance, see the <see cref="!:FastLineRenderableSeries.StrokeDashArray" /> property + which uses this converter type + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Common.Databinding.StringToDoubleArrayTypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)"> + <summary> + Returns whether the type converter can convert an object from the specified type to the type of this converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="sourceType">The type you want to convert from.</param> + <returns> + true if this converter can perform the conversion; otherwise, false. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.StringToDoubleArrayTypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)"> + <summary> + Converts from the specified value to the intended conversion type of the converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use as the current culture.</param> + <param name="value">The value to convert to the type of this converter.</param> + <returns> + The converted value. + </returns> + <exception cref="T:System.FormatException">Unable to convert the string {0} into a DoubleRange. Please use the format '1.234,5.678'</exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.StringToDoubleRangeTypeConverter"> + <summary> + TypeConverter to allow conversion of a string value to <see cref="T:SciChart.Data.Model.DoubleRange" />. Used to allow succinct Markup syntax e.g. + + <NumericAxis VisibleRange="10, 20"/> + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.StringToDoubleRangeTypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)"> + <summary> + Returns whether the type converter can convert an object from the specified type to the type of this converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="sourceType">The type you want to convert from.</param> + <returns> + true if this converter can perform the conversion; otherwise, false. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.StringToDoubleRangeTypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)"> + <summary> + Converts from the specified value to the intended conversion type of the converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use as the current culture.</param> + <param name="value">The value to convert to the type of this converter.</param> + <returns> + The converted value. + </returns> + <exception cref="T:System.FormatException">Unable to convert the string {0} into a DoubleRange. Please use the format '1.234,5.678'</exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ThicknessToDoubleConverter"> + <summary> + Convert <see cref="T:System.Windows.Thickness" /> value to double by taking mean of its values + </summary> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ToVerticalLineAnnotationCollectionConverter"> + <summary> + Creates a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ToVerticalLineAnnotationCollectionConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ToVerticalLineAnnotationCollectionConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ValueConverterBase"> + <summary> + A base class for shared <see cref="T:System.Windows.Data.IValueConverter" /> between NETFX_CORE and WPF + </summary> + </member> + <member name="T:SciChart.Charting.Common.Databinding.MultiValueConverterBase"> + <summary> + A base class for shared <see cref="T:System.Windows.Data.IMultiValueConverter" /> between NETFX_CORE and WPF + </summary> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ValueMultiplicatorConverter"> + <summary> + A ValueConverter that multiplies double numeric values + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ValueMultiplicatorConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.ValueMultiplicatorConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Common.Databinding.VerticalOrientationVisibilityConverter"> + <summary> + Converts <see cref="T:System.Windows.Controls.Orientation" /> = Vertical to <see cref="T:System.Windows.Visibility" /> = Visible + </summary> + </member> + <member name="M:SciChart.Charting.Common.Databinding.VerticalOrientationVisibilityConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting.Common.Databinding.VerticalOrientationVisibilityConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="T:SciChart.Charting.Common.Databinding.ZoomStateToVisibilityConverter"> + <summary> + Converts ZoomStates.UserZooming to Visible, and ZoomStates.AtExtents to Collapsed + </summary> + </member> + <member name="T:SciChart.Charting.Common.Extensions.CanvasExtensions"> + <summary> + Defines attached properties for Canvases + </summary> + </member> + <member name="T:SciChart.Charting.Common.Extensions.DependencyObjectExtensions"> + <summary> + Defines extension methods for the <see cref="T:System.Windows.DependencyObject" /> type. Used internally to SciChart + </summary> + </member> + <member name="M:SciChart.Charting.Common.Extensions.DependencyObjectExtensions.FindVisualChild``1(System.Windows.DependencyObject)"> + <summary> + Finds the visual child of type <typeparam name="T">T</typeparam></summary> + <param name="parent">The parent.</param> + <returns>The child, or null if not found</returns> + </member> + <member name="T:SciChart.Charting.Common.Extensions.SearchMode"> + <summary> + Enumeration constants to define binary searching of lists + </summary> + </member> + <member name="F:SciChart.Charting.Common.Extensions.SearchMode.Exact"> + <summary> + Specifies exact search. If the index is not found, -1 is returned. + </summary> + </member> + <member name="F:SciChart.Charting.Common.Extensions.SearchMode.Nearest"> + <summary> + Specifies the nearest index. This will round up or down if the search is in-between x-values + </summary> + </member> + <member name="F:SciChart.Charting.Common.Extensions.SearchMode.RoundDown"> + <summary> + Rounds down to the nearest index. + </summary> + </member> + <member name="F:SciChart.Charting.Common.Extensions.SearchMode.RoundUp"> + <summary> + Rounds up to the nearest index + </summary> + </member> + <member name="T:SciChart.Charting.Common.Extensions.EnumerableExtensions"> + <summary> + Provides extension methods for binary searching on lists. + </summary> + </member> + <member name="M:SciChart.Charting.Common.Extensions.EnumerableExtensions.FindIndex``1(System.Collections.Generic.IList{``0},System.Boolean,System.IComparable,SciChart.Charting.Common.Extensions.SearchMode)"> + <summary> + Finds the index of the item in the List according to the desired <see cref="T:SciChart.Charting.Common.Extensions.SearchMode" />. + If <paramref name="isSorted" /> is true, uses fast binary search + </summary> + <typeparam name="T">The type of the list</typeparam> + <param name="list">The list to search</param> + <param name="isSorted">If true, will use fast binary search</param> + <param name="value">The value to find the index for</param> + <param name="searchMode">The <see cref="T:SciChart.Charting.Common.Extensions.SearchMode" /> options</param> + <returns>The found index, or -1 if not found</returns> + </member> + <member name="M:SciChart.Charting.Common.Extensions.EnumerableExtensions.FindIndex(System.Collections.IList,System.Boolean,System.IComparable,SciChart.Charting.Common.Extensions.SearchMode)"> + <summary> + Finds the index of the item in the List according to the desired <see cref="T:SciChart.Charting.Common.Extensions.SearchMode" />. + If <paramref name="isSorted" /> is true, uses fast binary search + </summary> + <param name="list">The list to search</param> + <param name="isSorted">If true, will use fast binary search</param> + <param name="value">The value to find the index for</param> + <param name="searchMode">The <see cref="T:SciChart.Charting.Common.Extensions.SearchMode" /> options</param> + <returns>The found index, or -1 if not found</returns> + </member> + <member name="M:SciChart.Charting.Common.Extensions.EnumerableExtensions.MaxOrNullable``1(System.Collections.Generic.IEnumerable{``0})"> + <summary> + Returns the maximum value or null if sequence is empty. + </summary> + <param name="that">The sequence to retrieve the maximum value from. + </param> + <returns>The maximum value or null.</returns> + </member> + <member name="M:SciChart.Charting.Common.Extensions.EnumerableExtensions.MinOrNullable``1(System.Collections.Generic.IEnumerable{``0})"> + <summary> + Returns the minimum value or null if sequence is empty. + </summary> + <param name="that">The sequence to retrieve the minimum value from. + </param> + <returns>The minimum value or null.</returns> + </member> + <member name="M:SciChart.Charting.Common.Extensions.EnumerableExtensions.IndexOf``1(System.Collections.Generic.IEnumerable{``0},``0,System.Collections.Generic.IEqualityComparer{``0})"> + <summary> + Searches for the specified object and returns the zero-based index of the first occurrence within the entire + </summary> + </member> + <member name="M:SciChart.Charting.Common.Extensions.RenderableSeriesExtension.GetSeriesColorAtPoint(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Returns the color of a particular data point in the passed <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> instance. + </summary> + </member> + <member name="F:SciChart.Charting.Common.Extensions.RenderSurfaceExtensions.RenderSurfaceTypeProperty"> + <summary> + Defines the RenderSurfaceType attached property + </summary> + </member> + <member name="M:SciChart.Charting.Common.Extensions.RenderSurfaceExtensions.SetRenderSurfaceType(System.Windows.UIElement,System.String)"> + <summary> + Sets the RenderSurfaceType attached property + </summary> + <param name="element">The element.</param> + <param name="value">The value.</param> + </member> + <member name="M:SciChart.Charting.Common.Extensions.RenderSurfaceExtensions.GetRenderSurfaceType(System.Windows.UIElement)"> + <summary> + Gets the RenderSurfaceType attached property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Common.Extensions.SciChartSurfaceExtensions"> + <summary> + Defines set of extension methods for <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.Common.Extensions.SciChartSurfaceExtensions.ExportToXPS(SciChart.Charting.Visuals.SciChartSurface,System.String,System.Nullable{System.Windows.Size})"> + <summary> + Exports the surface into XPS document. + </summary> + <param name="surface"></param> + <param name="size">Output Size</param> + <param name="filePath">File path</param> + </member> + <member name="T:SciChart.Charting.Common.Extensions.ToggleButtonExtensions"> + <summary> + Attached property to mimic radio grouping on toggle buttons + Taken from here: http://www.bradcunningham.net/2009/09/grouping-and-checkboxes-in-wpf.html + </summary> + </member> + <member name="F:SciChart.Charting.Common.Extensions.ToggleButtonExtensions.GroupNameProperty"> + <summary> + Defines the GroupName DependenccyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Common.Extensions.ToggleButtonExtensions.SetGroupName(System.Windows.Controls.Primitives.ToggleButton,System.String)"> + <summary> + Sets the GroupName Attached Property + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.Common.Extensions.ToggleButtonExtensions.GetGroupName(System.Windows.Controls.Primitives.ToggleButton)"> + <summary> + Gets the GroupName Attached Property + </summary> + <param name="element"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Common.Helpers.ActionCommand`1"> + <summary> + Provides an ICommand derived class allowing delegates to be invokved directly on the view model + </summary> + <typeparam name="T">The Type of the command parameter</typeparam> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand`1.#ctor(System.Action{`0})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.Helpers.ActionCommand`1" /> class. + </summary> + <param name="execute">The execute delegate.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand`1.#ctor(System.Action{`0},System.Predicate{`0})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.Helpers.ActionCommand`1" /> class. + </summary> + <param name="execute">The execute delegate.</param> + <param name="canExecute">The can execute predicate.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand`1.CanExecute(System.Object)"> + <summary> + Defines the method that determines whether the command can execute in its current state. + </summary> + <param name="parameter">Data used by the command. If the command does not require data to be passed, this object can be set to null.</param> + <returns>true if this command can be executed; otherwise, false.</returns> + <remarks></remarks> + </member> + <member name="E:SciChart.Charting.Common.Helpers.ActionCommand`1.CanExecuteChanged"> + <summary> + Occurs when changes occur that affect whether or not the command should execute. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand`1.RaiseCanExecuteChanged"> + <summary> + Raises the CanExecuteChanged event + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand`1.Execute(System.Object)"> + <summary> + Defines the method to be called when the command is invoked. + </summary> + <param name="parameter">Data used by the command. If the command does not require data to be passed, this object can be set to null.</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Common.Helpers.ActionCommand"> + <summary> + Provides an ICommand derived class allowing delegates to be invokved directly on the view model + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand.#ctor(System.Action)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.Helpers.ActionCommand" /> class. + </summary> + <param name="execute">The execute delegate.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Common.Helpers.ActionCommand.#ctor(System.Action,System.Func{System.Boolean})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.Helpers.ActionCommand" /> class. + </summary> + <param name="execute">The execute.</param> + <param name="canExecute">The can execute delegate.</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Common.Helpers.AxisInfoTemplateSelector"> + <summary> + Provides class for choosing proper DataTemplate according to a <see cref="T:System.Type" /> of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /></summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.AxisInfoTemplateSelector.YAxisDataTemplateProperty"> + <summary> + Defines the YAxisDataTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.AxisInfoTemplateSelector.XAxisDataTemplateProperty"> + <summary> + Defines the XAxisDataTemplate DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.AxisInfoTemplateSelector.YAxisDataTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.AxisInfoTemplateSelector.XAxisDataTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.AxisInfoTemplateSelector.SelectTemplate(System.Object,System.Windows.DependencyObject)"> + <summary> + When overidden in derived classes, contains the logic for choosing a proper DataTemplate + </summary> + <param name="item"></param> + <param name="container"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Common.Helpers.AxisTitleTemplateSelector"> + <summary> + Used Internally by SciChart. Selects the Axis Title Template depending on title object type + </summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.AxisTitleTemplateSelector.StringTitleTemplate"> + <summary> + Gets or sets the standard String DataTemplate + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.AxisTitleTemplateSelector.SelectTemplate(System.Object,System.Windows.DependencyObject)"> + <summary> + When overidden in derived classes, contains the logic for choosing a proper DataTemplate + </summary> + <param name="item"></param> + <param name="container"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Common.Helpers.IDataTemplateSelector"> + <summary> + Defines base interface for DataTemplateSelector which is used for selecting DataTemplate + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.IDataTemplateSelector.SelectTemplate(System.Object,System.Windows.DependencyObject)"> + <summary> + Contains the logic for choosing a proper DataTemplate + </summary> + <param name="item"></param> + <param name="container"></param> + <returns></returns> + </member> + <member name="E:SciChart.Charting.Common.Helpers.IDataTemplateSelector.DataTemplateChanged"> + <summary> + Raised when one of DataTemplate properties changed + </summary> + </member> + <member name="T:SciChart.Charting.Common.Helpers.DataTemplateSelector"> + <summary> + Provides the base functionality for template selectors, used by the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + to select an appropriate <see cref="T:System.Windows.DataTemplate" /> for the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> type outputted by the modifiers (which is dependent on RenderableSeries type) + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.DataTemplateSelector.DefaultTemplateProperty"> + <summary> + Defines the DefaultTemplate DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.DataTemplateSelector.DefaultTemplate"> + <summary> + Gets or sets the template which is used as default + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.DataTemplateSelector.UpdateControlTemplate"> + <summary> + Forces an update of ControlTemplate due to known bug in Wpf 4 + </summary> + <remarks> + See http://social.msdn.microsoft.com/Forums/nl/wpf/thread/e6643abc-4457-44aa-a3ee-dd389c88bd86 for more info + </remarks> + </member> + <member name="M:SciChart.Charting.Common.Helpers.DataTemplateSelector.SelectTemplate(System.Object,System.Windows.DependencyObject)"> + <summary> + When overidden in derived classes, contains the logic for choosing a proper DataTemplate + </summary> + <param name="item"></param> + <param name="container"></param> + <returns></returns> + </member> + <member name="E:SciChart.Charting.Common.Helpers.DataTemplateSelector.DataTemplateChanged"> + <summary> + Raised when one of DataTemplate properties changed + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.DataTemplateSelector.OnContentChanged(System.Object,System.Object)"> + <summary> + Called when the <see cref="P:System.Windows.Controls.ContentControl.Content" /> property changes. + </summary> + <param name="oldContent">The old value of the <see cref="P:System.Windows.Controls.ContentControl.Content" /> property.</param> + <param name="newContent">The new value of the <see cref="P:System.Windows.Controls.ContentControl.Content" /> property.</param> + </member> + <member name="M:SciChart.Charting.Common.Helpers.DataTemplateSelector.OnDataTemplateChanged"> + <summary> + Raises the DataTemplateChanged event + </summary>` + </member> + <member name="T:SciChart.Charting.Common.Helpers.ExportException"> + <summary> + Exception that uses to give more detailed info if exporting issue occurs. + </summary> + </member> + <member name="T:SciChart.Charting.Common.Helpers.FrameworkVisibility"> + <summary> + Enumeration constants to define FrameworkVisibility + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.FrameworkVisibility.All"> + <summary> + Show this element in all frameworks + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.FrameworkVisibility.Wpf"> + <summary> + Show this element in WPF only + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.FrameworkVisibility.Silverlight"> + <summary> + Show this element in Silverlight only + </summary> + </member> + <member name="T:SciChart.Charting.Common.Helpers.FrameworkVisibilityManager"> + <summary> + Used to show or hide UIElements based on framework (WPF, Silverlight) + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.FrameworkVisibilityManager.VisibleInProperty"> + <summary> + Defines the VisibleIn DependencyProperty, used to set which frameworks (WPF, Silverlight, All) an element is visible in + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.FrameworkVisibilityManager.SetVisibleIn(System.Windows.DependencyObject,SciChart.Charting.Common.Helpers.FrameworkVisibility)"> + <summary> + Sets the VisibleIn DependencyProperty, used to set which frameworks (WPF, Silverlight, All) an element is visible in + </summary> + <param name="element">The element.</param> + <param name="visibleIn">The <see cref="T:SciChart.Charting.Common.Helpers.FrameworkVisibility" /> enum</param> + </member> + <member name="M:SciChart.Charting.Common.Helpers.FrameworkVisibilityManager.GetVisibleIn(System.Windows.DependencyObject)"> + <summary> + Gets the VisibleIn DependencyProperty, used to set which frameworks (WPF, Silverlight, All) an element is visible in + </summary> + <param name="element">The element.</param> + </member> + <member name="T:SciChart.Charting.Common.Helpers.PropertyAttributes.ShouldNotSerializeAttribute"> + <summary> + Attribute to define which property should be serialized + </summary> + </member> + <member name="T:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector"> + <summary> + Provides class for choosing proper DataTemplate according to a <see cref="T:System.Type" /> of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /></summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.HeatmapSeriesTemplateProperty"> + <summary> + Defines the HeatmapSeriesTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.BandSeries1TemplateProperty"> + <summary> + Defines the BandSeries1Template DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.BandSeries2TemplateProperty"> + <summary> + Defines the BandSeries2Template DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.BoxPlotSeriesTemplateProperty"> + <summary> + Defines the BoxPlotSeriesTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.OhlcSeriesTemplateProperty"> + <summary> + Defines the OhlcSeriesTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.HlcSeriesTemplateProperty"> + <summary> + Defines the HlcSeriesTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.OneHundredPercentStackedSeriesTemplateProperty"> + <summary> + Defines the OneHundredPercentStackedSeriesTemplate DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.HeatmapSeriesTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.BandSeries1Template"> + <summary> + Gets or sets the DataTemplate for the first series of the <see cref="T:SciChart.Charting.Model.ChartData.BandSeriesInfo" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.BandSeries2Template"> + <summary> + Gets or sets the DataTemplate for the second series of the <see cref="T:SciChart.Charting.Model.ChartData.BandSeriesInfo" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.BoxPlotSeriesTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Model.ChartData.OhlcSeriesInfo" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.OhlcSeriesTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Model.ChartData.OhlcSeriesInfo" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.HlcSeriesTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Model.ChartData.OhlcSeriesInfo" /></summary> + </member> + <member name="P:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.OneHundredPercentStackedSeriesTemplate"> + <summary> + Gets or sets the DataTemplate for <see cref="T:SciChart.Charting.Model.ChartData.OneHundredPercentStackedSeriesInfo" /></summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.SeriesInfoTemplateSelector.SelectTemplate(System.Object,System.Windows.DependencyObject)"> + <summary> + When overidden in derived classes, contains the logic for choosing a proper DataTemplate + </summary> + <param name="item"></param> + <param name="container"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Common.Helpers.Strategies.CommonRenderContextDrawingStrategy"> + <summary> + Draw ellipses using sprites + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.Strategies.CommonRenderContextDrawingStrategy.DrawPointMarkers(SciChart.Drawing.Common.IRenderContext2D,System.Windows.Media.Color,System.Windows.Media.Color,System.Windows.Size,System.Action{SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D})"> + <summary> + Create sprite for drawing point markers + </summary> + </member> + <member name="T:SciChart.Charting.Common.Helpers.Strategies.DrawingStrategy"> + <summary> + Base drawing ellipse strategy class + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.Strategies.DrawingStrategy.DrawPointMarkers(SciChart.Drawing.Common.IRenderContext2D,System.Windows.Media.Color,System.Windows.Media.Color,System.Windows.Size,System.Action{SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D})"> + <summary> + Draw ellipse according to concrete strategy + </summary> + </member> + <member name="M:SciChart.Charting.Common.Helpers.Strategies.XamlRenderContextDrawingStrategy.DrawPointMarkers(SciChart.Drawing.Common.IRenderContext2D,System.Windows.Media.Color,System.Windows.Media.Color,System.Windows.Size,System.Action{SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D})"> + <summary> + Create sprite for drawing point markers + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.AnnotationsBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.MarkupExtensions.SeriesBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AnnotationsBinding.Mode"> + <summary> + Update type + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AnnotationsBinding.UpdateSourceTrigger"> + <summary> + Binding mode + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AnnotationsBinding.RelativeSource"> + <summary> + Description of the object to use as the source, relative to the target element. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AnnotationsBinding.Path"> + <summary> + Gets or sets the path to the collection of IRenderableSeriesViewModels + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.AxesBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.MarkupExtensions.SeriesBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AxesBinding.Mode"> + <summary> + Update type + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AxesBinding.UpdateSourceTrigger"> + <summary> + Binding mode + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AxesBinding.RelativeSource"> + <summary> + Description of the object to use as the source, relative to the target element. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.AxesBinding.Path"> + <summary> + Gets or sets the path to the collection of IRenderableSeriesViewModels + </summary> + </member> + <member name="T:SciChart.Charting.Common.MarkupExtensions.IEffectManagerStub"> + <summary> + A stub interface which does nothing at all, but facilitate graceful obsolescence of the EffectManager.Instance property + </summary> + </member> + <member name="T:SciChart.Charting.Common.MarkupExtensions.EffectManager"> + <summary> + Provides an application wide way to enable or disable Drop Shadows application-wide + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.EffectManager.Instance"> + <summary> + Gets the instance of the EffectManager + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.EffectManager.EnableDropShadows"> + <summary> + When True (default) DropShadows are enabled application wide. When false, disabled. + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.SeriesBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.MarkupExtensions.SeriesBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.SeriesBinding.Mode"> + <summary> + Update type + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.SeriesBinding.UpdateSourceTrigger"> + <summary> + Binding mode + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.SeriesBinding.RelativeSource"> + <summary> + Description of the object to use as the source, relative to the target element. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.SeriesBinding.Path"> + <summary> + Gets or sets the path to the collection of IRenderableSeriesViewModels + </summary> + </member> + <member name="T:SciChart.Charting.Common.MarkupExtensions.ThemeBinding"> + <summary> + Used to provide dynamic bindings to <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> resources (Brushes, Colors) inside a SciChart Theme. For an example of use, + see the Default.xaml file in the source code + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.ThemeBinding.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.MarkupExtensions.ThemeBinding" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.ThemeBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.MarkupExtensions.ThemeBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.ThemeBinding.DefaultPath"> + <summary> + Gets or sets the path to the property on a <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.ThemeBinding.BindingsCollection"> + <summary> + Gets or sets collection bindings + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.ThemeBinding.Converter"> + <summary> + Gets or sets converter + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.ThemeBinding.ProvideValue(System.IServiceProvider)"> + <summary> + When implemented in a derived class, returns an object that is provided as the value of the target property for this markup extension. + </summary> + <param name="serviceProvider">A service provider helper that can provide services for the markup extension.</param> + <returns> + The object value to set on the property where the extension is applied. + </returns> + <exception cref="T:System.Exception">Not a DependencyObject</exception> + </member> + <member name="T:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding"> + <summary> + Creates a binding to a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding.Mode"> + <summary> + Binding mode + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding.UpdateSourceTrigger"> + <summary> + Update type + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding.RelativeSource"> + <summary> + Description of the object to use as the source, relative to the target element. + </summary> + </member> + <member name="P:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding.Path"> + <summary> + Gets or sets the path to the collection of IAnnotationViewModel + </summary> + </member> + <member name="M:SciChart.Charting.Common.MarkupExtensions.VerticalLinesBinding.ProvideValue(System.IServiceProvider)"> + <summary> + Provides the value for a binding expression + </summary> + </member> + <member name="T:SciChart.Charting.Common.SmartDisposable`1"> + <summary> + Wrap a Disposable type to ensure it gets disposed by the Finalizer, if not explictly disposed + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="M:SciChart.Charting.Common.SmartDisposable`1.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Charting.Common.StringlyTyped"> + <summary> + An abstract base-class that wraps a string, to avoid Stringly Typed circumstances where methods return or pass too many strings + </summary> + </member> + <member name="P:SciChart.Charting.Common.StringlyTyped.Value"> + <summary> + Gets the string value + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeriesExtensions"> + <summary> + Provides some helper methods for <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesExtensions.Remove``2(SciChart.Charting.Model.DataSeries.IDataSeries{``0,``1},``0)"> + <summary> + Removes the associated Y-Values for the specified X-Value. + </summary> + <param name="dataSeries">The series to remove from.</param> + <param name="x">The X DataValue to remove. Removes all associated Y-Values.</param> + <remarks>If the exact match of <paramref name="x" /> is not found in the <paramref name="dataSeries" />, removal doesn't occur.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesExtensions.Update``2(SciChart.Charting.Model.DataSeries.IXyDataSeries{``0,``1},``0,``1)"> + <summary> + Updates an X,Y point specified by the X-Value passed in. + </summary> + <param name="dataSeries">The series to update.</param> + <param name="x">The X Value to key on when updating.</param> + <param name="y">The new Y value.</param> + <remarks>If the exact match of <paramref name="x" /> is not found in the <paramref name="dataSeries" />, the update is ignored.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesExtensions.Update``2(SciChart.Charting.Model.DataSeries.IXyyDataSeries{``0,``1},``0,``1,``1)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified X-value. Automatically triggers a redraw. + </summary> + <param name="dataSeries">The series to update.</param> + <param name="x">The X-value.</param> + <param name="y0">The new Y0-value.</param> + <param name="y1">The new Y1-value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + <remarks>If the exact match of <paramref name="x" /> is not found in the <paramref name="dataSeries" />, the update is ignored.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesExtensions.Update``2(SciChart.Charting.Model.DataSeries.IHlcDataSeries{``0,``1},``0,``1,``1,``1)"> + <summary> + Updates an Open, High, Low, Close point specified by the X-Value passed in. + </summary> + <param name="dataSeries">The series to update.</param> + <param name="x">The X Value to key on when updating.</param> + <param name="y">The new Y value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + <remarks>If the exact match of <paramref name="x" /> is not found in the <paramref name="dataSeries" />, the update is ignored.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesExtensions.Update``2(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{``0,``1},``0,``1,``1,``1,``1)"> + <summary> + Updates an Open, High, Low, Close point specified by the X-Value passed in. + </summary> + <param name="dataSeries">The series to update.</param> + <param name="x">The X Value to key on when updating.</param> + <param name="open">The new Open value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="close">The new Close value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + <remarks>If the exact match of <paramref name="x" /> is not found in the <paramref name="dataSeries" />, the update is ignored.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesExtensions.Update``3(SciChart.Charting.Model.DataSeries.IXyzDataSeries{``0,``1,``2},``0,``1,``2)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified X-value. Automatically triggers a redraw. + </summary> + <param name="dataSeries">The series to update.</param> + <param name="x">The X-value.</param> + <param name="y">The new Y-value.</param> + <param name="z">The new Z-value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + <remarks>If the exact match of <paramref name="x" /> is not found in the <paramref name="dataSeries" />, the update is ignored.</remarks> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2"> + <summary> + A generic DataSeries which provides data in Min, Lower Quartile, Median, Upper Quartile, Max format for consumption + by the <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" />. + </summary> + <typeparam name="TX">The type of the X-data.</typeparam> + <typeparam name="TY">Tye type of the Y-data.</typeparam> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.YRange"> + <summary> + Gets the computed YRange, which is an <see cref="T:SciChart.Data.Model.IRange" /> wrapping YMin and YMax properties + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.HasValues"> + <summary> + Gets a value indicating whether this instance has values. + </summary> + <value> + <c>true</c> if this instance has values; otherwise, <c>false.</c>. + </value> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.DataSeriesType" /> for this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.SciChart#Charting#Model#DataSeries#IBoxPlotDataSeries#MedianValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.SciChart#Charting#Model#DataSeries#IBoxPlotDataSeries#MinimumValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.SciChart#Charting#Model#DataSeries#IBoxPlotDataSeries#MaximumValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.SciChart#Charting#Model#DataSeries#IBoxPlotDataSeries#UpperQuartileValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.SciChart#Charting#Model#DataSeries#IBoxPlotDataSeries#LowerQuartileValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.MedianValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.MinimumValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.MaximumValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.UpperQuartileValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.LowerQuartileValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index. + </summary> + <param name="index">The index to remove at.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index. + </summary> + <param name="startIndex">Starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.ToPointSeriesInternal(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory" /> instance.</param> + <param name="lastPointSeries">The last point series.</param> + <returns> + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> instance containing data about the data-point at the specified index. + </summary> + <param name="index">The index to the DataSeries.</param> + <returns>The HitTestInfo.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ.</exception> + <param name="x">The X Value.</param> + <param name="yValues">The Y Values (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ.</exception> + <param name="x">The list of X points.</param> + <param name="yValues">Lists of Y points (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Append(`0,`1,`1,`1,`1,`1)"> + <summary> + Appends an Box-plot point to the series, including X-value, Minimum, Lower Quartile, Median, Upper Quartile, Maximum value. + </summary> + <param name="x">The X value.</param> + <param name="median">The median.</param> + <param name="minimum">The minimum.</param> + <param name="lowerQuartile">The lower quartile.</param> + <param name="upperQuartile">The upper quartile.</param> + <param name="maximum">The maximum.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Append(`0,`1,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an Box-plot point to the series, including X-value, Minimum, Lower Quartile, Median, Upper Quartile, Maximum value. + </summary> + <param name="x">The X value.</param> + <param name="median">The median.</param> + <param name="minimum">The minimum.</param> + <param name="lowerQuartile">The lower quartile.</param> + <param name="upperQuartile">The upper quartile.</param> + <param name="maximum">The maximum.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a collection of Box-plot points to the series, including X-values, Minimum, Lower Quartile, Median, Upper Quartile, Maximum values. + </summary> + <param name="x">The X value.</param> + <param name="median">The median.</param> + <param name="minimum">The minimum.</param> + <param name="lowerQuartile">The lower quartile.</param> + <param name="upperQuartile">The upper quartile.</param> + <param name="maximum">The maximum.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a collection of Box-plot points to the series, including X-values, Minimum, Lower Quartile, Median, Upper Quartile, Maximum values. + </summary> + <param name="x">The X value.</param> + <param name="median">The median.</param> + <param name="minimum">The minimum.</param> + <param name="lowerQuartile">The lower quartile.</param> + <param name="upperQuartile">The upper quartile.</param> + <param name="maximum">The maximum.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMax">The existing maximum.</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMin">The existing minimum.</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin).</returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.CandlestickMetaData"> + <summary> + A metadata class that holds a collection of <see cref="T:SciChart.Charting.Model.ITick" /> instances. + It is used as metadata for a DataSeries rendered by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries" /> and <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataDistributionArgs"> + <summary> + Provides parameters to describe an X-Y dataset, for example, is the data sorted ascending in X, evenly spaced in X, or does it contain NaN values? + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataDistributionArgs.IsDataSortedAscending"> + <summary> + When true specifies the distribution of a data-set is sorted ascending in X + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataDistributionArgs.IsDataEvenlySpaced"> + <summary> + When true specifies the distribution of a data-set is evenly spaced in X + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataDistributionArgs.DoesDataContainNaN"> + <summary> + When true specifies that a data-set contains double.NaN or float.NaN + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.DataIsSortedAscending"> + <summary> + Gets whether this DataSeries contains Sorted data in the X-direction. + Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.DataIsEvenlySpaced"> + <summary> + Gets whether the data is evenly paced + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.MinXSpacing"> + <summary> + Gets the minimal spacing betwen X Values + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.DataContainsNaN"> + <summary> + Gets whether the data contains NaN values + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.OnAppend(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Int32,System.Boolean)"> + <summary> + Called when X Values are appended. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="yValues">The y values.</param> + <param name="appendedCount">The amount of points which were appended.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.OnInsert(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Int32,System.Int32,System.Boolean)"> + <summary> + Called when new values are inserted. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="yValues">The y values.</param> + <param name="indexWhereInserted">The index where the points were inserted.</param> + <param name="insertedCount">The amounts of points which were inserted.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.OnUpdate(SciChart.Data.Model.ISciList{`1},System.Int32,System.Int32,System.Boolean)"> + <summary> + Called when yValues are updated. Should update the Data Distribution flags + </summary> + <param name="yValues"></param> + <param name="indexWhereUpdated">The index where the points were updated.</param> + <param name="updatedCount">The amount of points which were updated.</param> + <param name="acceptsUnsortedData"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.OnRemove(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Boolean)"> + <summary> + Called when X Values are inserted. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BaseDataDistributionCalculator`2.Clear"> + <summary> + Clears the DataDistributionCalculator flags + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IDataDistributionProvider"> + <summary> + Defines the interface to a DataDistributionProvider which provides different information about DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataDistributionProvider.DataIsSortedAscending"> + <summary> + Gets whether this DataSeries contains Sorted data in the X-direction. + Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataDistributionProvider.DataIsEvenlySpaced"> + <summary> + Gets whether the X data is evenly spaced + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataDistributionProvider.DataContainsNaN"> + <summary> + Gets whether the Y data contains NaN values + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2"> + <summary> + Defines the interface to a DataDistributionCalculator + </summary> + <typeparam name="TX"></typeparam> + <typeparam name="TY"></typeparam> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2.MinXSpacing"> + <summary> + Gets the minimal spacing between X Values + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2.OnAppend(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Int32,System.Boolean)"> + <summary> + Called when X Values are appended. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="yValues">The y values.</param> + <param name="appendedCount">The amount of points which were appended.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2.OnInsert(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Int32,System.Int32,System.Boolean)"> + <summary> + Called when new values are inserted. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="yValues">The y values.</param> + <param name="indexWhereInserted">The index where the points were inserted.</param> + <param name="insertedCount">The amounts of points which were inserted.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2.OnUpdate(SciChart.Data.Model.ISciList{`1},System.Int32,System.Int32,System.Boolean)"> + <summary> + Called when yValues are updated. Should update the Data Distribution flags + </summary> + <param name="yValues"></param> + <param name="indexWhereUpdated">The index where the points were updated.</param> + <param name="updatedCount">The amount of points which were updated.</param> + <param name="acceptsUnsortedData"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2.OnRemove(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Boolean)"> + <summary> + Called when values are removed. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataDistributionCalculator`2.Clear"> + <summary> + Clears the DataDistributionCalculator flags + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2"> + <summary> + Allows user provided flags for IsSortedAscending and IsEvenlySpaced, flags which are used to determine the correct algorithm for sorting, searching and data-compression in SciChart. + Overridding these flags allows for faster operation where the data distribution is known in advance + </summary> + <typeparam name="TX">The type of the x-data.</typeparam> + <typeparam name="TY">The type of the y-data.</typeparam> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.IsSortedAscending"> + <summary> + Gets or sets if the data is sorted + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.IsEvenlySpaced"> + <summary> + Gets or sets if the data is evenly spaced, within a visual epsilon (typically 1.0/8000.0 of the default spacing) + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.ContainsNaN"> + <summary> + Gets or sets if the data cointains NaN values + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.OnAppend(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Int32,System.Boolean)"> + <summary> + Called when X Values are appended. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="yValues">The y values.</param> + <param name="appendedCount">The amount of points which were appended.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.OnInsert(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Int32,System.Int32,System.Boolean)"> + <summary> + Called when new values are inserted. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="yValues">The y values.</param> + <param name="indexWhereInserted">The index where the points were inserted.</param> + <param name="insertedCount">The amounts of points which were inserted.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.OnUpdate(SciChart.Data.Model.ISciList{`1},System.Int32,System.Int32,System.Boolean)"> + <summary> + Called when yValues are updated. Should update the Data Distribution flags + </summary> + <param name="yValues"></param> + <param name="indexWhereUpdated">The index where the points were updated.</param> + <param name="updatedCount">The amount of points which were updated.</param> + <param name="acceptsUnsortedData"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.UserDefinedDistributionCalculator`2.OnRemove(SciChart.Data.Model.ISciList{`0},SciChart.Data.Model.ISciList{`1},System.Boolean)"> + <summary> + Called when X Values are inserted. Should update the Data Distribution flags + </summary> + <param name="xValues">The x values.</param> + <param name="acceptsUnsortedData">if set to <c>true</c> the series accepts unsorted data.</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeries`2"> + <summary> + A generic abstract base class which defines a generic DataSeries which contains 1..N columns, + such as X,Y in the case of plain X,Y data, or X, Open, High, Low, Close in the case of OHLC data. + </summary> + <typeparam name="TX">The type of the X-Data.</typeparam> + <typeparam name="TY">The type of the Y-Data.</typeparam> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> will be redrawn</remarks> + </member> + <member name="E:SciChart.Charting.Model.DataSeries.DataSeries`2.DataSeriesChanged"> + <summary> + Event raised whenever points are added to, removed or one or more DataSeries properties changes + </summary> + <remarks></remarks> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeries`2._xColumn"> + <summary> + The XColumn for this DataSeries + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeries`2._yColumn"> + <summary> + The primary YColumn for this DataSeries + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeries`2._metaColumn"> + <summary> + The metadata column for this DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.SyncRoot"> + <summary> + Synchronization object (per instance) + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataDistributionCalculator"> + <summary> + Gets or Sets the DataDistrutionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm + </summary> + <remarks>By default, SciChart provides a DataDistributionCalculator which calculates if data is sorted appending, or evenly spaced as you append data. + However, this process takes approximately 30% of the time to append data (or more if appending in blocks). If you know in advance what the distribution of your data will be, + you can set the DataDistributionCalculator = new UserDefinedDistributionCalculator and set the flags yourself </remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.MinXSpacing"> + <summary> + Gets the minimal spacing between X Values + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.Tag"> + <summary> + Gets or sets an arbitrary tag on the DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> which this <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> instance is attached to + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.XType"> + <summary> + Gets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.YType"> + <summary> + Gets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.XRange"> + <summary> + Gets the computed XRange, which is an <see cref="T:SciChart.Data.Model.IRange" /> wrapping XMin and XMax properties + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.YRange"> + <summary> + Gets the computed YRange, which is an <see cref="T:SciChart.Data.Model.IRange" /> wrapping YMin and YMax properties + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.YMin"> + <summary> + Gets the computed Minimum value in Y for this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.LatestYValue"> + <summary> + Gets the latest Y-Value of the DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.YMax"> + <summary> + Gets the computed Maximum value in Y for this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.XMin"> + <summary> + Gets the computed Minimum value in X for this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.XMax"> + <summary> + Gets the computed Maximum value in X for this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.Count"> + <summary> + Gets the number of points in this data series + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.AcceptsUnsortedData"> + <summary> + New to v3.3: when AcceptsUnsortedData is false, the DataSeries with throw an InvalidOperationException if unsorted data is appended. Unintentional unsorted data can result in much slower performance. + To disable this check, set AcceptsUnsortedData = true. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.SeriesName"> + <summary> + Gets or sets the name of this series + </summary> + <value>The name of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.IsAttached"> + <summary> + Gets a value indicating whether this instance is attached. + </summary> + <value> + <c>true</c> if this instance is attached; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataSeriesType" /> for this DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.Item(SciChart.Charting.Model.DataSeries.DataSeriesColumn,System.Int32)"> + <summary> + Gets the item at the index from the specified <see cref="T:SciChart.Charting.Model.DataSeries.DataSeriesColumn" />. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.HasValues"> + <summary> + Gets whether the <see cref="N:SciChart.Charting.Model.DataSeries" /> has values (is not empty) + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.HasMetadata"> + <summary> + Gets whether the <see cref="N:SciChart.Charting.Model.DataSeries" /> contains points' metadata + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.XValues"> + <summary> + Gets the X Values of this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.SciChart#Charting#Model#DataSeries#IDataSeries#XValues"> + <summary> + Gets the X Values of this dataseries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.YValues"> + <summary> + Gets the Y Values of this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.SciChart#Charting#Model#DataSeries#IDataSeries#YValues"> + <summary> + Gets the Y Values of this dataseries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.Metadata"> + <summary> + Gets the Metadata of this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.IsFifo"> + <summary> + Gets whether the dataseries behaves as a FIFO + If True, when the FifoCapacity is reached, old points will be + discarded in favour of new points + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.IsSorted"> + <summary> + Gets whether this DataSeries contains Sorted data in the X-direction. + Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataIsSortedAscending"> + <summary> + Gets whether this DataSeries contains Sorted data in the X-direction. + Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataIsEvenlySpaced"> + <summary> + Gets whether the data is evenly paced + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataContainsNaN"> + <summary> + Gets whether the data contains NaN values + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.FifoCapacity"> + <summary> + Gets or sets the size of the FIFO buffer. + If null, then the dataseries is unlimited. + If a value is set, when the point count reaches this value, older points will be discarded + </summary> + <value>The fifo capacity.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ</exception> + <param name="x">The X Value</param> + <param name="yValues">The Y Values (depends on series type)</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ</exception> + <param name="x">The list of X points</param> + <param name="yValues">Lists of Y points (depends on series type)</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index + </summary> + <param name="index">The index to remove at</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index + </summary> + <param name="startIndex">Starting index of the range of elements to remove</param> + <param name="count">The number of elements to remove</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.AppendMetadata(SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends a single metadata value to the end of the <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.Metadata" /> list. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.ChangeCount"> + <summary> + Gets the change count for this data series. Allows to indentify when data series was changed + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.Clear"> + <summary> + Clears the series, resetting internal lists to zero size. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetIndicesRange(SciChart.Data.Model.IRange,SciChart.Charting.Common.Extensions.SearchMode,SciChart.Charting.Common.Extensions.SearchMode)"> + <inheritdoc cref="M:SciChart.Charting.Model.DataSeries.IDataSeries.GetIndicesRange(SciChart.Data.Model.IRange,SciChart.Charting.Common.Extensions.SearchMode,SciChart.Charting.Common.Extensions.SearchMode)" /> + <remarks>By default, expands PointRange to provide correct rendering for continuous series on the edges.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ToPointSeries(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The PointResamplerFactory which returns <see cref="!:IPointResampler" /> instances</param> + <param name="lastPointSeries">The last resampled point series</param> + <returns> + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetWindowedYRange(SciChart.Data.Model.IRange)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /></summary> + <param name="xRange">The X-Axis Range currently in view</param> + <returns> + The YRange of the data in this window + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetWindowedYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /></summary> + <param name="xRange">The X-Axis Range currently in view</param> + <param name="getPositiveRange">Indicates whether to return positive YRange only</param> + <returns>The YRange of the data in this window</returns> + <exception cref="T:System.ArgumentNullException">xRange</exception> + <exception cref="T:System.InvalidOperationException">Invalid Range Type. Please ensure you are using DateTimeAxis where the X-Data is DateTime, and NumericAxis where the X-Data is Double, Float, Int, Long</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetWindowedYRange(SciChart.Data.Model.IndexRange)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns + </summary> + <param name="xIndexRange">The X-Axis Indices currently in view</param> + <returns> + The YRange of the data in this window + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetWindowedYRange(SciChart.Data.Model.IndexRange,System.Boolean)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns + </summary> + <param name="xIndexRange">The X-Axis Indices currently in view</param> + <param name="getPositiveRange">Indicates whether to return positive YRange only</param> + <returns> + The YRange of the data in this window + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.FindIndex(System.IComparable,SciChart.Charting.Common.Extensions.SearchMode)"> + <summary> + Finds the index to the DataSeries at the specified X-Value + </summary> + <param name="x">The X-value to search for</param> + <param name="searchMode">The <see cref="T:SciChart.Charting.Common.Extensions.SearchMode" /> options to use. Default is exact, where -1 is returned if the index is not found</param> + <returns> + The index of the found value + </returns> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing data about the data-point at the specified index + </summary> + <param name="index">The index to the DataSeries</param> + <returns>The HitTestInfo</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode,System.Boolean)"> + <summary> + May be called to trigger a redraw on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. This method is extremely useful + when <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> are in a ViewModel and bound via MVVM to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + Please see the <paramref name="rangeMode" /> parameter for invalidation options + </summary> + <param name="rangeMode">Provides <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> invalidation options for the parent surface</param> + <param name="hasDataChanged">if set to <c>true</c> this tells the DataSeries that data has changed, and any cached values must be recreated.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetPositiveMin``1(``0,``0)"> + <summary> + Gets the minimum positive value of (positiveMin, min) + </summary> + <param name="positiveMin"></param> + <param name="min"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingYMin">The existing minimum</param> + <returns> + The new YMin, which is the Min(existingYMin, currentMin) + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingYMax">The existing maximum</param> + <returns> + The new YMax, which is the Min(existingYMax, currentMax) + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.GetXMinAt(System.Int32,`0)"> + <summary> + When overriden in a derived class, gets the Min(existingXMin, currentMin), where currentMin is the minimum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingXMin">The existing minimum</param> + <returns>The new XMin, which is the Min(existingXMin, currentMin)</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.OnDataSeriesChanged(SciChart.Charting.Model.DataSeries.DataSeriesUpdate,SciChart.Charting.Model.DataSeries.DataSeriesAction,System.Int32,System.Int32)"> + <summary> + Raises the <see cref="E:SciChart.Charting.Model.DataSeries.DataSeries`2.DataSeriesChanged" /> event + </summary> + <param name="dataSeriesUpdate">The data series update.</param> + <param name="dataSeriesAction">The data series action</param> + <param name="startIndex">The start index</param> + <param name="changedItemsCount">The changed items count.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ThrowWhenAppendInvalid(System.Int32)"> + <summary> + Asserts correct number of parameters supplied to Append(TX, params TY) and throws if necessary + </summary> + <param name="paramsCount">The expected params count</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ThrowWhenParamsAreNull"> + <summary> + Asserts that lists of X values and Y values are not null and throws if necessary + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ThrowWhenParamsHaveDifferentSize"> + <summary> + Asserts that lists of X values and Y values have the same number of values and throws if necessary + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeries`2.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.FindClosestPoint(System.IComparable,System.IComparable,System.Double,System.Double)"> + <summary> + Finds the closest point to a point with given X and Y value. Search region is a vertical area with center in X and [maxXDistance] X units to left and right + </summary> + <param name="xValue">The X-value of point [X data units, not pixels]</param> + <param name="yValue">The Y-value of point [Y data units, not pixels]</param> + <param name="xyScaleRatio">xUnitsPerPixel/yUnitsPerPixel</param> + <param name="hitTestRadius">Specifies search region in chart coordinates(ticks for DateTime or TimeSpan)</param> + <returns> + The index of the found value, -1 if not found (when count is zero) + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.FindClosestLine(System.IComparable,System.IComparable,System.Double,System.Double,SciChart.Charting.Visuals.RenderableSeries.LineDrawMode)"> + <summary> + Finds the closest line to a point with given X and Y value. Search region is a vertical area with center in X and [maxXDistance] X units to left and right + </summary> + <param name="x">The X-value of point [X data units, not pixels]</param> + <param name="y">The Y-value of point [Y data units, not pixels]</param> + <param name="xyScaleRatio">xUnitsPerPixel/yUnitsPerPixel</param> + <param name="xRadius">specifies search region in X units (ticks for DateTime or TimeSpan)</param> + <param name="drawNanAs">specifies how to handle NAN elements</param> + <returns> + The index of first point in line, -1 if not found (when count is zero) + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.Recreate``1(SciChart.Data.Model.ISciList{``0},System.Int32)"> + <summary> + Recreates a column with capacity + </summary> + <typeparam name="T"></typeparam> + <param name="column"></param> + <param name="capacity"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.RecreateAsFifo``1(SciChart.Data.Model.ISciList{``0},System.Int32)"> + <summary> + Recreates a column with Fifo capacity + </summary> + <typeparam name="T"></typeparam> + <param name="column"></param> + <param name="fifoSize"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.UpdateResamplingParams(SciChart.Data.Numerics.PointResamplers.ResamplingParams@)"> + <summary> + Updates passed in <see cref="T:SciChart.Data.Numerics.PointResamplers.ResamplingParams" /> with current DataSeries state + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.CacheResamplingParams(SciChart.Data.Numerics.PointResamplers.ResamplingParams)"> + <summary> + Stores passed in <see cref="T:SciChart.Data.Numerics.PointResamplers.ResamplingParams" /> to be during the next resampling pass + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeries`2.ResetCachedResamplingParams"> + <summary> + Resets cached resampling parameters + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeriesUpdate"> + <summary> + Constants to define the type of update when the <see cref="E:SciChart.Charting.Model.DataSeries.IDataSeries.DataSeriesChanged" /> event is raised + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesUpdate.DataChanged"> + <summary> + The underlying data has changed + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesUpdate.DataSeriesCleared"> + <summary> + The Data Series has been cleared + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesUpdate.SelectionChanged"> + <summary> + The selected points have been changed + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeriesAction"> + <summary> + Describes an action that caused a <see cref="E:SciChart.Charting.Model.DataSeries.IDataSeries.DataSeriesChanged" /> event + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.None"> + <summary> + Data Series items were not changed + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.Append"> + <summary> + An item was appended to the Data Series + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.Update"> + <summary> + An item was from Data Series was updated + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.Insert"> + <summary> + An item was inserted to the Data Series + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.Remove"> + <summary> + An item was removed from Data Series + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.Clear"> + <summary> + Data Series was cleared + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesAction.Reset"> + <summary> + The content of the collection changed dramatically + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs"> + <summary> + Event args used by event <see cref="E:SciChart.Charting.Model.DataSeries.IDataSeries.DataSeriesChanged" /> event + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs.DataSeriesUpdate"> + <summary> + Gets the type of <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> Update + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs.DataSeriesAction"> + <summary> + Gets the type of <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> Action + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs.StartIndex"> + <summary> + Gets the start index where changes were applied + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs.ChangedItemsCount"> + <summary> + Gets amount of changed items + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs.#ctor(SciChart.Charting.Model.DataSeries.DataSeriesUpdate)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs" /> class. + </summary> + <param name="dataSeriesUpdate">The data series update type.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs.#ctor(SciChart.Charting.Model.DataSeries.DataSeriesUpdate,SciChart.Charting.Model.DataSeries.DataSeriesAction,System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs" /> class. + </summary> + <param name="dataSeriesUpdate">The data series update type.</param> + <param name="dataSeriesAction">The data series action type.</param> + <param name="startIndex">The start index where changes were applied</param> + <param name="changedItemsCount">The amount of chanegd items</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeriesColumn"> + <summary> + Defines enumeration constants for accessing columns in a <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /></summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesColumn.X"> + <summary> + The X column + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesColumn.Y"> + <summary> + The Y column + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesColumn.Open"> + <summary> + The open column + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesColumn.Close"> + <summary> + The close column + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesColumn.High"> + <summary> + The high column + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesColumn.Low"> + <summary> + The low column + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DataSeriesType"> + <summary> + Enumeration constants to define the Type of <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /></summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Xy"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> contains Xy data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Ohlc"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> contains OHLC data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Xyy"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> contains Xyy data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Xyz"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> contains Xyz data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Hlc"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> contains XyError data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Box"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> contains Box (Minimum, Lower Quartile, Median, Upper Quartile, Maximum) data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.StackedXy"> + <summary> + The <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> contains Box (Minimum, Lower Quartile, Median, Upper Quartile, Maximum) data + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.Heatmap"> + <summary> + The <see cref="!:Heatmap2DArrayDataSeries<TX,TY,TZ>" /> contains data from 2D array + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.DataSeriesType.OneHundredPercentStackedXy"> + <summary></summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries"> + <summary> + Provides a common interface to all heatmap data series types in SciChart. Declares common operations with heatmaps. + See <see cref="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.UniformHeatmapDataSeries`3" /> + See <see cref="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.NonUniformHeatmapDataSeries`3" /> + See <see cref="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3" /></summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.Metadata"> + <summary> + Gets a 2D array of <see cref="T:SciChart.Charting.Model.DataSeries.IPointMetadata" />, if presents. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.ArrayWidth"> + <summary> + Returns one dimension of a heatmap. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.ArrayHeight"> + <summary> + Returns one dimension of a heatmap. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.ZType"> + <summary> + Returns the type of the Z values of a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.ToHitTestInfo(System.IComparable,System.IComparable)"> + <summary> + Returns heatmap details for given <param name="xValue" />, <param name="yValue" />. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetXIndex(System.IComparable)"> + <summary> + Returns the X index of this value on a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetYIndex(System.IComparable)"> + <summary> + Returns the Y index of this value on a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetXValue(System.Int32)"> + <summary> + Returns a start X value of the corresponding heatmap cell. + </summary> + <param name="xIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetYValue(System.Int32)"> + <summary> + Returns a start Y value of the corresponding heatmap cell. + </summary> + <param name="yIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetZValue(System.Int32,System.Int32)"> + <summary> + Returns the Z value of the corresponding heatmap cell. + </summary> + <param name="yIndex">Index of the heatmap cell.</param> + <param name="xIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetXIndicesRange(SciChart.Data.Model.IRange)"> + <summary> + Returns the X index range for the given X data range on a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.GetYIndicesRange(SciChart.Data.Model.IRange)"> + <summary> + Returns the Y index range for the given Y data range on a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.UpdateZValue(System.Int32,System.Int32,System.IComparable)"> + <summary> + Updates Z value for the given X and Y indexes on a heatmap + </summary> + <param name="xIndex">Index of the heatmap cell</param> + <param name="yIndex">Index of the heatmap cell</param> + <param name="zValue">New Z value</param> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeriesInternal.ZMinDouble"> + <summary> + Returns the minimal Z value as double. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeriesInternal.ZMaxDouble"> + <summary> + Returns the maximal Z value as double. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeriesInternal.GetZValuesAsDoubles"> + <summary> + Gets the heatmap Z-values (2D Array of type TZ[,]) as a readonly array of type double[,]. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeriesInternal.GetXValueAsDouble(System.Int32)"> + <summary> + Returns an X value at the given index on a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeriesInternal.GetYValueAsDouble(System.Int32)"> + <summary> + Returns a Y value at the given index on a heatmap. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.Tag"> + <summary> + Gets or sets an arbitrary tag on the DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.OptimizeForNonDoubleZValues"> + <summary> + Property is used to keep better performance with non double type ZValues. + Note: if set to true with non double ZValues type then method <see cref="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IHeatmapDataSeries.UpdateZValue(System.Int32,System.Int32,System.IComparable)" /> or updating ZValues array by reference has no effect. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.SciChart#Charting#Model#DataSeries#Heatmap2DArrayDataSeries#IHeatmapDataSeries#UpdateZValue(System.Int32,System.Int32,System.IComparable)"> + <summary> + Update ZValue + </summary> + <param name="xIndex"></param> + <param name="yIndex"></param> + <param name="zValue"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.UpdateZValue(System.Int32,System.Int32,`2)"> + <summary> + Update ZValue + </summary> + <param name="xIndex"></param> + <param name="yIndex"></param> + <param name="zValue"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.SciChart#Charting#Model#DataSeries#Heatmap2DArrayDataSeries#IHeatmapDataSeries#GetXValue(System.Int32)"> + <summary> + Returns a start X value of the corresponding heatmap cell. + </summary> + <param name="xIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.SciChart#Charting#Model#DataSeries#Heatmap2DArrayDataSeries#IHeatmapDataSeries#GetYValue(System.Int32)"> + <summary> + Returns a start Y value of the corresponding heatmap cell. + </summary> + <param name="yIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.SciChart#Charting#Model#DataSeries#Heatmap2DArrayDataSeries#IHeatmapDataSeries#GetZValue(System.Int32,System.Int32)"> + <summary> + Returns the Z value of the corresponding heatmap cell. + </summary> + <param name="yIndex">Index of the heatmap cell.</param> + <param name="xIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.GetZValue(System.Int32,System.Int32)"> + <summary> + Returns the Z value of the corresponding heatmap cell. + </summary> + <param name="yIndex">Index of the heatmap cell.</param> + <param name="xIndex">Index of the heatmap cell.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode,System.Boolean)"> + <summary> + May be called to trigger a redraw on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. This method is extremely useful + May be called to trigger a redraw on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. This method is extremely useful + when <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> are in a ViewModel and bound via MVVM to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + Please see the <paramref name="rangeMode" /> parameter for invalidation options + </summary> + <param name="rangeMode">Provides <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> invalidation options for the parent surface</param> + <param name="hasDataChanges">if set to <c>true</c> [has data changes].</param> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued. + </summary> + <returns> + The disposable <see cref="T:SciChart.Core.Framework.IUpdateSuspender" />. + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by <see cref="T:SciChart.Core.Framework.IUpdateSuspender" />. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.DecrementSuspend"> + <summary> + Called by <see cref="T:SciChart.Core.Framework.IUpdateSuspender" /> each time a target suspender is disposed. When the final + target suspender has been disposed, <see cref="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.BaseHeatmapDataSeries`3.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)" /> is called. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.NonUniformHeatmapDataSeries`1"> + <summary> + Represents a static 2D array as <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> to be displayed by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.NonUniformHeatmapDataSeries`1.#ctor(`0[0:,0:],System.Func{System.Int32,`0},System.Func{System.Int32,`0},SciChart.Charting.Model.DataSeries.IPointMetadata[0:,0:])"> + <summary> + Creates as instance of the <see cref="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.NonUniformHeatmapDataSeries`1" /> type. + </summary> + <param name="zValues">Specifies heatmap values.</param> + <param name="xMapping">Defines the heatmap mapping to X data range.</param> + <param name="yMapping">Defines the heatmap mapping to Y data range.</param> + <param name="metadata">Specifies an optional metadata array.</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.NonUniformHeatmapDataSeries`3"> + <summary> + Represents a static 2D array as <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> to be displayed by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeries" />. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IUniformHeatmapDataSeries"> + <summary> + Provides the interface for <see cref="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.UniformHeatmapDataSeries`3" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IUniformHeatmapDataSeries.XStart"> + <summary> + Returns the first X value of a heatmap. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IUniformHeatmapDataSeries.XStep"> + <summary> + Returns the value of the step (offset) of a heatmap in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IUniformHeatmapDataSeries.YStart"> + <summary> + Returns the first Y value of a heatmap. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.IUniformHeatmapDataSeries.YStep"> + <summary> + Returns the value of the step (offset) of a heatmap in the Y direction. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.UniformHeatmapDataSeries`3"> + <summary> + Represents a static 2D array as <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> to be displayed by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.UniformHeatmapDataSeries`3.#ctor(`2[0:,0:],`0,`0,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata[0:,0:])"> + <summary> + Creates and initializes an instance of <see cref="T:SciChart.Charting.Model.DataSeries.Heatmap2DArrayDataSeries.UniformHeatmapDataSeries`3" />. + </summary> + <param name="zValues"></param> + <param name="xStart"></param> + <param name="xStep"></param> + <param name="yStart"></param> + <param name="yStep"></param> + <param name="metadata"></param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.DoubleToColorMappingSettings"> + <summary> + Contains settings to translate double value into color for heatmap + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IHeatmap2DArrayDataSeries"> + <summary> + Represents 2D color data for Array2DSegment + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`1"> + <summary> + Provides an HlcDataSeries which has TX,TY type = <typeparamref name="TAllPoints" />. See the documentation for <see cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /></summary> + <typeparam name="TAllPoints">The type of all points.</typeparam> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2"> + <summary> + The HlcDataSeries provides a generic data-source in High-Low-Close format for Hlc charts as well as Error bar charts. See also <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + which requires this <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> type as a Data-source. Any 2D renderable Series type such as <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> will render the X-Close value + as X-Y. + </summary> + <typeparam name="TX"></typeparam> + <typeparam name="TY"></typeparam> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.SciChart#Charting#Model#DataSeries#IHlcDataSeries#HighValues"> + <summary> + Gets the High Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.HighValues"> + <summary> + Gets the High Values of this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.SciChart#Charting#Model#DataSeries#IHlcDataSeries#LowValues"> + <summary> + Gets the Low Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.LowValues"> + <summary> + Gets the Low Values of this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.YRange"> + <summary> + Gets the computed YRange, which is an <see cref="T:SciChart.Data.Model.IRange" /> wrapping YMin and YMax properties. + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.HasValues"> + <summary> + Gets a value indicating whether this instance has values. + </summary> + <value> + <c>true</c> if this instance has values; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.DataSeriesType" /> for this DataSeries. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing data about the data-point at the specified index. + </summary> + <param name="index">The index to the DataSeries.</param> + <returns>The HitTestInfo.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index. + </summary> + <param name="index">The index to remove at.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index. + </summary> + <param name="startIndex">Starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.ToPointSeriesInternal(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory" /> instance.</param> + <param name="lastPointSeries">The last point series.</param> + <returns> + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ.</exception> + <param name="x">The X Value.</param> + <param name="yValues">The Y Values (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ.</exception> + <param name="x">The list of X points.</param> + <param name="yValues">Lists of Y points (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Append(`0,`1,`1,`1)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Append(`0,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="y">The list of Y values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="y">The list of Y values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Update(System.Int32,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates an Open, High, Low, Close point at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Update(System.Int32,`1,`1,`1)"> + <summary> + Updates an Open, High, Low, Close point at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The low value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The low value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="y">The list of y values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="y">The list of y values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="metadata">The list of metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMax">The existing maximum.</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcDataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMin">The existing minimum.</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin).</returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries"> + <summary> + Defines the interface to <see cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" />, which provides data in Min, Lower Quartile, Median, Upper Quartile, Max format for consumption. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries.MedianValues"> + <summary> + Gets the Median Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries.MinimumValues"> + <summary> + Gets the Minimum Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries.MaximumValues"> + <summary> + Gets the Maximum Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries.UpperQuartileValues"> + <summary> + Gets the Upper Quartile Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries.LowerQuartileValues"> + <summary> + Gets the Lower Quartile Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries`2"> + <inheritdoc cref="T:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries" /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries`2.MedianValues"> + <summary> + Gets the Median Values of this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries`2.MinimumValues"> + <summary> + Gets the Minimum Values of this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries`2.MaximumValues"> + <summary> + Gets the Maximum Values of this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries`2.UpperQuartileValues"> + <summary> + Gets the Upper Quartile Values of this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IBoxPlotDataSeries`2.LowerQuartileValues"> + <summary> + Gets the Lower Quartile Values of this DataSeries. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IDataSeries"> + <summary> + Defines the base interface to a DataSeries which provides a data-source for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="E:SciChart.Charting.Model.DataSeries.IDataSeries.DataSeriesChanged"> + <summary> + Event raised whenever points are added to, removed or one or more DataSeries properties changes. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.Tag"> + <summary> + Gets or sets an arbitrary tag on the DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.XType"> + <summary> + Gets the Type of X-data points in this DataSeries. Used to check compatibility with Axis types. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.YType"> + <summary> + Gets the Type of Y-data points in this DataSeries. Used to check compatibility with Axis types. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> which this <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> instance is attached to. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> in the X direction. + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.YRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> in the Y direction. + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.DataSeriesType" /> for this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.XValues"> + <summary> + Gets the XValues of this dataseries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues"> + <summary> + Gets the YValues of this dataseries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.Metadata"> + <summary> + Gets the metadata. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.LatestYValue"> + <summary> + Gets the latest Y-Value of the DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.SeriesName"> + <summary> + Gets or sets the name of this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.YMin"> + <summary> + Gets the computed Minimum value in Y for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.YMax"> + <summary> + Gets the computed Maximum value in Y for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.XMin"> + <summary> + Gets the computed Minimum value in X for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.XMax"> + <summary> + Gets the computed Maximum value in X for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.IsFifo"> + <summary> + Gets whether the dataseries behaves as a FIFO. + If True, when the FifoCapacity is reached, old points will be + discarded in favour of new points, resulting in a scrolling chart. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.FifoCapacity"> + <summary> + Gets or sets the size of the FIFO buffer. + If null, then the dataseries is unlimited. + If a value is set, when the point count reaches this value, older points will be discarded. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.HasValues"> + <summary> + Gets whether the DataSeries has values(is not empty). + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.HasMetadata"> + <summary> + Gets whether the DataSeries contains metadata for any point(is not empty). + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.Count"> + <summary> + Gets the number of points in this dataseries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.IsSorted"> + <summary> + Gets whether this DataSeries contains Sorted data in the X-direction. + Note: Sorted data will result in far faster indexing operations. If at all possible, try to keep your data sorted in the X-direction. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.MinXSpacing"> + <summary> + Gets the minimal spacing between X Values + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.SyncRoot"> + <summary> + Gets a synchronization object used to lock this data-series. Also locked on append, update, remove or clear. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.AcceptsUnsortedData"> + <summary> + New to v3.3: when AcceptsUnsortedData is false, the DataSeries with throw an InvalidOperationException if unsorted data is appended. Unintentional unsorted data can result in much slower performance. + To disable this check, set AcceptsUnsortedData = true. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries.ChangeCount"> + <summary> + Gets the change count for this data series. Allows to indentify when data series was changed + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.Clear"> + <summary> + Clears the series, resetting internal lists to zero size. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.GetIndicesRange(SciChart.Data.Model.IRange,SciChart.Charting.Common.Extensions.SearchMode,SciChart.Charting.Common.Extensions.SearchMode)"> + <summary> + Gets the integer indices of the XValues array that are currently in the VisibleRange passed in, + and an indefinite range otherwise. + </summary> + <example>If the input X-data is 0...99 in steps of 1, the VisibleRange is (10, 30) then the Indices Range will be 10, 30.</example> + <param name="visibleRange">The VisibleRange to get the indices range.</param> + <param name="downSearchMode">Specifies the search mode used to look for the index of <paramref name="visibleRange.Min.Min" />.</param> + <param name="upSearchMode">Specifies the search mode used to look for the index of <paramref name="visibleRange.Max.Max" />.</param> + <returns>The indices to the X-Data that are currently in range.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.ToPointSeries(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The PointResamplerFactory which returns <see cref="!:IPointResampler" /> instances.</param> + <param name="lastPointSeries">The last resampled point series</param> + <returns>A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.GetWindowedYRange(SciChart.Data.Model.IRange)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" />. + </summary> + <param name="xRange">The X-Axis Range currently in view.</param> + <returns>The YRange of the data in this window.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.GetWindowedYRange(SciChart.Data.Model.IndexRange)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns. + </summary> + <param name="xIndexRange">The X-Axis Indices currently in view.</param> + <returns>The YRange of the data in this window.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.GetWindowedYRange(SciChart.Data.Model.IndexRange,System.Boolean)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input IndexRange, where indices are point-indices on the DataSeries columns. + </summary> + <param name="xIndexRange">The X-Axis Indices currently in view.</param> + <param name="getPositiveRange">If true, returns an <seealso cref="T:SciChart.Data.Model.IRange" /> which only has positive values, e.g, when viewing a Logarithmic chart this value might be set.</param> + <returns>The YRange of the data in this window.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.GetWindowedYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Gets the YRange of the data (min, max of the series) in the input visible range point range, where the input range is the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" />. + </summary> + <param name="xRange">The X-Axis Range currently in view.</param> + <param name="getPositiveRange">If true, returns an <seealso cref="T:SciChart.Data.Model.IRange" /> which only has positive values, e.g, when viewing a Logarithmic chart this value might be set.</param> + <returns>The YRange of the data in this window.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.FindIndex(System.IComparable,SciChart.Charting.Common.Extensions.SearchMode)"> + <summary> + Finds the index to the DataSeries at the specified X-Value. + </summary> + <param name="x">The X-value to search for.</param> + <param name="searchMode">The <see cref="T:SciChart.Charting.Common.Extensions.SearchMode" /> options to use. Default is exact, where -1 is returned if the index is not found.</param> + <returns>The index of the found value.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing data about the data-point at the specified index. + </summary> + <param name="index">The index to the DataSeries.</param> + <returns>The HitTestInfo.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode,System.Boolean)"> + <summary> + May be called to trigger a redraw on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. This method is extremely useful + when <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> are in a ViewModel and bound via MVVM to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + Please see the <paramref name="rangeMode" /> parameter for invalidation options. + </summary> + <param name="rangeMode">Provides <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> invalidation options for the parent surface.</param> + <param name="hasDataChanged">if set to <c>true</c> this tells the DataSeries that data has changed, and any cached values must be recreated.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.FindClosestPoint(System.IComparable,System.IComparable,System.Double,System.Double)"> + <summary> + Finds the closest point to a point with given X and Y value. Search region is a vertical area with center in X and [maxXDistance] X units to left and right. + </summary> + <param name="x">The X-value of point [X data units, not pixels].</param> + <param name="y">The Y-value of point [Y data units, not pixels].</param> + <param name="xyScaleRatio">xUnitsPerPixel/yUnitsPerPixel.</param> + <param name="maxXDistance">specifies search region in X units (ticks for DateTime or TimeSpan).</param> + <returns>The index of the found value, -1 if not found (when count is zero).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries.FindClosestLine(System.IComparable,System.IComparable,System.Double,System.Double,SciChart.Charting.Visuals.RenderableSeries.LineDrawMode)"> + <summary> + Finds the closest line to a point with given X and Y value. Search region is a vertical area with center in X and [maxXDistance] X units to left and right. + </summary> + <param name="x">The X-value of point [X data units, not pixels].</param> + <param name="y">The Y-value of point [Y data units, not pixels].</param> + <param name="xyScaleRatio">xUnitsPerPixel/yUnitsPerPixel.</param> + <param name="xRadius">specifies search region in X units (ticks for DateTime or TimeSpan).</param> + <param name="drawNanAs">specifies how to handle NAN elements.</param> + <returns>The index of first point in line, -1 if not found (when count is zero).</returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IDataSeries`2"> + <summary> + Defines the Generic interface to a DataSeries which provides a data-source to a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. + </summary> + <typeparam name="TX">The type of the X-Data.</typeparam> + <typeparam name="TY">The type of the Y-Data.</typeparam> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries`2.XValues"> + <summary> + Gets the X Values of this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries`2.YValues"> + <summary> + Gets the Y Values of this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IDataSeries`2.DataDistributionCalculator"> + <summary> + Gets or Sets the DataDistrutionCalculator instance for this DataSeries. Used when resampling data to determine the correct algorithm + </summary> + <remarks>By default, SciChart provides a DataDistributionCalculator which calculates if data is sorted appending, or evenly spaced as you append data. + However, this process takes approximately 30% of the time to append data (or more if appending in blocks). If you know in advance what the distribution of your data will be, + you can set the DataDistributionCalculator = new UserDefinedDistributionCalculator and set the flags yourself </remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ.</exception> + <param name="x">The X value.</param> + <param name="yValues">The Y values (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ.</exception> + <param name="x">The list of X points.</param> + <param name="yValues">Lists of Y points (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes a point at the specified index. + </summary> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index. + </summary> + <param name="startIndex">Starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + Used internally by AutoRanging algorithm. + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMin">The existing minimum.</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IDataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + Used internally by AutoRanging algorithm. + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMax">The existing maximum.</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax).</returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries"> + <summary> + Defines the interface to a High-Low-Close DataSeries, which contains columns of X-Values and Y-Values, High-Values and Low-Values. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IHlcDataSeries.HighValues"> + <summary> + Gets the High Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IHlcDataSeries.LowValues"> + <summary> + Gets the Low Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2"> + <summary> + Defines the interface to a typed High-Low-Close DataSeries, which contains columns of X-Values and Y-Values, High-Values and Low-Values. + </summary> + <typeparam name="TX">The type of the X-data.</typeparam> + <typeparam name="TY">The type of the Y-data.</typeparam> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.HighValues"> + <summary> + Gets the High Values of this DataSeries, if the data is OHLC. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.LowValues"> + <summary> + Gets the Low Values of this DataSeries, if the data is OHLC. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Append(`0,`1,`1,`1)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Append(`0,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="y">The list of Y values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="y">The list of Y values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="metadata">The list of metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Update(System.Int32,`1,`1,`1)"> + <summary> + Updates an Open, High, Low, Close at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Update(System.Int32,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates an Open, High, Low, Close at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The low value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="high">The High value.</param> + <param name="low">The low value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="y">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="y">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="metadata">The list of metadata.</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries"> + <summary> + Defines the interface to an OHLC DataSeries, a series containing Open, High, Low, Close data-points. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IOhlcDataSeries.OpenValues"> + <summary> + Gets the Open Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IOhlcDataSeries.CloseValues"> + <summary> + Gets the Close Values of this DataSeries as a List of <see cref="T:System.IComparable" />. + </summary> + <remarks>Close equates to Y Values in either OHLC or simple XY dataseries.</remarks> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2"> + <summary> + Defines the typed interface to an OHLC DataSeries, a series containing Open, High, Low, Close data-points. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.OpenValues"> + <summary> + Gets the Open Values of this DataSeries, if the data is OHLC. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.HighValues"> + <summary> + Gets the High Values of this DataSeries, if the data is OHLC. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.LowValues"> + <summary> + Gets the Low Values of this DataSeries, if the data is OHLC. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.CloseValues"> + <summary> + Gets the Close Values of this DataSeries, if the data is OHLC. + </summary> + <remarks>Close equates to Y Values in either OHLC or simple XY dataseries.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Append(`0,`1,`1,`1,`1)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="open">The Open value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + <param name="close">The Close value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Append(`0,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="open">The Open value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + <param name="close">The Close value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Update(System.Int32,`1,`1,`1,`1)"> + <summary> + Updates an Open, High, Low, Close at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="open">The new Open value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="close">The new Close value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Update(System.Int32,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates an Open, High, Low, Close at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="open">The new Open value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="close">The new Close value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1,`1)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="open">The Open value.</param> + <param name="high">The High value.</param> + <param name="low">The low value.</param> + <param name="close">The close value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="open">The Open value.</param> + <param name="high">The High value.</param> + <param name="low">The low value.</param> + <param name="close">The close value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + <param name="metadata">The list of metadata values.</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IPointMetadata"> + <summary> + IPointMetadata is the base interface for PointMetadata derived types. By creating a class which implements this interface, you can tag an X-Y point on a DataSeries with any business object + </summary> + <example> + <code title="PointMetadata Example" description="Demonstrates how to create PointMetadata and append to a DataSeries" lang="cs"> + // Create the IPointMetadata derived type + public class MyMetadata : IPointMetadata + { + public event PropertyChangedEventHandler PropertyChanged; + + public MyMetadata(string label) + { + this.Label = label; + } + + public bool IsSelected { get; set; } + public string Label { get; set; } + } + + // Append it to DataSeries + void Foo() + { + var xyDataSeries = new XyDataSeries<double>(); + xyDataSeries.Append(0, 10, new MyMetadata("Hello")); + xyDataSeries.Append(1, 20, null); + xyDataSeries.Append(2, 30, new MyMetadata("World!")); + } + </code> + </example> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier" /> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IPointMetadata.IsSelected"> + <summary> + Gets or sets a value indicating whether data-point is currently selected. Selection is used by the <see cref="T:SciChart.Charting.ChartModifiers.DataPointSelectionModifier" /></summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IXyDataSeries"> + <summary> + Defines the interface to an Xy DataSeries, which contains columns of X-Values and Y-Values. + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2"> + <summary> + Defines the interface to a typed Xy DataSeries, which contains columns of X-Values and Y-Values. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Append(`0,`1)"> + <summary> + Appends an X, Y point to the series. + </summary> + <param name="x">The X Value.</param> + <param name="y">The Y Value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Append(`0,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an X, Y point to the series. + </summary> + <param name="x">The X Value.</param> + <param name="y">The Y Value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and y differ.</exception> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and y differ.</exception> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + <param name="metadata">The list of points' metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Update(System.Int32,`1)"> + <summary> + Updates an X,Y point specified by the X-Value passed in. + </summary> + <param name="index">The index to update at.</param> + <param name="y">The new Y value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Update(System.Int32,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates an X,Y point specified by the index passed in. + </summary> + <param name="index">The index to update at.</param> + <param name="y">The new Y value.</param> + <param name="metadata">The new metadata object.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Insert(System.Int32,`0,`1)"> + <summary> + Inserts an X,Y point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.Insert(System.Int32,`0,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an X,Y point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a list of X, Y points at the specified index. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and y differ.</exception> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a list of X, Y points at the specified index. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and y differ.</exception> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + <param name="metadata">The list of points' metadata.</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries"> + <summary> + Defines the interface to an Xyy DataSeries, a series containing X, Y0 and Y1 data-points + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IXyyDataSeries.Y1Values"> + <summary> + Gets the Y1 Values as a list of <see cref="T:System.IComparable" /></summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2"> + <summary> + Defines the templated interface to an Xyy DataSeries, a series containing X, Y0 and Y1 data-points + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2.Y1Values"> + <summary> + Gets the Y1 values + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2.Append(`0,`1,`1)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw + </summary> + <param name="x">The X-value</param> + <param name="y0">The Y0-value</param> + <param name="y1">The Y1-value</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw + </summary> + <param name="x">The X-values</param> + <param name="y0">The Y0-values</param> + <param name="y1">The Y1-values</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2.Update(System.Int32,`1,`1)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y0">The new Y0-value.</param> + <param name="y1">The new Y1-value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2.Insert(System.Int32,`0,`1,`1)"> + <summary> + Inserts an X, Y0, Y1 point at the specified index. Automatically triggers a redraw + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X-value</param> + <param name="y0">The Y0-value</param> + <param name="y1">The Y1-value</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a collection of X, Y0 and Y1 points at the specified index, automatically triggering a redraw + </summary> + <param name="startIndex">The index to insert at</param> + <param name="x">The X-values</param> + <param name="y0">The Y0-values</param> + <param name="y1">The Y1-values</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries"> + <summary> + Provides the interface to a <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> to hold X,Y,Z values. Used as a data-source for the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" />, + if this DataSeries is assigned to any other X-Y type, then the X-Y values will be rendered (Z ignored). + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IXyzDataSeries.ZValues"> + <summary> + Gets the Z Values as a list of <see cref="T:System.IComparable" /></summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3"> + <summary> + Provides a generic interface to a <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> to hold X,Y,Z values. Used as a data-source for the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" />, + if this DataSeries is assigned to any other X-Y type, then the X-Y values will be rendered (Z ignored). + </summary> + <typeparam name="TX">The type of the X-data.</typeparam> + <typeparam name="TY">The type of the Y-data.</typeparam> + <typeparam name="TZ">The type of the Z-data.</typeparam> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.ZValues"> + <summary> + Gets the Z values. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Append(`0,`1,`2)"> + <summary> + Appends a single X, Y, Z point to the series, automatically triggering a redraw. + </summary> + <param name="x">The X-value.</param> + <param name="y">The Y-value.</param> + <param name="z">The Z-value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Append(`0,`1,`2,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends a single X, Y, Z point to the series, automatically triggering a redraw. + </summary> + <param name="x">The X-value.</param> + <param name="y">The Y-value.</param> + <param name="z">The Z-value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2})"> + <summary> + Appends a collection of X, Y and Z points to the series, automatically triggering a redraw. + </summary> + <param name="x">The X-values.</param> + <param name="y">The Y-values.</param> + <param name="z">The Z-values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a collection of X, Y and Z points to the series, automatically triggering a redraw. + </summary> + <param name="x">The X-values.</param> + <param name="y">The Y-values.</param> + <param name="z">The Z-values.</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Update(System.Int32,`1,`2)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y-value.</param> + <param name="z">The new Z-value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Update(System.Int32,`1,`2,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y-value.</param> + <param name="z">The new Z-value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Insert(System.Int32,`0,`1,`2)"> + <summary> + Inserts an X, Y, Z point at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X-value.</param> + <param name="y">The y-value.</param> + <param name="z">The z-value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.Insert(System.Int32,`0,`1,`2,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an X, Y, Z point at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X-value.</param> + <param name="y">The y-value.</param> + <param name="z">The z-value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2})"> + <summary> + Inserts a collection of X, Y and Z points at the specified index, automatically triggering a redraw. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The X-values.</param> + <param name="y">The Y-values.</param> + <param name="z">The Z-values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a collection of X, Y and Z points at the specified index, automatically triggering a redraw. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The X-values.</param> + <param name="y">The Y-values.</param> + <param name="z">The Z-values.</param> + /// <param name="metadata">The metadata values.</param></member> + <member name="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2"> + <summary> + A DataSeries to store OHLC data-points, containing X and Y-Open, Y-High, Y-Low, Y-Close values. + May be used as a DataSource for <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> and <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> as well as standard XY renderable series types + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.YRange"> + <summary> + Gets the computed YRange, which is an <see cref="T:SciChart.Data.Model.IRange" /> wrapping YMin and YMax properties + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.SciChart#Charting#Model#DataSeries#IOhlcDataSeries#OpenValues"> + <summary> + Gets the Open Values of this DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.SciChart#Charting#Model#DataSeries#IHlcDataSeries#HighValues"> + <summary> + Gets the High Values of this DataSeries as a List of <see cref="T:System.IComparable" /></summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.SciChart#Charting#Model#DataSeries#IHlcDataSeries#LowValues"> + <summary> + Gets the Low Values of this DataSeries as a List of <see cref="T:System.IComparable" /></summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.SciChart#Charting#Model#DataSeries#IOhlcDataSeries#CloseValues"> + <summary> + Gets the Close Values of this DataSeries as a List of <see cref="T:System.IComparable" /></summary> + <remarks>Close equates to Y Values in either OHLC or simple XY dataseries</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.OpenValues"> + <summary> + Gets the Open Values of this DataSeries, if the data is OHLC + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.HighValues"> + <summary> + Gets the High Values of this DataSeries, if the data is OHLC + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.LowValues"> + <summary> + Gets the Low Values of this DataSeries, if the data is OHLC + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.CloseValues"> + <summary> + Gets the Close Values of this DataSeries, if the data is OHLC + </summary> + <remarks>Close equates to Y Values in either OHLC or simple XY dataseries</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.HasValues"> + <summary> + Gets whether the Data Series has values (is not empty) + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.DataSeriesType" /> for this DataSeries + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing data about the data-point at the specified index + </summary> + <param name="index">The index to the DataSeries</param> + <returns>The HitTestInfo</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index + </summary> + <param name="index">The index to remove at</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index + </summary> + <param name="startIndex">Starting index of the range of elements to remove</param> + <param name="count">The number of elements to remove</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.ToPointSeriesInternal(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory" /> instance.</param> + <param name="lastPointSeries">The last point series.</param> + <returns> + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ.</exception> + <param name="x">The X Value.</param> + <param name="yValues">The Y Values (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ.</exception> + <param name="x">The list of X points.</param> + <param name="yValues">Lists of Y points (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Append(`0,`1,`1,`1,`1)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="open">The Open value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + <param name="close">The Close value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Append(`0,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an Open, High, Low, Close point to the series. + </summary> + <param name="x">The X value.</param> + <param name="open">The Open value.</param> + <param name="high">The High value.</param> + <param name="low">The Low value.</param> + <param name="close">The Close value.</param> + /// <param name="metadata">The metadata.</param></member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a list of Open, High, Low, Close points to the series. + </summary> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Update(System.Int32,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates an Open, High, Low, Close at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="open">The new Open value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="close">The new Close value.</param> + /// <param name="metadata">The new metadata value.</param><exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception></member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Update(System.Int32,`1,`1,`1,`1)"> + <summary> + Updates an Open, High, Low, Close at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="open">The new Open value.</param> + <param name="high">The new High value.</param> + <param name="low">The new Low value.</param> + <param name="close">The new Close value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1,`1)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X value</param> + <param name="open">The Open value</param> + <param name="high">The High value</param> + <param name="low">The low value</param> + <param name="close">The close value</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.Insert(System.Int32,`0,`1,`1,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an Open, High, Low, Close point at the specified index + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X value</param> + <param name="open">The Open value</param> + <param name="high">The High value</param> + <param name="low">The low value</param> + <param name="close">The close value</param> + <param name="metadata">The metadata value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a list of Open, High, Low, Close points at the specified index. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X values.</param> + <param name="open">The list of Open values.</param> + <param name="high">The list of High values.</param> + <param name="low">The list of Low values.</param> + <param name="close">The list of Close values.</param> + <param name="metadata">The list of Metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingYMax">The existing maximum</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax)</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingYMin">The existing minimum</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin)</returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint"> + <summary> + A structure to contain OHLC series point values + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.#ctor(System.Int32,System.Double,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint" /> struct. + </summary> + <param name="open">The open value.</param> + <param name="high">The high value.</param> + <param name="low">The low value.</param> + <param name="close">The close value.</param> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.Index"> + <summary> + Gets the index of the point in the containing <see cref="!:IGenericPointSeries<TY>" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.X"> + <summary> + Gets the X value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.Open"> + <summary> + Gets the open value + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.High"> + <summary> + Gets the high value + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.Low"> + <summary> + Gets the low value + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint.Close"> + <summary> + Gets the close value + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.BoxPointSeries"> + <summary> + An internal concept - the <see cref="T:SciChart.Data.Model.IPointSeries" /> provides a sequence of <see cref="!:ISeriesPoint<T>" /> derived + types, which represent resampled data immediately before rendering. + + The <see cref="T:SciChart.Charting.Model.DataSeries.BoxPointSeries" /> specifically is used when resampling and rendering Box Plot points + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPointSeries.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.BoxPointSeries" /> class. + </summary> + <param name="yValues">The resampled y Values.</param> + <param name="minValues">The resampled min Values.</param> + <param name="lowerValues">The resampled lower quartile Values.</param> + <param name="upperValues">The resampled upper quartile Values.</param> + <param name="maxValues">The max Values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.BoxPointSeries.GetYRange"> + <summary> + Gets the min, max range in the Y-Direction + </summary> + <returns> + A <see cref="T:SciChart.Data.Model.DoubleRange" /> defining the min, max in the Y-direction + </returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.HlcPointSeries"> + <summary> + An internal concept - the <see cref="T:SciChart.Data.Model.IPointSeries" /> provides a sequence of <see cref="!:ISeriesPoint<T>" /> derived + types, which represent resampled data immediately before rendering. + + The <see cref="T:SciChart.Charting.Model.DataSeries.HlcPointSeries" /> specifically is used when resampling and rendering points for Error Bars and HLC charts + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcPointSeries.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.HlcPointSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcPointSeries.HighValues"> + <summary> + Gets the High values. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcPointSeries.LowValues"> + <summary> + Gets the Low values. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.HlcPointSeries.CloseValues"> + <summary> + Gets the Close values. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.HlcPointSeries.GetYRange"> + <summary> + Gets the min, max range in the Y-Direction + </summary> + <returns> + A <see cref="T:SciChart.Data.Model.DoubleRange" /> defining the min, max in the Y-direction + </returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.OhlcPointSeries"> + <summary> + An internal concept - the <see cref="T:SciChart.Data.Model.IPointSeries" /> provides a sequence of <see cref="!:ISeriesPoint<T>" /> derived + types, which represent resampled data immediately before rendering. + + The <see cref="T:SciChart.Charting.Model.DataSeries.OhlcPointSeries" /> specifically is used when resampling and rendering OhlcDataSeries + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcSeriesPoint" /> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyzPointSeries"> + <summary> + An internal concept - the <see cref="T:SciChart.Data.Model.IPointSeries" /> provides a sequence of <see cref="!:ISeriesPoint<T>" /> derived + types, which represent resampled data immediately before rendering. + + The <see cref="T:SciChart.Charting.Model.DataSeries.XyzPointSeries" /> specifically is used when resampling and rendering points for an <see cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + any other series-type which requires one X-value, Y-value and Z-value + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzPointSeries.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyzPointSeries" /> class. + </summary> + <param name="yPoints">The y points.</param> + <param name="zPoints">The z points.</param> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyzPointSeries.ZPoints"> + <summary> + Gets the y1 points. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzPointSeries.GetYRange"> + <summary> + Gets the min, max range in the Y-Direction + </summary> + <returns> + A <see cref="T:SciChart.Data.Model.DoubleRange" /> defining the min, max in the Y-direction + </returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel"> + <summary> + Defines the interface to a single data point in <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IRadarPointViewModel.AxisId"> + <summary> + Gets or sets the ID of a <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> this point is associated with. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IRadarPointViewModel.DataValue"> + <summary> + Gets or sets the data value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.IRadarPointViewModel.IsSelected"> + <summary> + Gets or sets value, indicates whether this <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> is selected + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.RadarPointViewModel"> + <summary> + Represents a single data point in <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.RadarPointViewModel.AxisId"> + <summary> + Gets or sets the ID of a <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> this point is associated with. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.RadarPointViewModel.DataValue"> + <summary> + Gets or sets the data value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.RadarPointViewModel.IsSelected"> + <summary> + Gets or sets value, indicates whether this <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> is selected + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.RangeMode"> + <summary> + Defines enumeration constants for a programmatic redraw of the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.RangeMode.None"> + <summary> + Perform no ranging, just redraw + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.RangeMode.ZoomToFit"> + <summary> + Perform full X and Y ranging on redraw + </summary> + </member> + <member name="F:SciChart.Charting.Model.DataSeries.RangeMode.ZoomToFitY"> + <summary> + Perform just Y ranging on redraw + </summary> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyDataSeries`1"> + <summary> + An implementation of <see cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> where TX and TY are the same type (TAllPoints) + + e.g. var dataSeries = new XyDataSeries{double}() + + is equivalent to + + var dataSeries = new XyDataSeries{double, double}() + </summary> + <typeparam name="TAllPoints">The type of all points.</typeparam> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`1.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`1" /> class. + </summary> + <param name="capacity">The initial memory capacity</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`1.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`1" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`1.#ctor(`0[],`0[],System.Boolean,System.Nullable{SciChart.Charting.Model.DataSeries.DataDistributionArgs})"> + <summary> + This overloaded constructor accepts prepopulated XValues, YValues arrays which may come from other parts of your application. + <para>The reference to these arrays is re-used inside the XyDataSeries, to prevent copying or creating new memory in SciChart to hold your data.</para><para>Note that if you update the xValues, yValues, you need to call <see cref="M:SciChart.Charting.Model.DataSeries.DataSeries`2.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode,System.Boolean)" /> with parameter hasDataChanges=true.</para><para>Methods like <see cref="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(`0,`1)" /> will still work but note that may cause the internal array to be recreated, disconnecting it from your passed in xValues and yValues.</para></summary> + <param name="xValues">The pre-populated XValues array. Must not be null.</param> + <param name="yValues">The pre-populated YValues array. Must not be null.</param> + <param name="acceptsUnsortedData">When true, the DataSeries accepts unsorted data. When false, it will throw </param> + <param name="dataDistributionArgs">When this flag is null, SciChart will automatically calculate data distribution flags on the provided data, including <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataIsSortedAscending" />, + <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataIsEvenlySpaced" /> and <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataContainsNaN" />. When provided, the user-provided flags will be used and this calculation will be skipped (faster).</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2"> + <summary> + A DataSeries to store Xy data-points, containing X and Y values which must be sorted in the X-direction. + May be used as a DataSource for <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> as well as standard XY renderable series types. + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.#ctor(`0[],`1[],System.Boolean,System.Nullable{SciChart.Charting.Model.DataSeries.DataDistributionArgs})"> + <summary> + This overloaded constructor accepts prepopulated XValues, YValues arrays which may come from other parts of your application. + <para>The reference to these arrays is re-used inside the XyDataSeries, to prevent copying or creating new memory in SciChart to hold your data.</para><para>Note that if you update the xValues, yValues, you need to call <see cref="M:SciChart.Charting.Model.DataSeries.DataSeries`2.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode,System.Boolean)" /> with parameter hasDataChanges=true.</para><para>Methods like <see cref="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(`0,`1)" /> will still work but note that may cause the internal array to be recreated, disconnecting it from your passed in xValues and yValues.</para></summary> + <param name="xValues">The pre-populated XValues array. Must not be null.</param> + <param name="yValues">The pre-populated YValues array. Must not be null.</param> + <param name="acceptsUnsortedData">When true, the DataSeries accepts unsorted data. When false, it will throw </param> + <param name="dataDistributionArgs">When this flag is null, SciChart will automatically calculate data distribution flags on the provided data, including <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataIsSortedAscending" />, + <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataIsEvenlySpaced" /> and <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.DataContainsNaN" />. When provided, the user-provided flags will be used and this calculation will be skipped (faster).</param> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Capacity"> + <summary> + <para>Gets or sets the capacity of the XyDataSeries, allowing you to pre-reserve memory.</para> + <para>NOTE: changing the capacity will result in data being cleared</para> + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyDataSeries`2.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.XyDataSeries`2.DataSeriesType" /> for this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyDataSeries`2.HasValues"> + <summary> + Gets whether the Data Series has values (is not empty). + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.ToPointSeriesInternal(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory" /> instance.</param> + <param name="lastPointSeries">The last point series: memory may be re-used.</param> + <returns> + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index. + </summary> + <param name="index">The index to remove at.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index. + </summary> + <param name="startIndex">Starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ.</exception> + <param name="x">The X Value</param> + <param name="yValues">The Y Values (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ.</exception> + <param name="x">The list of X points.</param> + <param name="yValues">Lists of Y points (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(`0,`1)"> + <summary> + Appends an X, Y point to the series. + </summary> + <param name="x">The X Value.</param> + <param name="y">The Y Value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(`0,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends an X, Y, Metadata point to the series. + </summary> + <param name="x">The X Value.</param> + <param name="y">The Y Value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a list of X, Y, Metadata points to the series. + </summary> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + <param name="metadata">The list of points' metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Update(System.Int32,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates the X,Y point at the specified index. + </summary> + <param name="index">The index of the data value to update.</param> + <param name="y">The new Y value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Update(System.Int32,`1)"> + <summary> + Updates the X,Y point at the specified index. + </summary> + <param name="index">The index of the data value to update.</param> + <param name="y">The new Y value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.Insert(System.Int32,`0,`1)"> + <summary> + Inserts an X,Y point at the specified index. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y">The Y value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a list of X, Y points at the specified index. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and y differ.</exception> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a list of X, Y points at the specified index. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and y differ.</exception> + <param name="startIndex">The index to insert at.</param> + <param name="x">The list of X points.</param> + <param name="y">The list of Y points.</param> + <param name="metadata">The list of points' metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + Used internally by AutoRanging algorithm. + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMin">The existing minimum.</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyDataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + Used internally by AutoRanging algorithm. + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMax">The existing maximum.</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax).</returns> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`1"> + <summary> + A DataSeries to store Xyy data-points, containing X and Y0, Y1 values. + May be used as a DataSource for <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> as well as standard XY renderable series types. + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2"> + <summary> + A DataSeries to store Xyy data-points, containing X and Y0, Y1 values. + May be used as a DataSource for <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> as well as standard XY renderable series types. + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn.</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.YRange"> + <summary> + Gets the computed YRange, which is an <see cref="T:SciChart.Data.Model.IRange" /> wrapping YMin and YMax properties. + </summary> + <remarks>Note: The performance implications of calling this is the DataSeries will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once.</remarks> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.DataSeriesType" /> for this DataSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.SciChart#Charting#Model#DataSeries#IXyyDataSeries#Y1Values"> + <summary> + Gets the Y1 Values as a list of <see cref="T:System.IComparable" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Y1Values"> + <summary> + Gets the Y1 values. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.HasValues"> + <summary> + Gets whether the Data Series has values (is not empty). + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index. + </summary> + <param name="index">The index to remove at.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index. + </summary> + <param name="startIndex">Starting index of the range of elements to remove.</param> + <param name="count">The number of elements to remove.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Clone"> + <summary> + Creates a deep copy of a DataSeries. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.GetYMinAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMin">The existing minimum.</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.GetYMaxAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index. + </summary> + <param name="index">The index to the underlying dataset.</param> + <param name="existingYMax">The existing maximum.</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax).</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.ToPointSeriesInternal(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory" /> instance.</param> + <param name="lastPointSeries">The last point series.</param> + <returns> + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series. + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing data about the data-point at the specified index. + </summary> + <param name="index">The index to the DataSeries.</param> + <returns>The HitTestInfo.</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series. + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ.</exception> + <param name="x">The X Value.</param> + <param name="yValues">The Y Values (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series. + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ.</exception> + <param name="x">The list of X points.</param> + <param name="yValues">Lists of Y points (depends on series type).</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Append(`0,`1,`1)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw. + </summary> + <param name="x">The X value.</param> + <param name="y0">The Y0 value.</param> + <param name="y1">The Y1 value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Append(`0,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw. + </summary> + <param name="x">The X value.</param> + <param name="y0">The Y0 value.</param> + <param name="y1">The Y1 value.</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw. + </summary> + <param name="x">The X values.</param> + <param name="y0">The Y0 values.</param> + <param name="y1">The Y1 values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw. + </summary> + <param name="x">The X values.</param> + <param name="y0">The Y0 values.</param> + <param name="y1">The Y1 values.</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Update(System.Int32,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates (overwrites) the X,Y0,Y1,Metadata values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y0">The new Y0-value.</param> + <param name="y1">The new Y1-value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Update(System.Int32,`1,`1)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y0">The new Y0-value.</param> + <param name="y1">The new Y1-value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Insert(System.Int32,`0,`1,`1)"> + <summary> + Inserts an X, Y0, Y1 point at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X value.</param> + <param name="y0">The Y0 value.</param> + <param name="y1">The Y1 value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.Insert(System.Int32,`0,`1,`1,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an X, Y0, Y1 point at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index to insert at.</param> + <param name="x">The X-value.</param> + <param name="y0">The Y0-value.</param> + <param name="y1">The Y1-value.</param> + <param name="metadata">The metadata value.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1})"> + <summary> + Inserts a collection of X, Y0 and Y1 points at the specified index, automatically triggering a redraw. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The X values.</param> + <param name="y0">The Y0 values.</param> + <param name="y1">The Y1 values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyyDataSeries`2.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a collection of X, Y0 and Y1 points at the specified index, automatically triggering a redraw. + </summary> + <param name="startIndex">The index to insert at.</param> + <param name="x">The X values.</param> + <param name="y0">The Y0 values.</param> + <param name="y1">The Y1 values.</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`1"> + <summary> + Provides an XyzDataSeries which has X,Y,Z type = <typeparamref name="TAllPoints" />. See the documentation for <see cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /></summary> + <typeparam name="TAllPoints">The type of all points.</typeparam> + </member> + <member name="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3"> + <summary> + Provides a generic <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> to hold X,Y,Z values. Used as a data-source for the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" />, + if this DataSeries is assigned to any other X-Y type, then the X-Y values will be rendered (Z ignored). + </summary> + <typeparam name="TX">The type of the X-data</typeparam> + <typeparam name="TY">The type of the Y-data</typeparam> + <typeparam name="TZ">The type of the Z-data</typeparam> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn</remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.DataSeriesType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.DataSeriesType" /> for this DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.SciChart#Charting#Model#DataSeries#IXyzDataSeries#ZValues"> + <summary> + Gets the Z Values as a list of <see cref="T:System.IComparable" /></summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.ZValues"> + <summary> + Gets the Z values + </summary> + </member> + <member name="P:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.HasValues"> + <summary> + Gets whether the Data Series has values (is not empty) + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y values at the specified index + </summary> + <param name="index">The index to remove at</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index + </summary> + <param name="startIndex">Starting index of the range of elements to remove</param> + <param name="count">The number of elements to remove</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Clone"> + <summary> + Creates a deep copy of a DataSeries + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.GetYMinAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Min(existingYMin, currentMin), where currentMin is the minimum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingYMin">The existing minimum</param> + <returns>The new YMin, which is the Min(existingYMin, currentMin)</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.GetYMaxAt(System.Int32,`1)"> + <summary> + When overriden in a derived class, gets the Max(existingYMax, currentMax), where currentMax is the maximum at the specified index + </summary> + <param name="index">The index to the underlying dataset</param> + <param name="existingYMax">The existing maximum</param> + <returns>The new YMax, which is the Min(existingYMax, currentMax)</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.ToPointSeriesInternal(SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory,SciChart.Data.Model.IPointSeries)"> + <summary> + Converts the default <see cref="P:SciChart.Charting.Model.DataSeries.IDataSeries.YValues" /> to an <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series + </summary> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode to use</param> + <param name="factory">The <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory" /> Instance</param> + <param name="lastPointSeries">The last point series.</param> + <returns> + Sri + A <see cref="T:SciChart.Data.Model.IPointSeries" /> which is used to render XY series + </returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.ResampleZPoints(SciChart.Data.Model.Values{System.Int32},SciChart.Data.Model.ISciList{System.IComparable})"> + <summary> + Execute Z points + </summary> + <param name="resampleIndexes">Resample indexes</param> + <param name="zPoints">The Z points list to update.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.ToHitTestInfo(System.Int32)"> + <summary> + When overridden in a derived class, returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing data about the data-point at the specified index + </summary> + <param name="index">The index to the DataSeries</param> + <returns>The HitTestInfo</returns> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.ClearColumns"> + <summary> + When overridden in a derived class, clears all columns in the Data Series + </summary> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Append(`0,`1[])"> + <summary> + Appends an X, Y point to the series + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of y differ</exception> + <param name="x">The X Value</param> + <param name="yValues">The Y Values (depends on series type)</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1}[])"> + <summary> + Appends a list of X, Y points to the series + </summary> + <exception cref="T:System.InvalidOperationException">Exception will be thrown if the count of x and each y differ</exception> + <param name="x">The list of X points</param> + <param name="yValues">Lists of Y points (depends on series type)</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Append(`0,`1,`2)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw + </summary> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Append(`0,`1,`2,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw + </summary> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw + </summary> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw + </summary> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + <param name="metadata">The metadata values.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Update(System.Int32,`1,`2,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Updates (overwrites) the X,Y0,Y1,Metadata values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y0-value.</param> + <param name="z">The new Y1-value.</param> + <param name="metadata">The new metadata value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the x value is not in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Update(System.Int32,`1,`2)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified index. Automatically triggers a redraw. + </summary> + <param name="index">The index at which to update.</param> + <param name="y">The new Y-value.</param> + <param name="z">The new Z-value.</param> + <exception cref="T:System.InvalidOperationException">Thrown if the <paramref name="index" /> does not exist in the DataSeries.</exception> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Insert(System.Int32,`0,`1,`2)"> + <summary> + Inserts an X, Y0, Y1 point at the specified index. Automatically triggers a redraw + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.Insert(System.Int32,`0,`1,`2,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Inserts an X, Y0, Y1 point at the specified index. Automatically triggers a redraw + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="metadata">The metadata.</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2})"> + <summary> + Inserts a collection of X, Y0 and Y1 points at the specified index, automatically triggering a redraw + </summary> + <param name="startIndex">The index to insert at</param> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + </member> + <member name="M:SciChart.Charting.Model.DataSeries.XyzDataSeries`3.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting.Model.DataSeries.IPointMetadata})"> + <summary> + Inserts a collection of X, Y0 and Y1 points at the specified index, automatically triggering a redraw + </summary> + <param name="startIndex">The index to insert at</param> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + <param name="metadata">The metadata.</param> + </member> + <member name="T:SciChart.Charting.Model.AxisCollection"> + <summary> + Contains a collection of Axes and allows getting of axis by Id + </summary> + </member> + <member name="M:SciChart.Charting.Model.AxisCollection.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.AxisCollection" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Model.AxisCollection.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.Axes.IAxis})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.AxisCollection" /> class. + </summary> + <param name="collection">The collection.</param> + </member> + <member name="P:SciChart.Charting.Model.AxisCollection.HasPrimaryAxis"> + <summary> + Returns true if any of the Axes inЗел the collection have <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.IsPrimaryAxis" /> set to true + </summary> + </member> + <member name="P:SciChart.Charting.Model.AxisCollection.PrimaryAxis"> + <summary> + Gets the primary axis in the collection. This is the first that has <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.IsPrimaryAxis" /> set to true, or null if none exists. + </summary> + </member> + <member name="P:SciChart.Charting.Model.AxisCollection.Default"> + <summary> + Gets the default axis, which is equal to the axis with the <see cref="F:SciChart.Charting.Visuals.Axes.AxisCore.DefaultAxisId" />, else null + </summary> + </member> + <member name="M:SciChart.Charting.Model.AxisCollection.GetAxisById(System.String,System.Boolean)"> + <summary> + Gets the axis specified by Id, else null + </summary> + <param name="axisId">The axis identifier.</param> + <param name="assertAxisExists">if set to <c>true</c> assert and throw if the axis does not exist.</param> + <returns></returns> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Model.AxisCollection.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.AxisCollection.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Model.AxisCollection" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Model.AxisCollection.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Model.AxisCollection" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Model.ChartData.BandSeriesInfo"> + <summary> + Provides a ViewModel containing info about an Xyy series + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.BandSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.BandSeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BandSeriesInfo.IsFirstSeries"> + <summary> + Gets or sets value indicates whether this is Up or Down line of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BandSeriesInfo.Y1Value"> + <summary> + Gets or sets the Y1 value, which is used in the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" />. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BandSeriesInfo.FormattedY1Value"> + <summary> + Gets a formatted Y1Value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BandSeriesInfo.Xy1Coordinate"> + <summary> + Gets or sets the xy coordinate in pixels of the data-point being inspected (for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> series) + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo"> + <summary> + Provides a ViewModel containing info about an BoxPlot series, such as name, open high low close values, color + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo" /> class. + </summary> + <param name="rSeries">The RenderableSeries instance that this <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> is bound to.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.MinimumValue"> + <summary> + Gets or sets the Minimum value + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.FormattedMinimumValue"> + <summary> + Gets a formatted MinimumValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.MaximumValue"> + <summary> + Gets or sets the Maximum value + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.FormattedMaximumValue"> + <summary> + Gets a formatted MaximumValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.MedianValue"> + <summary> + Gets or sets the Median value + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.FormattedMedianValue"> + <summary> + Gets a formatted MedianValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.LowerQuartileValue"> + <summary> + Gets or sets the LowerQuartile value + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.FormattedLowerQuartileValue"> + <summary> + Gets a formatted LowerQuartileValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.UpperQuartileValue"> + <summary> + Gets or sets the UpperQuartile value + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.BoxPlotSeriesInfo.FormattedUpperQuartileValue"> + <summary> + Gets a formatted UpperQuartileValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.ChartDataObjectBase.ShowVisibilityCheckboxes"> + <summary> + Workaround - used by SciChartLegend items to bind to SciChartLegend.ShowVisibilityCheckboxes. This property is set as a proxy + by the SciChartLegend control itself and data-bound in the themes + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.ChartDataObject"> + <summary> + Provides a ViewModel containing info about chart series, which can be bound to to create Rollover or legends. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.ChartDataObject.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.ChartDataObject" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.ChartData.ChartDataObject.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.SeriesInfo})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.ChartDataObject" /> class. + </summary> + <param name="seriesInfos">The series infos.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.ChartDataObject.SeriesInfo"> + <summary> + Gets or sets a collection of <see cref="P:SciChart.Charting.Model.ChartData.ChartDataObject.SeriesInfo" /> instances + </summary> + <value>The series info.</value> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Model.ChartData.CompositeSeriesInfo"> + <summary> + Provides a ViewModel containing info about an Xyz Ternary series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.CompositeSeriesInfo.SeriesInfoCollection"> + <summary> + Collection which contain all hit SeriesInfo + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.CompositeSeriesInfo.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.SeriesInfo},SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.CompositeSeriesInfo" /> class. + </summary> + <param name="seriesInfos">All seriesInfo that is hit</param> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.CompositeSeriesInfo.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> instance which this <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> wraps. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.CompositeSeriesInfo.SetCompositeSeriesInfo(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.SeriesInfo},SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Set composite series info without initializes. + </summary> + <param name="seriesInfos">All seriesInfo that is hit</param> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="T:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo"> + <summary> + Provides a ViewModel containing info about a Heatmap series + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo.XIndex"> + <summary> + Gets or sets the XIndex at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo.YIndex"> + <summary> + Gets or sets the YIndex at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo.FormattedZValue"> + <summary> + Gets a formatted ZValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HeatmapSeriesInfo.CellColor"> + <summary> + Gets or sets the color value of the Heatmap cell at the hit-test site. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.HlcSeriesInfo"> + <summary> + Provides a ViewModel containing info about an HLC series, such as name, high low values, color + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.HlcSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.OhlcSeriesInfo" /> class. + </summary> + <param name="rSeries">The RenderableSeries instance that this <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> is bound to.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HlcSeriesInfo.HighValue"> + <summary> + Gets or sets the High value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HlcSeriesInfo.FormattedHighValue"> + <summary> + Gets a formatted HighValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HlcSeriesInfo.LowValue"> + <summary> + Gets or sets the Low value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HlcSeriesInfo.FormattedLowValue"> + <summary> + Gets a formatted LowValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HlcSeriesInfo.CloseValue"> + <summary> + Gets or sets the Close value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.HlcSeriesInfo.FormattedCloseValue"> + <summary> + Gets a formatted CloseValue. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.OhlcSeriesInfo"> + <summary> + Provides a ViewModel containing info about an OHLC series, such as name, open high low close values, color + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.OhlcSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.OhlcSeriesInfo" /> class. + </summary> + <param name="rSeries">The RenderableSeries instance that this <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> is bound to.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.OhlcSeriesInfo.OpenValue"> + <summary> + Gets or sets the Open value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.OhlcSeriesInfo.FormattedOpenValue"> + <summary> + Gets a formatted OpenValue. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.OneHundredPercentStackedSeriesInfo"> + <summary> + Provides a ViewModel containing info about one hundred percent stacked Xy series + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.OneHundredPercentStackedSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.OneHundredPercentStackedSeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.OneHundredPercentStackedSeriesInfo.Percentage"> + <summary> + Gets or sets the stacking level (in percent) of the stacked series. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.RadarChartDataObject"> + <summary> + Provides a ViewModel containing info about chart series, which can be bound to to create Rollover or legends. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.RadarChartDataObject.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.RadarChartDataObject" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.ChartData.RadarChartDataObject.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartData.RadarSeriesInfo})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.RadarChartDataObject" /> class. + </summary> + <param name="seriesInfos">The series infos.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarChartDataObject.SeriesInfo"> + <summary> + Gets or sets a collection of <see cref="P:SciChart.Charting.Model.ChartData.RadarChartDataObject.SeriesInfo" /> instances + </summary> + <value>The series info.</value> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Model.ChartData.IRadarSeriesInfo"> + <summary> + Provides a ViewModel containing info about a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />, such as name, nearest data value, color. + Is used as a data source by <see cref="T:SciChart.Charting.ChartModifiers.RadarTooltipModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.RadarLegendModifier" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.SeriesName"> + <summary> + Gets or sets the name of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SeriesName" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.Stroke"> + <summary> + Gets or sets the stroke color of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.IsSelected"> + <summary> + Gets or sets the value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.StrokeThickness"> + <summary> + Gets or sets the stroke thickness of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.PointMarker"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance used by a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.Fill"> + <summary> + Gets or sets the fill brush of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.XyCoordinate"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.AxisTitle"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.ClosestDataPoint"> + <summary> + Gets or sets the nearest data value of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.FormattedDataValue"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.IRadarSeriesInfo.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> instance which this <see cref="T:SciChart.Charting.Model.ChartData.IRadarSeriesInfo" /> wraps. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.RadarSeriesInfo"> + <summary> + Provides a ViewModel containing info about a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />, such as name, nearest data value, color. + Is used as a data source by <see cref="T:SciChart.Charting.ChartModifiers.RadarTooltipModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.RadarLegendModifier" />. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.RadarSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.RadarSeriesInfo" /> class. + </summary> + <param name="radarPolygonSeries"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.FormattedDataValue"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> instance which this <see cref="T:SciChart.Charting.Model.ChartData.RadarSeriesInfo" /> wraps. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.SeriesName"> + <summary> + Gets or sets the name of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SeriesName" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.Stroke"> + <summary> + Gets or sets the stroke color of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.IsSelected"> + <summary> + Gets or sets the value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.IsFilled"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.StrokeThickness"> + <summary> + Gets or sets the stroke thickness of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.PointMarker"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance used by a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.Fill"> + <summary> + Gets or sets the fill brush of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.XyCoordinate"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.AxisTitle"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.RadarSeriesInfo.ClosestDataPoint"> + <summary> + Gets or sets the nearest data value of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartData.SeriesInfo"> + <summary> + <para> + Provides a ViewModel containing info about a series, such as name, value, color. <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> types are + produced by the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" />, <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.LegendModifier" />. They are + consumed by the <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> and may be consumed by a custom <see cref="T:System.Windows.Controls.ItemsControl" /> binding to collection + of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" />. + </para> + <para> + See the examples suite, specifically RolloverModifier, SciTrader and Legends examples for more information. + </para> + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.SeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.ChartData.SeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> that this SeriesInfo represents.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.Fill"> + <summary> + Gets or sets the brush of the series. + </summary> + <value>The brush of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.IsVisible"> + <summary> + Gets or sets whether the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> that this <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> represents is visible or not. + NOTE: Setting this value will show or hide the associated <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> and may be data-bound to. + </summary> + <value> + <c>true</c> if this instance is visible; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.DataSeriesType"> + <summary> + Gets or sets the type of the data series. + </summary> + <value> + The type of the data series. + </value> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.Stroke"> + <summary> + Gets or sets the color of the series. + </summary> + <value>The color of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.SeriesName"> + <summary> + Gets or sets the name of the series. + </summary> + <value>The name of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.Value"> + <summary> + Gets or sets the Y-value. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.YValue"> + <summary> + Gets or sets the Y-value. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.FormattedYValue"> + <summary> + Gets a formatted YValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.XValue"> + <summary> + Gets or sets the X-value. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.FormattedXValue"> + <summary> + Gets a formatted XValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.XyCoordinate"> + <summary> + Gets or sets the xy coordinate in pixels of the data-point being inspected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.IsHit"> + <summary> + Get or sets whether the HitTest operation was a hit or not. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.PointMetadata"> + <summary> + Gets the metadata associated with the point at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.DataSeriesIndex"> + <summary> + Gets or sets the DataSeriesIndex at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.SeriesInfo.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> instance which this <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> wraps. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.SeriesInfo.GetYCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using Y axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="M:SciChart.Charting.Model.ChartData.SeriesInfo.GetXCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using X axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="M:SciChart.Charting.Model.ChartData.SeriesInfo.Clone"> + <summary> + Creates a new object that is a copy of the current instance. + </summary> + <returns> + A new object that is a copy of this instance. + </returns> + </member> + <member name="T:SciChart.Charting.Model.ChartData.TernarySeriesInfo"> + <summary> + Provides a ViewModel containing info about an Xyz Ternary series + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.TernarySeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.TernarySeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.TernarySeriesInfo.FormattedZValue"> + <summary> + Gets a formatted ZValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.TernarySeriesInfo.FormattedYValue"> + <summary> + Gets a formatted YValue. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartData.TernarySeriesInfo.FormattedXValue"> + <summary> + Gets a formatted XValue. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.TernarySeriesInfo.GetYCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using Y axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="M:SciChart.Charting.Model.ChartData.TernarySeriesInfo.GetXCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using X axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="M:SciChart.Charting.Model.ChartData.TernarySeriesInfo.GetZCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using Z axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="T:SciChart.Charting.Model.ChartData.XySeriesInfo"> + <summary> + Provides a ViewModel containing info about an Xy series, such as name, x, y values, color + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.XySeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.XySeriesInfo" /> class. + </summary> + <param name="rSeries">The renderable series.</param> + <param name="hitTestInfo"></param> + </member> + <member name="T:SciChart.Charting.Model.ChartData.XyStackedSeriesInfo"> + <summary> + Provides a ViewModel containing info about stacked Xy series + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.XyStackedSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.BandSeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.XyStackedSeriesInfo.AccumulatedValue"> + <summary> + Gets or sets the accumulated value of all stacked series, which is returned as hit-test result of the stacked <see cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" />. + </summary> + <value>The value</value> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Model.ChartData.XyzSeriesInfo"> + <summary> + Provides a ViewModel containing info about an Xyz series + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartData.XyzSeriesInfo.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartData.BandSeriesInfo" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="hitTestInfo"></param> + </member> + <member name="P:SciChart.Charting.Model.ChartData.XyzSeriesInfo.ZValue"> + <summary> + Gets or sets the Z value, which is returned as hit-test result of the <see cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" />. + </summary> + <value>The value</value> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.AnnotationsSourceCollection"> + <summary> + Contains a collection of RenderableSeries and associated RenderableSeriesViewModels + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.AnnotationsSourceCollection.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartSeries.IAnnotationViewModel})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.AxisSynchronizationHelper.IsAxisForSynchronizing(SciChart.Charting.Model.ChartSeries.IAxisViewModel)"> + <summary> + Check if helper already synchronizing given axis. + </summary> + <param name="axis">Axis to check</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.AxisSynchronizationHelper.IsLazy"> + <summary> + Check if Helper has no axis to sync or just one. + </summary> + <returns>True if there is no axis to sync, otherwise - False.</returns> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.AxisBaseViewModel.VisibleRangeChanged"> + <summary> + Raised when the VisibleRange is changed + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.AxisBaseViewModel.OnVisibleRangeChanged(SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs)"> + <summary> + Raises the VisibleRangeChanged event + </summary> + <param name="args">The <see cref="T:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs" /> containing event data</param> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.NumericAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxisForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.NumericAxisViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.NumericAxisViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.NumericAxisViewModel.ScientificNotation"> + <summary> + Gets or sets used number format. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.NumericAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.DateTimeAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxisForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.DateTimeAxisViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.DateTimeAxisViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.DateTimeAxisViewModel.SubDayTextFormatting"> + <summary> + Gets or sets the TextFormatting used for axis labels when the range of the axis is sub-day. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.DateTimeAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.CategoryNumericAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxisForMvvm" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CategoryNumericAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.CategoryDateTimeAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxisForMvvm" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CategoryDateTimeAxisViewModel.BarTimeFrame"> + <summary> + Gets or sets the number of seconds that each data-point represents on the axis. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CategoryDateTimeAxisViewModel.SubDayTextFormatting"> + <summary> + Gets or sets the TextFormatting used for axis labels when the range of the axis is sub-day. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CategoryDateTimeAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.LogarithmicNumericAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicNumericAxisForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.LogarithmicNumericAxisViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.LogarithmicNumericAxisViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.LogarithmicNumericAxisViewModel.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.LogarithmicNumericAxisViewModel.EnableHighPrecisionTicks"> + <summary> + Gets or sets a value which enables high-precision ticks generation. + </summary> + <remarks>When enabled, allows smaller difference between neighboring major ticks. It should be enabled to show axis ticks at deep zoom levels or when data values are small.</remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.LogarithmicNumericAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.NegativeLogarithmicAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.NegativeLogarithmicAxisForMvvm" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.NegativeLogarithmicAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.TimeSpanAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxisForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.TimeSpanAxisViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.TimeSpanAxisViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.TimeSpanAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.PolarXAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.PolarXAxisForMvvm" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.PolarXAxisViewModel.RotationAngle"> + <summary> + Gets or sets the initial position of the current axis in degrees. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.PolarXAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.PolarYAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.PolarYAxisForMvvm" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.PolarYAxisViewModel.Angle"> + <summary> + Gets or set the rotation angle of the current axis. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.PolarYAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.DiscontiniousDateTimeAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.DiscontiniousDateTimeAxisForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.DiscontiniousDateTimeAxisViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.DiscontiniousDateTimeAxisViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.DiscontiniousDateTimeAxisViewModel.Calendar"> + <summary> + Gets or sets the calendar with time ranges to skip. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.DiscontiniousDateTimeAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxisForMvvm" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel.AxisAngle"> + <summary> + Gets or set the rotation angle of the current axis. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel.AxisLength"> + <summary> + Gets or sets the length of the current axis. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel.GridLinesType"> + <summary> + Specifies how grid lines should appear on the RadarSurface. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel.AxisLineStyleKey"> + <summary> + Gets or sets the style key which will be used to fetch the style. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel.DrawAxisLine"> + <summary> + Specifies whether to draw the axis line or not. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarAxisViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BandRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BandRenderableSeriesViewModel.StrokeY1"> + <summary> + Gets or sets the Stroke of the Y1 line. For the Y0 line, use Stroke + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BandRenderableSeriesViewModel.FillY1"> + <summary> + Gets or sets the Color of the shaded area when Y1 is greater than Y0 + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BandRenderableSeriesViewModel.Fill"> + <summary> + Gets or sets the Color of the shaded area when Y1 is less than Y0 + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BandRenderableSeriesViewModel.StrokeDashArrayY1"> + <summary> + Gets or sets a StrokeDashArray property, used to define a dashed line. See the MSDN Documentation for + <see cref="P:System.Windows.Shapes.Shape.StrokeDashArray" /> as this property attempts to mimic the same behaviour + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BandRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.IsHidden"> + <summary> + Gets or sets whether the Annotation is hidden when drawn + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.DragDirections"> + <summary> + Limits the Drag direction when dragging the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.ResizeDirections"> + <summary> + Limits the Resize direction when resiaing the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.CoordinateMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode" /> to use when placing the annotation. E.g. the default of Absolute requires that X1,Y1 coordinates are data-values. The value + of Relative requires that X1,Y1 are double values from 0.0 to 1.0 + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.AnnotationCanvas"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.AnnotationCanvas" /> to place the annotation on. The default is <see cref="!:Annotations.AnnotationCanvas.AboveChart" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.IsEditable"> + <summary> + Gets or sets whether the Annotation is editable via user interaction + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.IsSelected"> + <summary> + Gets or sets whether the Annotation is selected + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.CanEditText"> + <summary> + Gets or sets whether text can be edited on this <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" />. + Supported by Text or label annotations only + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.X1"> + <summary> + Gets or sets the X1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.X2"> + <summary> + Gets or sets the X2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.Y1"> + <summary> + Gets or sets the Y1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel.Y2"> + <summary> + Gets or sets the Y2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BaseColumnRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseColumnRenderableSeriesViewModel.Fill"> + <summary> + Gets or sets the Fill Brush for columns. The column outline is specified by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseColumnRenderableSeriesViewModel.FillBrushMappingMode"> + <summary> + Gets or sets a <see cref="T:SciChart.Drawing.Common.TextureMappingMode" /> which defines how columns are filled when a gradient <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.Fill" /> is used. + If <see cref="F:SciChart.Drawing.Common.TextureMappingMode.PerScreen" />, then a single texture is shared across multiple columns + If <see cref="F:SciChart.Drawing.Common.TextureMappingMode.PerPrimitive" />, then a texture is created and scaled per-column fill area + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseColumnRenderableSeriesViewModel.UseUniformWidth"> + <summary> + Gets or sets the UseUniformWidth, which specifies that all columns are the to be of the same width + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseColumnRenderableSeriesViewModel.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseHeatmapRenderableSeriesViewModel.DrawTextInCell"> + <summary> + Gets or sets a flag to draw value in a cell. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseHeatmapRenderableSeriesViewModel.CellTextFormatting"> + <summary> + Gets or sets the cellTextFormatting as a .NET Formatting string + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseHeatmapRenderableSeriesViewModel.CellTextForeground"> + <summary> + Gets or sets foreground color to draw value in a cell. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseHeatmapRenderableSeriesViewModel.CellFontSize"> + <summary> + Gets or sets foreground color to draw value in a cell. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseHeatmapRenderableSeriesViewModel.ColorMap"> + <summary> + Gets or sets the ColorMap which is used to calculate color from data value. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BaseMountainRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseMountainRenderableSeriesViewModel.Fill"> + <summary> + Gets or sets the Area Brush for the mountain series. The mountain chart outline is specified by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" /></summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel"> + <summary> + A base viewmodel to a renderable series, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IncludeRolloverModifier"> + <summary> + Gets or sets a value indicating whether this series should be included in the RolloverModifier or not + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IncludeTooltipModifier"> + <summary> + Gets or sets a value indicating whether this series should be included in the TooltipModifier or not + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IncludeSeriesValueModifier"> + <summary> + Gets or sets a value indicating whether this series should be included in the SeriesValueModifier or not + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IncludeSeriesSelectionModifier"> + <summary> + Gets or sets a value indicating whether this series should be included in the SeriesSelectionModifier or not + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IncludeDataPointSelectionModifier"> + <summary> + Gets or sets a value indicating whether this series should be included in the DataPointSelectionModifier or not + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IsDigitalLine"> + <summary> + Gets or sets a value indicating whether this line series is a digital (step) line + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.StrokeDashArray"> + <summary> + Gets or sets a StrokeDashArray property, used to define a dashed line. See the MSDN Documentation for + <see cref="P:System.Windows.Shapes.Shape.StrokeDashArray" /> as this property attempts to mimic the same behaviour + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.Tag"> + <summary> + Gets or sets a tag, bound by default to RenderableSeries.Tag + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.Opacity"> + <summary> + Gets or sets the Opacity, bound by default to RenderableSeries.Opacity + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.AntiAliasing"> + <summary> + Gets or sets whether this series uses AntiAliasing when drawn + </summary> + <value> + <c>true</c> if anti aliasing is enabled; otherwise, <c>false</c>.</value> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <value>The color of the series.</value> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.IsSelected"> + <summary> + Gets or sets whether the series is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the line. + </summary> + <remarks> + Note that increasing stroke thickness from 1 will have a detrimental effect on performance + </remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.ResamplingMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Data.Numerics.ResamplingMode" /> used when drawing this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this renderable series is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this renderable series is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.PaletteProvider"> + <summary> + Gets or Sets an optional <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> instance, which may be used to override specific data-point colors during rendering. + For more details, see the <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> documentation + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.PointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance directly on the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. When a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + is present, then the markers will be drawn at each data-point in the series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.SelectedPointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance directly on the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. When a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + is present, then the markers will be drawn at each selected data-point in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.ZeroLineY"> + <summary> + Gets or sets the value which determines the zero line in Y direction. + Used to set the bottom of a column, or the zero line in a mountain + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.DrawNaNAs"> + <summary> + Gets or sets a value indicating how this renderable series will treat double.NaN. See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.LineDrawMode" /> for available options + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.SelectionChanged"> + <summary> + Occurs when IsSelected property changed and passes as EventArgs the IsSelected value. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel.OnSelectionChanged"> + <summary> + Raises the SelectionChanged event + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel"> + <summary> + Provides the base implementation for SciChart MVVM API. + See <see cref="T:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel" />, <see cref="T:SciChart.Charting.Model.ChartSeries.BaseAnnotationViewModel" />, <see cref="T:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel.StyleKey"> + <summary> + Gets or Sets the style key which will be used to fetch the style and apply it to the corresponding RenderableSeries. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel.ViewType"> + <summary> + Gets the View Type which this ViewModel will be associated with. + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + <remarks> + The PropertyChanged event can indicate all properties on the object have changed by using either <c>null</c> or <see cref="F:System.String.Empty" /> as the property name in the PropertyChangedEventArgs. + </remarks> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel.OnPropertyChanged(System.String)"> + <summary> + This method is called by the Set accessor of each property. + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.BaseSciChartElementViewModel.SetValue``1(``0@,``0,System.String)"> + <summary> + This method is used to set property value and raise PropertyChanged event handler + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BoxPlotRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BoxPlotRenderableSeriesViewModel.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BoxPlotRenderableSeriesViewModel.Fill"> + <summary> + Gets or sets the Brush used for box-plot body + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BoxPlotRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel.MaxBubbleSizeInPixels"> + <summary> + Gets or sets a Max bubble size in pixels, when AutoZRnage is set to true + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel.ApplyAreaSizingInsteadOfRadius"> + <summary> + Gets or sets a Square Area Sizing behavior among bubbles Instead Of Radius, when AutoZRange is set to true + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel.BubbleColor"> + <summary> + Gets or sets the BubbleColor, a base colour used when rendering the bubbles as a soft-edged circle, centred on the X-Y point + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel.AutoZRange"> + <summary> + Gets or sets whether Z-range should be automatically scaled. If True, then depending on the XYZ points in the + viewport, the size of bubbles will be scaled to fit. Else, the size of bubbles will be absolute + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel.ZScaleFactor"> + <summary> + Gets or sets a Z-scaling factor, equal to Pixels divided by Z-Unit + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.BubbleRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel.StrokeUp"> + <summary> + Gets or sets the Color used for wicks and outlines on up-candles (close > open) + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel.StrokeDown"> + <summary> + Gets or sets the Color used for wicks and outlines on down-candles (close < open) + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel.FillUp"> + <summary> + Gets or sets the Brush used for candle body on up-candles (close > open). If null, UpBodyColor property is used + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel.FillDown"> + <summary> + Gets or sets the Brush used for candle body on up-candles (close > open). If null, UpBodyColor property is used + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.CandlestickRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Model.ChartSeries.ChartSeriesViewModel" />, a viewmodel to a single data-render series pair, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> Mvvm API. + For usage, see the SeriesSource property and the Mvvm examples in the examples suite. You may bind SeriesSource to a collection of <see cref="T:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel" /> + and SciChart will automatically associate the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> and <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> instances + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn</remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel.RenderSeries"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> paired with the data + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.ChartSeriesViewModel"> + <summary> + A viewmodel to a single data-render series pair, used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> Mvvm API. + For usage, see the SeriesSource property and the Mvvm examples in the examples suite. You may bind SeriesSource to a collection of <see cref="T:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel" /> + and SciChart will automatically associated the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> and <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> instances + </summary> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyyDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IOhlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.OhlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IHlcDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.HlcDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> will be redrawn</remarks> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.ChartSeriesViewModel.#ctor(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.ChartSeriesViewModel" /> class. + </summary> + <param name="dataSeries">The data series.</param> + <param name="renderSeries">The render series paired with the data.</param> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ChartSeriesViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ChartSeriesViewModel.RenderSeries"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> paired with the data + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.ColumnRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ColumnRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.ErrorBarsRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ErrorBarsRenderableSeriesViewModel.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ErrorBarsRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.ExtremeScatterRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ExtremeScatterRenderableSeriesViewModel.ResamplingMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Data.Numerics.ResamplingMode" /> used when drawing this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ExtremeScatterRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />, which is used in the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.MarketProfileSeriesHelper"> + <summary> + Gets or sets a helper class that can be used to get series data in a ViewModel. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.HorizontalBarSpacing"> + <summary> + Gets or sets a value that defines horizontal spacing between a candle and the histogram. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.VerticalBarSpacing"> + <summary> + Gets or sets a value that defines vertical spacing between bars in a histogram. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.MaxHistoBarCandles"> + <summary> + Gets of sets a value that defines maximal amount of candles in viewport which will appear with histogram. + If there are more, histograms will not be drawn. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.TickSize"> + <summary> + Gets or sets the price delta value which is used to aggregate candle ticks. + This is also the tick size of the associated Y axis (price axis). + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.HistogramMode"> + <summary> + Gets or sets a value that specifies how histogram will appear. + See <see cref="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.HistogramMode" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.HistobarRenderableSeriesViewModel.ViewType"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.Selected"> + <summary> + Occurs when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes selected. + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.Unselected"> + <summary> + Occurs when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes unselected. + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.DragStarted"> + <summary> + Occurs when a Drag or move operation starts + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.DragEnded"> + <summary> + Occurs when a Drag or move operation ends + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.DragDelta"> + <summary> + Occurs when current <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> is dragged or moved + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.IsHiddenChanged"> + <summary> + Occurs when the <see cref="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.IsHidden" /> property is changed + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.IsHidden"> + <summary> + Gets or sets whether the Annotation is hidden when drawn + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.DragDirections"> + <summary> + Limits the Drag direction when dragging the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.ResizeDirections"> + <summary> + Limits the Resize direction when resiaing the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.CoordinateMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode" /> to use when placing the annotation. E.g. the default of Absolute requires that X1,Y1 coordinates are data-values. The value + of Relative requires that X1,Y1 are double values from 0.0 to 1.0 + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.AnnotationCanvas"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.AnnotationCanvas" /> to place the annotation on. The default is <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.AboveChart" /></summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.IsEditable"> + <summary> + Gets or sets whether the Annotation is editable via user interaction + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.IsSelected"> + <summary> + Gets or sets whether the Annotation is selected + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.X1"> + <summary> + Gets or sets the X1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.X2"> + <summary> + Gets or sets the X2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.Y1"> + <summary> + Gets or sets the Y1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.Y2"> + <summary> + Gets or sets the Y2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IAnnotationViewModel.CanEditText"> + <summary> + Gets or sets whether text can be edited on this <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" />. + Supported by Text or label annotations only + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.IAxisCoreViewModel"> + <summary> + TODO: Write XML comments + </summary> + </member> + <member name="E:SciChart.Charting.Model.ChartSeries.IAxisViewModel.VisibleRangeChanged"> + <summary> + Raised when the VisibleRange is changed + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.ImpulseRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ImpulseRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Model.ChartSeries.BaseRenderableSeriesViewModel" />, a viewmodel to a renderable series, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.AntiAliasing"> + <summary> + Gets or sets whether this series uses AntiAliasing when drawn + </summary> + <value> + <c>true</c> if anti aliasing is enabled; otherwise, <c>false</c>.</value> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <value>The color of the series.</value> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.IsSelected"> + <summary> + Gets or sets whether the series is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the line. + </summary> + <remarks> + Note that increasing stroke thickness from 1 will have a detrimental effect on performance + </remarks> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.ResamplingMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Data.Numerics.ResamplingMode" /> used when drawing this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this renderable series is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this renderable series is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.PaletteProvider"> + <summary> + Gets or Sets an optional <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> instance, which may be used to override specific data-point colors during rendering. + For more details, see the <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> documentation + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel.RenderSeriesType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ISciChartElementViewModel.StyleKey"> + <summary> + The StyleKey to apply to the View + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.ISciChartElementViewModel.ViewType"> + <summary> + Gets The View Type to instantiate for this ViewModel. The View.DataContext will be set to this ViewModel instance + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.LineRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.LineRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries" />, which is used in the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.MarketProfileSeriesHelper"> + <summary> + Gets or sets a helper class that can be used to get series data in a ViewModel. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.MarketProfileWidth"> + <summary> + Gets or sets the maximal possible length of bars in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.VerticalBarOffset"> + <summary> + Gets or sets the distance between bars in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.StrokeAsk"> + <summary> + Gets or sets a brush that is used to draw the outline for Ask bars. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.StrokeBid"> + <summary> + Gets or sets a brush that is used to draw the outline for Bid bars. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.FillAsk"> + <summary> + Gets or sets a brush that is used to fill Ask bars. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.FillBid"> + <summary> + Gets or sets a brush that is used to fill Bid bars. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.TickSize"> + <summary> + Gets or sets the price delta value which is used to aggregate candle ticks. + This is also the tick size of the associated Y axis (price axis). + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MarketProfileRenderableSeriesViewModel.ViewType"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.MountainRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.MountainRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.NonUniformHeatmapRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.NonUniformHeatmapRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.OhlcRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.OhlcRenderableSeriesViewModel.StrokeUp"> + <summary> + Gets or sets the Color used for wicks and outlines on up-candles (close > open) + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.OhlcRenderableSeriesViewModel.StrokeDown"> + <summary> + Gets or sets the Color used for wicks and outlines on down-candles (close < open) + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.OhlcRenderableSeriesViewModel.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.OhlcRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel" />, a viewmodel to a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />, which is used in the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.SeriesName"> + <summary> + Gets or sets the name of this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.IsFilled"> + <summary> + Gets or sets whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" /> is filled. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.Fill"> + <summary> + Gets or sets a brush to fill this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.LegendMarkerTemplate"> + <summary> + Gets or sets the DataTemplate which defines the Visual which appears in the Legend and represents the series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.SelectedPointMarker"> + <summary> + Gets or sets a PointMarker which appears when a data-point is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.PointMarker"> + <summary> + Gets or sets a PointMarker which appear for every data-point in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.IsVisible"> + <summary> + Gets or sets whether the series is visible. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.SelectedSeriesStyle"> + <summary> + Gets or sets a style for a selected series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.StrokeThickness"> + <summary> + Gets or sets the stroke thickness for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.IsSelected"> + <summary> + Gets or sets value, indicates whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.Stroke"> + <summary> + Gets or sets the stroke color. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel.AntiAliasing"> + <summary> + Gets or sets whether this series is anti-aliased. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel"> + <summary> + Defines a View Model to a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />, which is used in the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.SeriesName"> + <summary> + Gets or sets the name of this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.IsFilled"> + <summary> + Gets or sets whether the polygon is filled. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.Fill"> + <summary> + Gets or sets a brush to fill the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.LegendMarkerTemplate"> + <summary> + Gets or sets the DataTemplate which defines the Visual which appears in the Legend and represents the series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.SelectedPointMarker"> + <summary> + Gets or sets a PointMarker which appears when a data point is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.PointMarker"> + <summary> + Gets or sets a PointMarker which appear for every data-point in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.IsVisible"> + <summary> + Gets or sets whether the series is visible. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.SelectedSeriesStyle"> + <summary> + Gets or sets a style for a selected series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.StrokeThickness"> + <summary> + Gets or sets the stroke thickness in pixels for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.IsSelected"> + <summary> + Gets or sets value, indicates whether this series is selected. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.Stroke"> + <summary> + Gets or sets the stroke color. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.AntiAliasing"> + <summary> + Gets or sets whether this series is anti-aliased. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.RadarPolygonRenderableSeriesViewModel.ViewType"> + <summary> + Gets the type of RenderableSeries which this ViewModel will be associated with. + See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.RadarRenderableSeriesSourceCollection"> + <summary></summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.RadarRenderableSeriesSourceCollection.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel})"> + <summary></summary> + <param name="collection"></param> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.RenderableSeriesSourceCollection"> + <summary> + Contains a collection of RenderableSeries and associated RenderableSeriesViewModels + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.RenderableSeriesSourceCollection.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.RenderableSeriesSourceCollection" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2"> + <summary> + Contains a collection of RenderableSeries and associated RenderableSeriesViewModels + </summary> + </member> + <member name="F:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2.StyleKeyProperty"> + <summary> + Defines the StyleKey DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2.SetStyleKey(System.Windows.DependencyObject,System.String)"> + <summary> + Sets the StyleKey attached property + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2.GetStyleKey(System.Windows.DependencyObject)"> + <summary> + Gets the StyleKey attached property + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2.#ctor(System.Collections.Generic.IEnumerable{`1})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Collection is associated with + </summary> + </member> + <member name="M:SciChart.Charting.Model.ChartSeries.SourceCollectionBase`2.ForceResources(System.Windows.FrameworkElement)"> + <summary> + Used to force applying resources before an item is inserted into the SourceCollectionBase. + Can resolve issues in MVVM API where some properties require styles present before showing + </summary> + <param name="frameworkView"></param> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.StackedGroupId"> + <summary> + Gets or sets a string StackedGroupId. All series within the same group get stacked vertically. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.IsOneHundredPercent"> + <summary> + Gets or sets the value which indicates whether the series are 100% stacked + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.Spacing"> + <summary> + Gets or sets the value which specifies the width of the gap between horizontally stacked columns. + Can be set to either a relative or absolute value depending on the <see cref="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.SpacingMode" /> used. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.SpacingMode"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.SpacingMode" /> to use for the space between columns computations. + E.g. the default of Absolute requires that <see cref="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.Spacing" /> is in pixels. The value + of Relative requires that <see cref="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.Spacing" /> is a double value from 0.0 to 1.0. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.ShowLabel"> + <summary> + Gets or sets the value indicating whether to show text labels over the columns. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.LabelColor"> + <summary> + Gets or sets the foreground color for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.LabelFontSize"> + <summary> + Gets or sets the font size for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.LabelTextFormatting"> + <summary> + Gets or sets the formatting string for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedColumnRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.StackedMountainRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedMountainRenderableSeriesViewModel.StackedGroupId"> + <summary> + Gets or sets a string stacked-group Id, used to ensure columns are stacked together + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedMountainRenderableSeriesViewModel.IsOneHundredPercent"> + <summary> + Gets or sets a value whether all series with the same <see cref="P:SciChart.Charting.Model.ChartSeries.StackedMountainRenderableSeriesViewModel.StackedGroupId" /> will appear 100% stacked + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.StackedMountainRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.ZMin"> + <summary> + Gets or sets the minimum data-value for Major contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.ZMax"> + <summary> + Gets or sets the maximum data-value for Major contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.ZStep"> + <summary> + Gets or sets the stepping in data-value between Major contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.ColorMap"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette" /> which is used to calculate a color from a data value. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.ColorMapMode"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ColorPaletteMode" /> which defines how to apply the Gradient Colors. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.MajorLineStyle"> + <summary> + Gets or sets a style which we apply to Major contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.MinorLineStyle"> + <summary> + Gets or sets a style which we apply to Minor contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.MinorsPerMajor"> + <summary> + Defines the number of Minor lines between each Major contour line + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.DrawingMode"> + <summary> + When Fast, and the DirectX Renderer is enabled, uses a fast GPU-based shader calculation to perform extremely fast rendering of contours. + When Accurate, a more accurate (but slower) software calculation is performed for contours, regardless of whether DirectX is enabled or not. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformContourRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.UniformHeatmapRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.UniformHeatmapRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.ChartSeries.XyScatterRenderableSeriesViewModel"> + <summary> + A viewmodel to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" />, which is used in the new <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.XyScatterRenderableSeriesViewModel.DoClusterResampling"> + <summary> + Gets or sets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> should use Cluster Resampling + </summary> + </member> + <member name="P:SciChart.Charting.Model.ChartSeries.XyScatterRenderableSeriesViewModel.ViewType"> + <summary> + Gets the RenderableSeries Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting.Model.DoubleAxisDelta"> + <summary> + Defines a Double Delta, which provides Major and Minor deltas as used in <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DoubleAxisDelta" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.#ctor(System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.DoubleAxisDelta" /> class. + </summary> + <param name="minorDelta">The minor delta.</param> + <param name="majorDelta">The major delta.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DoubleAxisDelta.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.DoubleAxisDelta.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" /> is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Object" />.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.Equals(SciChart.Charting.Model.DoubleAxisDelta)"> + <summary> + Indicates whether the current object is equal to another object of the same type. + </summary> + <param name="other">An object to compare with this object.</param> + <returns>true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.op_Equality(SciChart.Charting.Model.DoubleAxisDelta,SciChart.Charting.Model.DoubleAxisDelta)"> + <summary> + Implements the operator ==. + </summary> + <param name="left">The left.</param> + <param name="right">The right.</param> + <returns>The result of the operator.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.op_Inequality(SciChart.Charting.Model.DoubleAxisDelta,SciChart.Charting.Model.DoubleAxisDelta)"> + <summary> + Implements the operator !=. + </summary> + <param name="left">The left.</param> + <param name="right">The right.</param> + <returns>The result of the operator.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.DoubleAxisDelta.ToString"> + <summary> + Returns a <see cref="T:System.String" /> that represents this instance. + </summary> + <returns>A <see cref="T:System.String" /> that represents this instance.</returns> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Model.Filters.AggregationFilters.RenkoSource"> + <summary> + Defines constants which represent different value sources for <see cref="T:SciChart.Charting.Model.Filters.AggregationFilters.AggregationRenkoFilter`1" /></summary> + </member> + <member name="F:SciChart.Charting.Model.Filters.AggregationFilters.RenkoSource.Close"> + <summary> + Aggregate by Close value only. + </summary> + </member> + <member name="F:SciChart.Charting.Model.Filters.AggregationFilters.RenkoSource.HighLow"> + <summary> + Aggregate by High-Low values. + </summary> + </member> + <member name="T:SciChart.Charting.Model.Filters.FilterBase"> + <summary> + A base class for filters + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.#ctor(SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Initializes a new instance of <see cref="T:SciChart.Charting.Model.Filters.FilterBase" />cref + </summary> + <param name="originalDataSeries">The original data series</param> + </member> + <member name="P:SciChart.Charting.Model.Filters.FilterBase.FilteredDataSeries"> + <summary> + The filtered data series + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.OnOriginalDataSeriesChanged(System.Object,SciChart.Charting.Model.DataSeries.DataSeriesChangedEventArgs)"> + <summary> + Handles data series changes that were applied for + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.FilterOnAppend(System.Int32)"> + <summary> + Filters on original data series append + </summary> + <param name="index">The start index</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.FilterOnUpdate(System.Int32)"> + <summary> + Filters on original data series update + </summary> + <param name="index">The start index</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.FilterOnInsert(System.Int32,System.Int32)"> + <summary> + Filters on original data series insert + </summary> + <param name="startIndex">The start index</param> + <param name="count">The amount of changed items</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.FilterOnRemove(System.Int32,System.Int32)"> + <summary> + Filters on original data series remove + </summary> + <param name="startIndex">The start index</param> + <param name="count">The amount of changed items</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterBase.FilterAll"> + <summary> + Filters data series. You should implement it if you want to filter in this way for all data series changes. + Override append, update, insert, remove methods to optimize filtering. + </summary> + </member> + <member name="T:SciChart.Charting.Model.Filters.FilterExtensions"> + <summary> + Provides set of extensions for data series filtering + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.ToDiscontinuousSeries``1(SciChart.Charting.Model.DataSeries.IDataSeries{System.DateTime,``0},SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar)"> + <summary> + Filters data series by calendar. Use it for <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /></summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="calendar">The calendar</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.ToDiscontinuousSeries``2(SciChart.Charting.Model.DataSeries.IXyzDataSeries{System.DateTime,``0,``1},SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar)"> + <summary> + Filters data series by calendar. Use it for <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /></summary> + <typeparam name="TY">Type of Y values</typeparam> + <typeparam name="TZ">Type of Z values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="calendar">The calendar</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.ToMovingAverage``1(SciChart.Charting.Model.DataSeries.IDataSeries{``0,System.Double},System.Int32)"> + <summary> + Filters data series by moving average + </summary> + <typeparam name="TX">Type of X values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="length">The count of values to find a moving average</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.Scale``2(SciChart.Charting.Model.DataSeries.IDataSeries{``0,``1},``1)"> + <summary> + Filters data series by scaling + </summary> + <typeparam name="TX">Type of X values</typeparam> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="scale">The scale factor</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.Scale``3(SciChart.Charting.Model.DataSeries.IXyzDataSeries{``0,``1,``2},``1,``2)"> + <summary> + Filters data series by scaling + </summary> + <typeparam name="TX">Type of X values</typeparam> + <typeparam name="TY">Type of Y values</typeparam> + <typeparam name="TZ">Type of Z values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="yScale">The y-scale factor</param> + <param name="zScale">The z-scale factor</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.Offset``2(SciChart.Charting.Model.DataSeries.IDataSeries{``0,``1},``1)"> + <summary> + Filters data series by offset + </summary> + <typeparam name="TX">Type of X values</typeparam> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="offset">The offset factor</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.Offset``3(SciChart.Charting.Model.DataSeries.IXyzDataSeries{``0,``1,``2},``1,``2)"> + <summary> + Filters data series by offset + </summary> + <typeparam name="TX">Type of X values</typeparam> + <typeparam name="TY">Type of Y values</typeparam> + <typeparam name="TZ">Type of Z values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="yOffset">The y-offset factor</param> + <param name="zOffset">The z-offset factor</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.ToLinearTrendline``2(SciChart.Charting.Model.DataSeries.IDataSeries{``0,``1},System.Boolean)"> + <summary> + Filters data series to linear trendline + </summary> + <param name="dataSeries">Data series to be filtered</param> + <param name="acceptUnsortedData"></param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.ToPolynomialTrend``2(SciChart.Charting.Model.DataSeries.IDataSeries{``0,``1},System.Int32,System.Boolean)"> + <summary> + Filters data series to polynomial trend + </summary> + <param name="dataSeries">Data series to be filtered</param> + <param name="order">The order</param> + <param name="acceptUnsortedData"></param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.ToSpline``1(SciChart.Charting.Model.DataSeries.IDataSeries{``0,System.Double},System.Int32)"> + <summary> + Filters data series to spline + </summary> + <param name="dataSeries">Data series to be filtered</param> + <param name="upSampleFactor">The up sample factor</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByCount``2(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{``0,``1},System.Int32)"> + <summary> + Filters data series by aggregation of count of values + </summary> + <typeparam name="TX">Type of X values</typeparam> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationCount">The count of values that should be aggregated in one</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByCount``2(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{``0,``1},System.Int32,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{``0,``1})"> + <summary> + Filters data series by aggregation of count of values + </summary> + <typeparam name="TX">Type of X values</typeparam> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationCount">The count of values that should be aggregated in one</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByCountDiscontinuousSeries``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.Int32,SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar)"> + <summary> + Filters discontinuous data series by aggregation of count of values. Use it for <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /></summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationCount">The count of values that should be aggregated in one</param> + <param name="calendar">The calendar</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByCountDiscontinuousSeries``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.Int32,SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0})"> + <summary> + Filters discontinuous data series by aggregation of count of values. Use it for <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /></summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationCount">The count of values that should be aggregated in one</param> + <param name="calendar">The calendar</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByTime``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.TimeSpan)"> + <summary> + Filters data series by time aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationTime">The time range for aggregation</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByTime``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.TimeSpan,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0})"> + <summary> + Filters data series by time aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationTime">The time range for aggregation</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByVolume``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.Collections.Generic.IList{``0},``0)"> + <summary> + Filters data series by time aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="volumeData">The list of volumes. It should have the same count as data series</param> + <param name="volumeCount">The count of volumes for each aggregated value</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByVolume``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.Func{System.Int32,``0},``0)"> + <summary> + Filters data series by time aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="volumeSelector">A selector function which returns the volume at index i</param> + <param name="volumeCount">The count of volumes for each aggregated value</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByVolume``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},System.Func{System.Int32,``0},``0,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0})"> + <summary> + Filters data series by time aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="volumeSelector">A selector function which returns the volume at index i</param> + <param name="volumeCount">The count of volumes for each aggregated value</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByRange``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},``0)"> + <summary> + Filters data series by range aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationRange">The price range for aggregation</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByRange``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},``0,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0})"> + <summary> + Filters data series by range aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="aggregationRange">The price range for aggregation</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByRenko``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},``0)"> + <summary> + Filters data series by range aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="brickSize">The brick size for aggregation</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByRenko``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},``0,SciChart.Charting.Model.Filters.AggregationFilters.RenkoSource)"> + <summary> + Filters data series by range aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="brickSize">The brick size for aggregation</param> + <param name="valueSource">The source value for aggregation</param> + <returns>The filtered data series</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByRenko``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},``0,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0})"> + <summary> + Filters data series by range aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="brickSize">The brick size for aggregation</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.FilterExtensions.AggregateByRenko``1(SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0},``0,SciChart.Charting.Model.Filters.AggregationFilters.RenkoSource,SciChart.Charting.Model.DataSeries.IOhlcDataSeries{System.DateTime,``0})"> + <summary> + Filters data series by range aggregation + </summary> + <typeparam name="TY">Type of Y values</typeparam> + <param name="dataSeries">Data series to be filtered</param> + <param name="brickSize">The brick size for aggregation</param> + <param name="filteredDataSeries">DataSeries to which filtered data is going to be output</param> + <param name="valueSource">The source value for aggregation</param> + </member> + <member name="T:SciChart.Charting.Model.Filters.IFilter"> + <summary> + Defines the base interface for filter + </summary> + </member> + <member name="P:SciChart.Charting.Model.Filters.IFilter.FilteredDataSeries"> + <summary> + Filtered data series + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.IFilter.FilterOnAppend(System.Int32)"> + <summary> + Filters on original data series append + </summary> + <param name="originalStartIndex">The start index of original data series</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.IFilter.FilterOnUpdate(System.Int32)"> + <summary> + Filters on original data series update + </summary> + <param name="originalStartIndex">The start index of original data series</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.IFilter.FilterOnInsert(System.Int32,System.Int32)"> + <summary> + Filters on original data series insert + </summary> + <param name="originalStartIndex">The start index of original data series</param> + <param name="changedItemsCount">The amount of changed items</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.IFilter.FilterOnRemove(System.Int32,System.Int32)"> + <summary> + Filters on original data series remove + </summary> + <param name="originalStartIndex">The start index of original data series</param> + <param name="changedItemsCount">The amount of changed items</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.IFilter.FilterAll"> + <summary> + Filters data series. You should implement it if you want to filter in this way for all data series changes. + Override append, update, insert, remove methods to optimize filtering. + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.LUDecomposition.#ctor(System.Double[0:,0:])"> + <summary> + An implementation of LU decomposition. + </summary> + <param name="matrix">A square decomposable matrix</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.Rows(System.Double[0:,0:])"> + <summary> + Get the number of rows in a matrix + </summary> + <param name="self">2d double array representing a matrix</param> + <returns>Number of rows in a matrix</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.Cols(System.Double[0:,0:])"> + <summary> + Get the number of columns in a matrix + </summary> + <param name="self">2d double array representing a matrix</param> + <returns>Number of columns in a matrix</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.Transpose(System.Double[0:,0:])"> + <summary> + Transpose a matrix. + </summary> + <param name="self">Matrix to be transposed</param> + <returns>Transposed matrix</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.Product(System.Double[0:,0:],System.Double[0:,0:])"> + <summary> + Calculate a dot product between two matrices. + </summary> + <param name="self">Matrix A</param> + <param name="other">Matrix B</param> + <returns>Dot product of A*B</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.Identity(System.Double[0:,0:])"> + <summary> + Set the matrix so that it is an identity matrix. + </summary> + <param name="self">Matrix to be set to identity.</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.GetColumn(System.Double[0:,0:],System.Int32)"> + <summary> + Get the matrix column as IEnumerable. + </summary> + <param name="self">Matrix</param> + <param name="col">Column to enumerate</param> + <returns>Enumerated column from a given matrix.</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.PolynomialTrendFilter.LinearAlgebra.Matrix.GetRow(System.Double[0:,0:],System.Int32)"> + <summary> + Get the matrix row as IEnumerable. + </summary> + <param name="self">Matrix</param> + <param name="col">Row to enumerate</param> + <returns>Enumerated row from a given matrix.</returns> + </member> + <member name="T:SciChart.Charting.Model.Filters.RatioFilters.RatioFilter`2"> + <summary> + Calculates the Ratio between two DataSeries, e.g. if DataSeries A has Y values 10 ... 20 ... 30 and DataSeries B has Y values 1,2,3 then the resulting dataseries will have Y-Values 1,1,1 + </summary> + <typeparam name="TX"></typeparam> + <typeparam name="TY"></typeparam> + </member> + <member name="M:SciChart.Charting.Model.Filters.RatioFilters.RatioFilter`2.#ctor(SciChart.Charting.Model.DataSeries.IDataSeries{`0,`1},SciChart.Charting.Model.DataSeries.IDataSeries{`0,`1})"> + <summary> + Initializes a new instance of <see cref="T:SciChart.Charting.Model.Filters.FilterBase" />cref + </summary> + <param name="dataSeriesA">The original data series A</param> + <param name="dataSeriesB">The original data series B</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.RatioFilters.RatioFilter`2.FilterAll"> + <summary> + Filters data series. You should implement it if you want to filter in this way for all data series changes. + Override append, update, insert, remove methods to optimize filtering. + </summary> + </member> + <member name="T:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline"> + <summary> + Cubic spline interpolation. + Call Fit (or use the corrector constructor) to compute spline coefficients, then Eval to evaluate the spline at other X coordinates. + </summary> + <remarks> + <para> + This is implemented based on the wikipedia article: + http://en.wikipedia.org/wiki/Spline_interpolation + I'm not sure I have the right to include a copy of the article so the equation numbers referenced in + comments will end up being wrong at some point. + </para> + <para> + This is not optimized, and is not MT safe. + This can extrapolate off the ends of the splines. + You must provide points in X sort order. + </para> + </remarks> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.#ctor"> + <summary> + Default ctor. + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.#ctor(System.Double[],System.Double[],System.Double,System.Double,System.Boolean)"> + <summary> + Construct and call Fit. + </summary> + <param name="x">Input. X coordinates to fit.</param> + <param name="y">Input. Y coordinates to fit.</param> + <param name="startSlope">Optional slope constraint for the first point. Single.NaN means no constraint.</param> + <param name="endSlope">Optional slope constraint for the final point. Single.NaN means no constraint.</param> + <param name="debug">Turn on console output. Default is false.</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.FitAndEval(System.Double[],System.Double[],System.Double[],System.Double,System.Double,System.Boolean)"> + <summary> + Fit x,y and then eval at points xs and return the corresponding y's. + This does the "natural spline" style for ends. + This can extrapolate off the ends of the splines. + You must provide points in X sort order. + </summary> + <param name="x">Input. X coordinates to fit.</param> + <param name="y">Input. Y coordinates to fit.</param> + <param name="xs">Input. X coordinates to evaluate the fitted curve at.</param> + <param name="startSlope">Optional slope constraint for the first point. Single.NaN means no constraint.</param> + <param name="endSlope">Optional slope constraint for the final point. Single.NaN means no constraint.</param> + <param name="debug">Turn on console output. Default is false.</param> + <returns>The computed y values for each xs.</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.Fit(System.Double[],System.Double[],System.Double,System.Double,System.Boolean)"> + <summary> + Compute spline coefficients for the specified x,y points. + This does the "natural spline" style for ends. + This can extrapolate off the ends of the splines. + You must provide points in X sort order. + </summary> + <param name="x">Input. X coordinates to fit.</param> + <param name="y">Input. Y coordinates to fit.</param> + <param name="startSlope">Optional slope constraint for the first point. Single.NaN means no constraint.</param> + <param name="endSlope">Optional slope constraint for the final point. Single.NaN means no constraint.</param> + <param name="debug">Turn on console output. Default is false.</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.Eval(System.Double[],System.Boolean)"> + <summary> + Evaluate the spline at the specified x coordinates. + This can extrapolate off the ends of the splines. + You must provide X's in ascending order. + The spline must already be computed before calling this, meaning you must have already called Fit() or FitAndEval(). + </summary> + <param name="x">Input. X coordinates to evaluate the fitted curve at.</param> + <param name="debug">Turn on console output. Default is false.</param> + <returns>The computed y values for each x.</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.EvalSlope(System.Double[],System.Boolean)"> + <summary> + Evaluate (compute) the slope of the spline at the specified x coordinates. + This can extrapolate off the ends of the splines. + You must provide X's in ascending order. + The spline must already be computed before calling this, meaning you must have already called Fit() or FitAndEval(). + </summary> + <param name="x">Input. X coordinates to evaluate the fitted curve at.</param> + <param name="debug">Turn on console output. Default is false.</param> + <returns>The computed y values for each x.</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.Compute(System.Double[],System.Double[],System.Double[],System.Double,System.Double,System.Boolean)"> + <summary> + Static all-in-one method to fit the splines and evaluate at X coordinates. + </summary> + <param name="x">Input. X coordinates to fit.</param> + <param name="y">Input. Y coordinates to fit.</param> + <param name="xs">Input. X coordinates to evaluate the fitted curve at.</param> + <param name="startSlope">Optional slope constraint for the first point. Single.NaN means no constraint.</param> + <param name="endSlope">Optional slope constraint for the final point. Single.NaN means no constraint.</param> + <param name="debug">Turn on console output. Default is false.</param> + <returns>The computed y values for each xs.</returns> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.CubicSpline.FitGeometric(System.Double[],System.Double[],System.Int32,System.Double[]@,System.Double[]@)"> + <summary> + Fit the input x,y points using a 'geometric' strategy so that y does not have to be a single-valued + function of x. + </summary> + <param name="x">Input x coordinates.</param> + <param name="y">Input y coordinates, do not need to be a single-valued function of x.</param> + <param name="nOutputPoints">How many output points to create.</param> + <param name="xs">Output (interpolated) x values.</param> + <param name="ys">Output (interpolated) y values.</param> + </member> + <member name="T:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF"> + <summary> + A tri-diagonal matrix has non-zero entries only on the main diagonal, the diagonal above the main (super), and the + diagonal below the main (sub). + </summary> + <remarks> + <para> + This is based on the wikipedia article: http://en.wikipedia.org/wiki/Tridiagonal_matrix_algorithm + </para> + <para> + The entries in the matrix on a particular row are A[i], B[i], and C[i] where i is the row index. + B is the main diagonal, and so for an NxN matrix B is length N and all elements are used. + So for row 0, the first two values are B[0] and C[0]. + And for row N-1, the last two values are A[N-1] and B[N-1]. + That means that A[0] is not actually on the matrix and is therefore never used, and same with C[N-1]. + </para> + </remarks> + </member> + <member name="F:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.A"> + <summary> + The values for the sub-diagonal. A[0] is never used. + </summary> + </member> + <member name="F:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.B"> + <summary> + The values for the main diagonal. + </summary> + </member> + <member name="F:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.C"> + <summary> + The values for the super-diagonal. C[C.Length-1] is never used. + </summary> + </member> + <member name="P:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.N"> + <summary> + The width and height of this matrix. + </summary> + </member> + <member name="P:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.Item(System.Int32,System.Int32)"> + <summary> + Indexer. Setter throws an exception if you try to set any not on the super, main, or sub diagonals. + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.#ctor(System.Int32)"> + <summary> + Construct an NxN matrix. + </summary> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.ToDisplayString(System.String,System.String)"> + <summary> + Produce a string representation of the contents of this matrix. + </summary> + <param name="fmt">Optional. For String.Format. Must include the colon. Examples are ':0.000' and ',5:0.00' </param> + <param name="prefix">Optional. Per-line indentation prefix.</param> + </member> + <member name="M:SciChart.Charting.Model.Filters.SplineInterpolationFilter.TriDiagonalMatrixF.Solve(System.Double[])"> + <summary> + Solve the system of equations this*x=d given the specified d. + </summary> + <remarks> + Uses the Thomas algorithm described in the wikipedia article: http://en.wikipedia.org/wiki/Tridiagonal_matrix_algorithm + Not optimized. Not destructive. + </remarks> + <param name="d">Right side of the equation.</param> + </member> + <member name="T:SciChart.Charting.Model.IAxisDelta"> + <summary> + Defines the interface to a Delta type, which defines Major and Minor deltas as used in <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + </member> + <member name="P:SciChart.Charting.Model.IAxisDelta.MajorDelta"> + <summary> + Gets or sets the Major Delta + </summary> + </member> + <member name="P:SciChart.Charting.Model.IAxisDelta.MinorDelta"> + <summary> + Gets or sets the Minor Delta + </summary> + </member> + <member name="T:SciChart.Charting.Model.IAxisDelta`1"> + <summary> + Defines the Typed interface to a Delta type, which defines Major and Minor deltas as used in <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /></summary> + <typeparam name="T">The typeparameter of this Delta, e.g. <see cref="T:System.Double" /></typeparam> + </member> + <member name="P:SciChart.Charting.Model.IAxisDelta`1.MajorDelta"> + <summary> + Gets or sets the Major Delta + </summary> + </member> + <member name="P:SciChart.Charting.Model.IAxisDelta`1.MinorDelta"> + <summary> + Gets or sets the Minor Delta + </summary> + </member> + <member name="T:SciChart.Charting.Model.Int32AxisDelta"> + <summary> + Defines an Int32 Delta, which provides Major and Minor deltas as used in <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.Int32AxisDelta" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.Int32AxisDelta" /> class. + </summary> + <param name="minorDelta">The minor delta.</param> + <param name="majorDelta">The major delta.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.Int32AxisDelta.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.Int32AxisDelta.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" /> is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Object" />.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.Equals(SciChart.Charting.Model.Int32AxisDelta)"> + <summary> + Indicates whether the current object is equal to another object of the same type. + </summary> + <param name="other">An object to compare with this object.</param> + <returns>true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.op_Equality(SciChart.Charting.Model.Int32AxisDelta,SciChart.Charting.Model.Int32AxisDelta)"> + <summary> + Implements the operator ==. + </summary> + <param name="left">The left.</param> + <param name="right">The right.</param> + <returns>The result of the operator.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.op_Inequality(SciChart.Charting.Model.Int32AxisDelta,SciChart.Charting.Model.Int32AxisDelta)"> + <summary> + Implements the operator !=. + </summary> + <param name="left">The left.</param> + <param name="right">The right.</param> + <returns>The result of the operator.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.Int32AxisDelta.ToString"> + <summary> + Returns a <see cref="T:System.String" /> that represents this instance. + </summary> + <returns>A <see cref="T:System.String" /> that represents this instance.</returns> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Model.TimeSpanDelta"> + <summary> + Defines a TimeSpan Delta, which provides Major and Minor deltas as used in <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.TimeSpanDelta" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.#ctor(System.TimeSpan,System.TimeSpan)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Model.TimeSpanDelta" /> class. + </summary> + <param name="minorDelta">The minor delta.</param> + <param name="majorDelta">The major delta.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.TimeSpanDelta.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Model.TimeSpanDelta.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" /> is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Object" />.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.Equals(SciChart.Charting.Model.TimeSpanDelta)"> + <summary> + Indicates whether the current object is equal to another object of the same type. + </summary> + <param name="other">An object to compare with this object.</param> + <returns>true if the current object is equal to the <paramref name="other" /> parameter; otherwise, false.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.op_Equality(SciChart.Charting.Model.TimeSpanDelta,SciChart.Charting.Model.TimeSpanDelta)"> + <summary> + Implements the operator ==. + </summary> + <param name="left">The left.</param> + <param name="right">The right.</param> + <returns>The result of the operator.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.op_Inequality(SciChart.Charting.Model.TimeSpanDelta,SciChart.Charting.Model.TimeSpanDelta)"> + <summary> + Implements the operator !=. + </summary> + <param name="left">The left.</param> + <param name="right">The right.</param> + <returns>The result of the operator.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Model.TimeSpanDelta.ToString"> + <summary> + Returns a <see cref="T:System.String" /> that represents this instance. + </summary> + <returns>A <see cref="T:System.String" /> that represents this instance.</returns> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.XyDirection"> + <summary> + Defines constants for X or Y direction, used by <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" /> to specify creation of X or Y grid line + </summary> + </member> + <member name="F:SciChart.Charting.XyDirection.XDirection"> + <summary> + Refers to the X-Axis Direction + </summary> + </member> + <member name="F:SciChart.Charting.XyDirection.YDirection"> + <summary> + Refers to the Y-Axis Direction + </summary> + </member> + <member name="F:SciChart.Charting.XyDirection.XYDirection"> + <summary> + Refers to both X and Y Axis Direction + </summary> + </member> + <member name="F:SciChart.Charting.XyDirection.None"> + <summary> + Neither direction. Used by <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> derived types only! + </summary> + </member> + <member name="T:SciChart.Charting.ActionType"> + <summary> + Defines constants for Pan or Zoom actions, used by <see cref="T:SciChart.Charting.ChartModifiers.MouseWheelZoomModifier" /> to specify required action + </summary> + </member> + <member name="F:SciChart.Charting.ActionType.Pan"> + <summary> + Refers to pan action + </summary> + </member> + <member name="F:SciChart.Charting.ActionType.Zoom"> + <summary> + Refers to zoom action + </summary> + </member> + <member name="T:SciChart.Charting.ScientificNotation"> + <summary> + Defines constants for scientific or engineering notation on <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" />. For instance, + using None gives default tick labels, whereas using Normalized gives a scientific notation with superscript + </summary> + </member> + <member name="F:SciChart.Charting.ScientificNotation.None"> + <summary> + Default tick labeling, e.g. 10000 + </summary> + </member> + <member name="F:SciChart.Charting.ScientificNotation.Normalized"> + <summary> + Normalized (Scientific) tick labeling, e.g. 1x10^4 with superscript + </summary> + </member> + <member name="F:SciChart.Charting.ScientificNotation.E"> + <summary> + Engineering tick labeling, e.g. 1E+4 without superscript + </summary> + </member> + <member name="F:SciChart.Charting.ScientificNotation.LogarithmicBase"> + <summary> + Tick labeling with power of other bases, determined by <see cref="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.LogarithmicBase" />. Allows non-integer values as exponent. + E.g. 1x[base]+4.5 with superscript + </summary> + </member> + <member name="F:SciChart.Charting.ScientificNotation.LogarithmicBaseIntegerExponent"> + <summary> + Tick labeling with power of other bases, determined by <see cref="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.LogarithmicBase" />. Keeps exponent value integer. + E.g. 4.53x[base]-12 with superscript + </summary> + </member> + <member name="T:SciChart.Charting.ClipMode"> + <summary> + Defines constants for behavior of the ZoomPanModifier. + - ClipMode.None means you can pan right off the edge of the data into uncharted space. + - ClipMode.StretchAtExtents causes a zooming (stretch) action when you reach the edge of the data. + - ClipAtExtents forces the panning operation to stop suddenly at the extents of the data + - ClipAtMin forces the panning operation to stop suddenly at the minimum of the data, but expand at the maximum + </summary> + </member> + <member name="F:SciChart.Charting.ClipMode.None"> + <summary> + ClipMode.None means you can pan right off the edge of the data into uncharted space. + </summary> + </member> + <member name="F:SciChart.Charting.ClipMode.StretchAtExtents"> + <summary> + ClipMode.StretchAtExtents causes a zooming (stretch) action when you reach the edge of the data. + </summary> + </member> + <member name="F:SciChart.Charting.ClipMode.ClipAtMin"> + <summary> + ClipAtMin forces the panning operation to stop suddenly at the minimum of the data, but expand at the maximum + </summary> + </member> + <member name="F:SciChart.Charting.ClipMode.ClipAtMax"> + <summary> + ClipAtMax forces the panning operation to stop suddenly at the maximum of the data, but expand at the minimum + </summary> + </member> + <member name="F:SciChart.Charting.ClipMode.ClipAtExtents"> + <summary> + ClipAtExtents forces the panning operation to stop suddenly at the extents of the data + </summary> + </member> + <member name="T:SciChart.Charting.AxisDragModes"> + <summary> + Defines Enumeration Constants for modes of operation of the <see cref="T:SciChart.Charting.ChartModifiers.YAxisDragModifier" /></summary> + </member> + <member name="F:SciChart.Charting.AxisDragModes.Scale"> + <summary> + Scale mode: the dragging scales the YAxis VisibleRange property directly, or indirectly, via the GrowBy property, if YAxis.AutoRange=true + </summary> + </member> + <member name="F:SciChart.Charting.AxisDragModes.Pan"> + <summary> + Pan mode: the dragging pans the YAxis VisibleRange, allowing a vertical scroll. This may only be used with YAxis.AutoRange=false + </summary> + </member> + <member name="T:SciChart.Charting.HistoryManagers.AxisKey"> + <summary> + Used in <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /> to unify axis instances + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.AxisKey.Id"> + <summary> + Gets or sets the string Id of this axis. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.AxisKey.IsXAxis"> + <summary> + Gets whether the current axis is an X-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.AxisKey.AxisHashCode"> + <summary> + Gets the hashcode of axis from which this key was created + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.AxisKey.#ctor(System.String,System.Boolean)"> + <summary> + Initialize <see cref="T:SciChart.Charting.HistoryManagers.AxisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.AxisKey.#ctor(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Initialize <see cref="T:SciChart.Charting.HistoryManagers.AxisKey" /></summary> + </member> + <member name="T:SciChart.Charting.HistoryManagers.HistoryStack`1"> + <summary> + The <see cref="T:SciChart.Charting.HistoryManagers.HistoryStack`1" /> provides a generic functionality for the Undo, Redo operations on the history stack. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.HistoryStack`1.Current"> + <summary> + Gets or Sets the range which has been selected from <see cref="T:SciChart.Charting.HistoryManagers.HistoryStack`1" />. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.HistoryStack`1.ErasedRedoItems"> + <summary> + Gets or Sets the collection which has been erased after last push to the <see cref="T:SciChart.Charting.HistoryManagers.HistoryStack`1" />. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Push(`0)"> + <summary> + Pushes a new item to <see cref="T:SciChart.Charting.HistoryManagers.HistoryStack`1" /> and returnt <see cref="F:SciChart.Charting.HistoryManagers.HistoryStack`1.RedoStack" /> if it wasn't empty. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Undo"> + <summary> + Performs the selection of the previously used item + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Redo"> + <summary> + Performs the selection of the item used before the <see cref="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.CanUndo"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.CanRedo"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Redo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Clear"> + <summary> + Clears history + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.GetFullHistory"> + <summary> + Returns full history of type T + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryStack`1.Any"> + <summary> + Determines whether a sequence contains any elements. + </summary> + </member> + <member name="T:SciChart.Charting.HistoryManagers.IZoomHistoryManager"> + <summary> + Initialize the interface for <see cref="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.ParentSurface" /> which is related to single <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /> and is responsible for storing ranges history for all axes + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.MouseWheelThrottle"> + <summary> + Gets or sets the mouse wheel throttle in ms. That is, the time between successive storing of the ranges in <see cref="T:SciChart.Charting.HistoryManagers.IZoomHistoryManager" /></summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.AnimationDuration"> + <summary> + Gets or Sets duration which will be used in <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo" /><see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Redo" /> methods to perform animation + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.HistoryDepth"> + <summary> + Gets or Sets depth of the history + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.ParentSurface"> + <summary> + Gets the <see cref="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.ParentSurface" /> that this <see cref="T:SciChart.Charting.HistoryManagers.IZoomHistoryManager" /> is associated with + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.CanUndo"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo"> + <summary> + Performs the selection of the previously used range for all axes. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.CanUndo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo(SciChart.Charting.HistoryManagers.AxisKey)" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Performs the selection of the previously used range for axis with <paramref name="axisKey" /> id + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.CanRedo"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Redo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Redo"> + <summary> + Performs the selection of the axes ranges used before the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.CanRedo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Redo(SciChart.Charting.HistoryManagers.AxisKey)" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Redo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Performs the selection of range used before the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo" /> operation for the axis with <paramref name="axisKey" /> id. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.UndoCommand"> + <summary> + Performs the selection of the previously used range for all axes. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.IZoomHistoryManager.RedoCommand"> + <summary> + Performs the selection of the axes ranges used before the <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.GetCurrent"> + <summary> + Returns the current (latest) range for all Axis keyed by <see cref="T:SciChart.Charting.HistoryManagers.AxisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.GetCurrent(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Returns current element in history for axis with given <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.GetHistory"> + <summary> + Returns the full range history for all Axis keyed by <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.Id" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.GetHistory(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Returns full history for axis with given <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.Push(SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange)"> + <summary> + USED INTERNALLY IN SCICHART + Pushes <paramref name="newRange" /> into history collection for appropriate <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.PushAll"> + <summary> + Pushes latest range saved by <see cref="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.SaveLatestRange(SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange)" /> method + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.ClearHistory"> + <summary> + Clears all histories + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.ClearHistory(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Clears history for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> with specified <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.SaveLatestRange(SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange)"> + <summary> + Saves the latest <paramref name="range" /> into history collection for appropriate <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.AttachSciChartSurface(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is attached to a <see cref="T:SciChart.Charting.HistoryManagers.IZoomHistoryManager" />. + </summary> + <param name="scs">The <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance</param> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.DetachSciChartSurface"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is detached from a <see cref="T:SciChart.Charting.HistoryManagers.IZoomHistoryManager" />. + </summary> + </member> + <member name="E:SciChart.Charting.HistoryManagers.IZoomHistoryManager.RangeHistoryChanged"> + <summary> + Raised when the RangeHistoryStack is changed + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.IZoomHistoryManager.TryIncrementCounter"> + <summary> + USED INTERNALLY IN SCICHART + </summary> + </member> + <member name="T:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs"> + <summary> + Event Args used by the <see cref="E:SciChart.Charting.HistoryManagers.ZoomHistoryManager.RangeHistoryChanged" /> event + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs.OldRanges"> + <summary> + Gets the old ranges for all <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs.DisposedAmount"> + <summary> + Gets the amount of disposed steps in <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /></summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs.NewRanges"> + <summary> + Gets the new ranges for all <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs.#ctor(System.Collections.Generic.IDictionary{SciChart.Charting.HistoryManagers.AxisKey,System.Collections.Generic.IEnumerable{SciChart.Data.Model.IRange}},System.Collections.Generic.IDictionary{SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange},System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager"> + <summary> + <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /> is related to single <see cref="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.ParentSurface" /> and is responsible for storing ranges history for all axes + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.#ctor"> + <summary> + Initialize <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.#ctor(System.TimeSpan)"> + <summary> + Initialize <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /></summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.MouseWheelThrottle"> + <summary> + Gets or sets the mouse wheel throttle in ms. That is, the time between successive storing of the ranges in <see cref="T:SciChart.Charting.HistoryManagers.IZoomHistoryManager" /></summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.AnimationDuration"> + <summary> + Gets or Sets duration which will be used in <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo" /><see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Redo" /> methods to perform animation + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.HistoryDepth"> + <summary> + Gets or Sets depth of the history + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.ParentSurface"> + <summary> + Gets the <see cref="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.ParentSurface" /> that this <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" /> is associated with + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.CanUndo"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo"> + <summary> + Performs the selection of the previously used range for all axes. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.CanUndo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo(SciChart.Charting.HistoryManagers.AxisKey)" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Performs the selection of the previously used range for axis with <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.CanRedo"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Redo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Redo"> + <summary> + Performs the selection of the axes ranges used before the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.CanRedo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Reports the value indicating wether it is possible to perform the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Redo(SciChart.Charting.HistoryManagers.AxisKey)" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Redo(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Performs the selection of range used before the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo" /> operation for the axis with <paramref name="axisKey" />. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.UndoCommand"> + <summary> + Performs the selection of the previously used range for all axes. + </summary> + </member> + <member name="P:SciChart.Charting.HistoryManagers.ZoomHistoryManager.RedoCommand"> + <summary> + Performs the selection of the axes ranges used before the <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Undo" /> operation. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.GetCurrent"> + <summary> + Returns the current (latest) range for all Axis keyed by <see cref="T:SciChart.Charting.HistoryManagers.AxisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.GetCurrent(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Returns current element in history for axis with given <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.GetHistory"> + <summary> + Returns the full range history for all Axis keyed by <see cref="T:SciChart.Charting.HistoryManagers.AxisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.GetHistory(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Returns full history for axis with given <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.Push(SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange)"> + <summary> + USED INTERNALLY IN SCICHART + Pushes <paramref name="newRange" /> into history collection for appropriate <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.PushAll"> + <summary> + Pushes latest range saved by <see cref="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.SaveLatestRange(SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange)" /> method + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.ClearHistory"> + <summary> + Clears all histories + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.ClearHistory(SciChart.Charting.HistoryManagers.AxisKey)"> + <summary> + Clears history for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> with specified <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.SaveLatestRange(SciChart.Charting.HistoryManagers.AxisKey,SciChart.Data.Model.IRange)"> + <summary> + Saves the latest <paramref name="range" /> into history collection for appropriate <paramref name="axisKey" /></summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.TryIncrementCounter"> + <summary> + USED INTERNALLY IN SCICHART + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.AttachSciChartSurface(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is attached to a <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" />. + </summary> + <param name="scs">The <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance</param> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.DetachSciChartSurface"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is detached from a <see cref="T:SciChart.Charting.HistoryManagers.ZoomHistoryManager" />. + </summary> + </member> + <member name="E:SciChart.Charting.HistoryManagers.ZoomHistoryManager.RangeHistoryChanged"> + <summary> + Raised when the RangeHistoryStack is changed + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.OnRangeHistoryChanged(SciChart.Charting.HistoryManagers.HistoryChangedEventArgs)"> + <summary> + Raises the RangeHistoryChanged event + </summary> + <param name="args">The <see cref="T:SciChart.Charting.HistoryManagers.HistoryChangedEventArgs" /> containing event data</param> + </member> + <member name="E:SciChart.Charting.HistoryManagers.ZoomHistoryManager.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="M:SciChart.Charting.HistoryManagers.ZoomHistoryManager.OnPropertyChanged(System.String)"> + <summary> + Called when [property changed]. + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="T:SciChart.Charting.Numerics.Calendars.DefaultDiscontinuousDateTimeCalendar"> + <summary> + Provides adding time ranges to skip for <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /></summary> + </member> + <member name="T:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase"> + <summary> + Base class for discontinuous date time calendar + </summary> + </member> + <member name="F:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.DiscontinuousAxisHelper"> + <summary> + Provides ability to interact with discontinuous range + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.SkipDayTimeRange"> + <summary> + Gets or sets skipped time ranges in a day + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.SkipDaysInWeek"> + <summary> + Gets or sets skipped days in a week + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.SkipDates"> + <summary> + Gets or sets particular days to skip + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.BusinessHours"> + <summary> + Gets business hours + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.#ctor"> + <summary> + Initializes new instance of <see cref="T:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.IsValueInGap(System.DateTime)"> + <summary> + Checks if DateTime is in a gap + </summary> + <param name="dateTime">DateTime that needs to be checked</param> + <returns>True if checked data value is in a gap</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.IsDayInGap(System.DateTime)"> + <summary> + Checks if day is in a gap + </summary> + <param name="dateTime">Day that needs to be checked</param> + <returns>True if checked day is in a gap</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.GetDiffBetweenValues(System.DateTime,System.DateTime,System.Boolean)"> + <summary> + Calculates difference between two values taking gaps into account + </summary> + <param name="start">Start value to make calculation</param> + <param name="end">End value to make calculation</param> + <param name="includeEnd">True if end is included, used for tick and range calculation</param> + <returns>Business time in ticks</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.GetValueByOffset(System.DateTime,System.Double)"> + <summary> + Gets value from start by offset + </summary> + <param name="start">Start value</param> + <param name="offset">Value that start should be shifted to</param> + <returns>Data value after shifting</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.GetClosestBiggerDate(System.DateTime)"> + <summary> + Gets the closest available bigger date + </summary> + <param name="dateTime">Date time that should be rounded to the first bigger available date</param> + <returns>The first bigger available date</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.DiscontinuousDateTimeCalendarBase.GetClosestSmallerDate(System.DateTime)"> + <summary> + Gets the closest available smaller date + </summary> + <param name="dateTime">Date time that should be rounded to the first smaller available date</param> + <returns>The first smaller available date</returns> + </member> + <member name="T:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar"> + <summary> + A base interface for date time calendars + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.SkipDayTimeRange"> + <summary> + Gets or sets skipped time ranges in a day + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.SkipDaysInWeek"> + <summary> + Gets or sets skipped days in a week + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.SkipDates"> + <summary> + Gets or sets particular days to skip + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.BusinessHours"> + <summary> + Gets business hours + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.IsValueInGap(System.DateTime)"> + <summary> + Checks if DateTime is in a gap + </summary> + <param name="dateTime">DateTime that needs to be checked</param> + <returns>True if checked data value is in a gap</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.IsDayInGap(System.DateTime)"> + <summary> + Checks if day is in a gap + </summary> + <param name="dateTime">DateTime that needs to be checked</param> + <returns>True if checked day is in a gap</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.GetDiffBetweenValues(System.DateTime,System.DateTime,System.Boolean)"> + <summary> + Calculates units beetwen two values in ticks + </summary> + <param name="start">Start value to make calculation</param> + <param name="end">End value to make calculation</param> + <param name="includeEnd">True if end is included, used for tick and range calculation</param> + <returns>Number of ticks betwen values taking gaps into account</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.GetValueByOffset(System.DateTime,System.Double)"> + <summary> + Gets value from start by offset + </summary> + <param name="start">Start value</param> + <param name="offset">Value that start should be shifted to</param> + <returns>Data value after shifting</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.GetClosestBiggerDate(System.DateTime)"> + <summary> + Gets the closest available bigger date + </summary> + <param name="dateTime">Date time that shoud be rounded to the first bigger available date</param> + <returns>The first bigger available date</returns> + </member> + <member name="M:SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar.GetClosestSmallerDate(System.DateTime)"> + <summary> + Gets the closest available smaller date + </summary> + <param name="dateTime">Date time that shoud be rounded to the first smaller available date</param> + <returns>The first smaller available date</returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculatorFactory"> + <summary> + Used internally by SciChart. Defines the interface to the coordinate calculator factor, which creates an appropriate coordinate calculator for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> passed in + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculatorFactory.New(SciChart.Charting.Visuals.Axes.AxisParams)"> + <summary> + Creates a new <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></summary> + <param name="arg">The <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> instance containing axis data</param> + <returns>The Coordinate calculator instance</returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.CoordinateCalculatorFactory"> + <summary> + Creates an appropriate coordinate calculator for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> passed in. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.CoordinateCalculatorFactory.New(SciChart.Charting.Visuals.Axes.AxisParams)"> + <summary> + Creates a new <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></summary> + <param name="arg">The <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> instance containing axis data</param> + <returns> + The Coordinate calculator instance + </returns> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis" /> specific ICoordinateCalculator, to convert from pixel coordinate to index to data value and back + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator.TransformDataToIndex(System.IComparable)"> + <summary> + Takes a data-value and transforms to integer index on the axis + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator.TransformIndexToData(System.Int32)"> + <summary> + Takes an integer index (or point number) to the underlying data and transforms to the data value on the axis. + + e.g. if the axis is a CategoryDateTimeAxis, accepts index, returns DateTime. + + If the index lies outside of the data-range, a projection is performed + </summary> + <param name="index">The index to the underlying data series</param> + <returns>The data value</returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator`1"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis" /> specific ICoordinateCalculator, to convert from pixel coordinate to index to data value and back + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator`1.TransformIndexToData(System.Int32)"> + <summary> + Takes an integer index (or point number) to the underlying data and transforms to the data value on the axis. + + e.g. if the axis is a CategoryDateTimeAxis, accepts index, returns DateTime. + + If the index lies outside of the data-range, a projection is performed + </summary> + <param name="index">The index to the underlying data series</param> + <returns>The data value</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator`1.TransformDataToIndex(`0)"> + <summary> + Takes a T data-value and transforms to integer index on the axis + + e.g. if the axis is a CategoryDateTimeAxis, accepts DateTime, returns index. + + If the T lies outside of the data-range, a projection is performed + </summary> + <param name="dataValue">The data value</param> + <returns>The index to the underlying data series</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICategoryCoordinateCalculator`1.TransformDataToIndex(`0,SciChart.Charting.Common.Extensions.SearchMode)"> + <summary> + Takes a T data-value and transforms to integer index on the axis + + e.g. if the axis is a CategoryDateTimeAxis, accepts DateTime, returns index. + + If the T lies outside of the data-range, a projection is performed + </summary> + <param name="dataValue">The data value</param> + <param name="searchMode">Indicates a way in wich to look for the <paramref name="dataValue" /></param> + <returns>The index to the underlying data series or -1 if <see cref="F:SciChart.Charting.Common.Extensions.SearchMode.Exact" /> and the <paramref name="dataValue" /> doesn't exist.</returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.IDiscontinuousCoordinateCalculator"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /> specific ICoordinateCalculator, to convert from pixel coordinate to index to data value and back. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.IDiscontinuousCoordinateCalculator.Calendar"> + <summary> + Returns axis Calendar. + See <see cref="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.Calendar" />. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.IDiscontinuousCoordinateCalculator.GetExactCoordinate(System.Double)"> + <summary> + Transforms a data value into a pixel coordinate. + </summary> + <remarks>Unlike the <see cref="!:ICoordinateCalculator<T>.GetCoordinate(double)" />, returns exact pixel coordinates for values skipped by axis calendar.</remarks> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.IDiscontinuousCoordinateCalculator.GetExactCoordinate(System.DateTime)"> + <summary> + Transforms a data value into a pixel coordinate. + </summary> + <remarks>Unlike the <see cref="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.GetCoordinate(System.DateTime)" />, returns exact pixel coordinates for values skipped by axis calendar.</remarks> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.ILogarithmicCoordinateCalculator"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> specific ICoordinateCalculator, to obtain LogarithmicBase + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ILogarithmicCoordinateCalculator.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator"> + <summary> + Ternary coordinate calculators + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.#ctor(SciChart.Charting.Visuals.SciChartTernarySurface,SciChart.Charting.Visuals.Axes.ITernaryAxis,SciChart.Charting.Visuals.Axes.ITernaryAxis,SciChart.Charting.Visuals.Axes.ITernaryAxis)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator" /> class. + </summary> + <param name="scts">parent surface</param> + <param name="xAxis">XAxis of parent surface</param> + <param name="yAxis">YAxis of parent surface</param> + <param name="zAxis">ZAxis of parent surface</param> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.ISciChartTernarySurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.XAxis"> + <summary> + Gets or sets the XAxis control on the SciChartTernarySurface + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.YAxis"> + <summary> + Gets or sets the YAxis control on the SciChartTernarySurface (default side=Right) + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.ZAxis"> + <summary> + Gets or sets the ZAxis control on the SciChartTernarySurface (default side=Left) + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetXCoordCalculatorForXAxis"> + <summary> + Get X coordinate calculator for XAxis + </summary> + <returns> X coordinate calculator for XAxis </returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetXCoordCalculatorForYAxis"> + <summary> + Get X coordinate calculator for YAxis + </summary> + <returns> X coordinate calculator for YAxis </returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetXCoordCalculatorForZAxis"> + <summary> + Get X coordinate calculator for ZAxis + </summary> + <returns> X coordinate calculator for ZAxis </returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetYCoordCalculatorForYAxis"> + <summary> + Get Y coordinate calculator for YAxis + </summary> + <returns> Y coordinate calculator for YAxis </returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetYCoordCalculatorForZAxis"> + <summary> + Get Y coordinate calculator for ZAxis + </summary> + <returns> Y coordinate calculator for ZAxis </returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetDataValuesFromCoord(System.Windows.Point,System.Double@,System.Double@,System.Double@)"> + <summary> + Get data value from coordinate + </summary> + <param name="rawPoint">Current coordinate</param> + <param name="xDataValue">X data value </param> + <param name="yDataValue">Y data value </param> + <param name="zDataValue">Z data value </param> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetIntersectionCoord(SciChart.Charting.Model.DataSeries.IXyzDataSeries{System.Double,System.Double,System.Double},System.Int32)"> + <summary> + Get intersection coordinate from data values. + </summary> + <param name="dataSeries">Current data series</param> + <param name="index">Index ofdata values</param> + <returns>Intersection coordinate</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator.GetIntersectionCoord(System.Double,System.Double,System.Double)"> + <summary> + Get intersection coordinate from x, y and z data values. + </summary> + <param name="x">X data value</param> + <param name="y">Y data value</param> + <param name="z">Z data value</param> + <returns>Intersection coordinate</returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.CategoryTickCoordinatesProvider"> + <summary> + Provides methods to convert arrays of major and minor ticks (data values) into pixel coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.CategoryTickCoordinatesProvider.GetTickCoordinates(System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Converts arrays of major and minor ticks (data values) into <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </summary> + <param name="minorTicks">The minor ticks, cast to double.</param> + <param name="majorTicks">The major ticks, cast to double.</param> + <returns> + The <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.DefaultTickCoordinatesProvider"> + <summary> + Provides methods to convert arrays of major and minor ticks (data values) into pixel coordinates. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.DefaultTickCoordinatesProvider.GetTickCoordinates(System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Converts arrays of major and minor ticks (data values) into <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </summary> + <param name="minorTicks">The minor ticks, cast to double.</param> + <param name="majorTicks">The major ticks, cast to double.</param> + <returns>The <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates.</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.DefaultTickCoordinatesProvider.IsInBounds(System.Double)"> + <summary> + Checks whether GridLinesPanel contains passed coordinate + </summary> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.ITickCoordinatesProvider"> + <summary> + Provides the interface to a Tick Coordinate Provider, which converts arrays of major and minor ticks (data values) into pixel coordinates. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.ITickCoordinatesProvider.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.ITickCoordinatesProvider" /> is initialized as it is attached to the parent axis, with the parent axis instance + </summary> + <param name="parentAxis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxisCore" /> instance</param> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.ITickCoordinatesProvider.GetTickCoordinates(System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Converts arrays of major and minor ticks (data values) into <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates + </summary> + <param name="minorTicks">The minor ticks, cast to double</param> + <param name="majorTicks">The major ticks, cast to double</param> + <returns>The <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates</returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.NumericCategoryTickCoordinatesProvider"> + <summary> + Provides methods to convert arrays of major and minor ticks (data values) into pixel coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.NumericCategoryTickCoordinatesProvider.GetTickCoordinates(System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Converts arrays of major and minor ticks (data values) into <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </summary> + <param name="minorTicks">The minor ticks, cast to double.</param> + <param name="majorTicks">The major ticks, cast to double.</param> + <returns> + The <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.RadarTickCoordinatesProvider"> + <summary> + Provides methods to convert arrays of major and minor ticks (data values) into pixel coordinates. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.RadarTickCoordinatesProvider.CalculateTickCoords(System.Collections.Generic.IList{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Boolean)"> + <summary> + Converts arrays of major and minor ticks (data values) into <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </summary> + <param name="ticks">A list with tick values.</param> + <param name="coordinateCalculator">A coordinate calculator.</param> + <param name="isMajor">Whether these are major ticks or not.</param> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.StaticTickCoordinatesProvider"> + <summary> + Provides methods to convert arrays of major and minor ticks (data values) into pixel coordinates. + Used when the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> is in static mode(<see cref="P:SciChart.Charting.Visuals.Axes.IAxis.IsStaticAxis" />==<value>true</value>). + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.StaticTickCoordinatesProvider.GetTickCoordinates(System.Collections.Generic.IList{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Converts arrays of major and minor ticks (data values) into <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </summary> + <param name="minorTicks">The minor ticks, cast to double.</param> + <param name="majorTicks">The major ticks, cast to double.</param> + <returns> + The <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> structure containing pixel coordinates. + </returns> + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates"> + <summary> + A structure contaning tick coordinates. Used internally when drawing tick marks and grid lines. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates.#ctor(System.Double[],System.Double[],System.Single[],System.Single[])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates" /> struct. + </summary> + <param name="minorTicks">The minor ticks represented in chart coordinates.</param> + <param name="majorTicks">The major ticks represented in chart coordinates.</param> + <param name="minorCoords">The minor ticks represented in pixel coordinates.</param> + <param name="majorCoords">The major ticks represented in pixel coordinates.</param> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates.IsEmpty"> + <summary> + Returns a value indicating whether there are any tick coordinates. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates.MinorTicks"> + <summary> + Returns minor ticks in chart coordinates. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates.MajorTicks"> + <summary> + Returns major ticks in chart coordinates. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates.MinorTickCoordinates"> + <summary> + Returns major ticks in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates.MajorTickCoordinates"> + <summary> + Returns major ticks in pixels. + </summary> + </member> + <member name="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator"> + <summary> + Provides an interface for Delta calculators + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator.GetDeltaFromRange(System.IComparable,System.IComparable,System.Int32,System.UInt32)"> + <summary> + Given an absolute Axis Min and Max, returns a TickRange instance containing sensible MinorDelta and MajorDelta values + </summary> + </member> + <member name="T:SciChart.Charting.Numerics.DeltaCalculators.IDateDeltaCalculator"> + <summary> + Defines the interface for DateTime or TimeSpan Delta calculators + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.DeltaCalculators.IDateDeltaCalculator.GetDeltaFromRange(System.IComparable,System.IComparable,System.Int32,System.UInt32)"> + <summary> + Given an absolute Axis Min and Max, returns a TickRange instance containing sensible MinorDelta and MajorDelta values + </summary> + </member> + <member name="T:SciChart.Charting.Numerics.ProviderBase"> + <summary> + A base class for TickCoordinate Providers and LabelProviders. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.ProviderBase.ParentAxis"> + <summary> + Gets the axis current provider instance was initialized with + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.ProviderBase.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the provider instance is initialized as it is attached to the parent axis, with the parent axis instance + </summary> + <param name="parentAxis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxisCore" /> instance</param> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.DateTimeTickProvider"> + <summary> + Provides tick coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DateTimeTickProvider.RoundUp(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Rounds up the <see cref="T:System.IComparable" /> to the nearest TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns> + The rounded value + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DateTimeTickProvider.IsAdditionValid(System.IComparable,System.TimeSpan)"> + <summary> + Determines whether addition is valid between the current <see cref="T:System.IComparable" /> and the TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current.</param> + <param name="delta">The delta.</param> + <returns> + If True, addition is valid + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DateTimeTickProvider.AddDelta(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Adds the <see cref="T:System.IComparable" /> to the nearest TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns> + The addition result + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DateTimeTickProvider.IsDivisibleBy(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Determines whether the <see cref="T:System.IComparable" /> is divisible by the TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns>If True, IsDivisibleBy</returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider"> + <summary> + Provides tick coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Calls <see cref="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})" /> to calcuate Minor Ticks, then returns a double representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to double)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Calls <see cref="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMajorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})" /> to calcuate Minor Ticks, then returns a double representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to double)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.GetMajorTicks(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,System.Int32,SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Given a double tick range with Min, Max, MajorDelta and MinorDelta, return an array of absolute values for major ticks + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.IsParamsValid(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Determines whether the VisibleRange and Delta parameters are valid, e.g. are Real Numbers, and VisibleRange.Min < Max + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Delta, e.g. MinorDelta, MajorDelta</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.GetMinorTicks(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,System.Int32,SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Given a tickRange with Min, Max, MajorDelta and MinorDelta, return an array of absolute values for minor ticks + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.GetMinorTicks(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,System.Int32,System.DateTime,SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double},System.Double[])"> + <summary> + Given a tickRange with Min, Max, MajorDelta and MinorDelta, return an array of absolute values for minor ticks + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.CalculateMajorTicks(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,System.Int32,SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Major Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="calendar">The Calendar</param> + <param name="maxAutoTicks">The maximal amount of auto ticks</param> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns>The Major ticks (data values) as double</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.CalculateMinorTicks(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,System.Int32,SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="calendar">The Calendar</param> + <param name="maxAutoTicks">The maximal amount of auto ticks</param> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <param name="majorTicks">The previously calculated Major Ticks</param> + <returns>The Minor Ticks (data values) as double</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.DiscontinuousAxisTickProvider.DiscontinuousDateTimeTickProvider.CalculateMinorTicks(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,System.Int32,SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="calendar">The Calendar</param> + <param name="maxAutoTicks"></param> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns>The Major ticks (data values) as double</returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.ITickProvider"> + <summary> + Provides base interface for tick providers + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.ITickProvider.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the tick provider is initialized as it is attached to the parent axis, with the parent axis instance + </summary> + <param name="axis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance</param> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.ITickProvider.GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns double representation of major ticks array for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /></summary> + <param name="axis"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.ITickProvider.GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns double representation of minor ticks array for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /></summary> + <param name="axis"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.ITickProvider`1"> + <summary> + Provides interface for tick providers + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.ITickProvider`1.GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns array of major ticks from tick provider for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /></summary> + <param name="axis"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.ITickProvider`1.GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns array of minor ticks from tick provider for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /></summary> + <param name="axis"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.LogarithmicNegativeTickProvider"> + <summary> + Provides tick Coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.LogarithmicNegativeTickProvider.CalculateMajorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Major Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns> + The Major ticks (data values) as double + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.LogarithmicNegativeTickProvider.CalculateMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns> + The Major ticks (data values) as double + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.LogarithmicNegativeTickProvider.CalculateMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <param name="majorTicks"></param> + <returns> + The Major ticks (data values) as double + </returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.LogarithmicNumericTickProvider"> + <summary> + Provides tick Coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /></summary> + </member> + <member name="P:SciChart.Charting.Numerics.TickProviders.LogarithmicNumericTickProvider.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.LogarithmicNumericTickProvider.CalculateMajorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Major Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns> + The Major ticks (data values) as double + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.LogarithmicNumericTickProvider.CalculateMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns> + The Major ticks (data values) as double + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.LogarithmicNumericTickProvider.CalculateMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <param name="majorTicks"></param> + <returns> + The Major ticks (data values) as double + </returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.NumericTickProvider"> + <summary> + Provides tick Coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Calls <see cref="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})" /> to calcuate Minor Ticks, then returns a double representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to double)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Calls <see cref="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMajorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})" /> to calcuate Minor Ticks, then returns a double representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to double)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMajorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Given a double tick range with Min, Max, MajorDelta and MinorDelta, return an array of absolute values for major ticks + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.IsParamsValid(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Determines whether the VisibleRange and Delta parameters are valid, e.g. are Real Numbers, and VisibleRange.Min < Max + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Delta, e.g. MinorDelta, MajorDelta</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Given a tickRange with Min, Max, MajorDelta and MinorDelta, return an array of absolute values for minor ticks + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.GetMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double},System.Double[])"> + <summary> + Given a tickRange with Min, Max, MajorDelta and MinorDelta, return an array of absolute values for minor ticks + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.CalculateMajorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Major Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns>The Major ticks (data values) as double</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.CalculateMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double},System.Collections.Generic.IList{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <param name="majorTicks">The previously calculated Major Ticks</param> + <returns>The Minor Ticks (data values) as double</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.NumericTickProvider.CalculateMinorTicks(SciChart.Data.Model.IRange{System.Double},SciChart.Charting.Model.IAxisDelta{System.Double})"> + <summary> + Calculates the Minor Ticks for the axis given a VisibleRange and Delta + </summary> + <param name="tickRange">The VisibleRange</param> + <param name="tickDelta">The Deltas, e.g. MinorDelta and MajorDelta</param> + <returns>The Major ticks (data values) as double</returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.TickProvider`1"> + <summary> + Abstract base implementation of <see cref="T:SciChart.Charting.Numerics.TickProviders.ITickProvider" /></summary> + <typeparam name="T">The type of ticks for tick provider, e.g. <see cref="T:System.Double" /></typeparam> + </member> + <member name="P:SciChart.Charting.Numerics.TickProviders.TickProvider`1.ParentAxis"> + <summary> + Called when the tick provider is initialized as it is attached to the parent axis, with the parent axis instance + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TickProvider`1.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the tick provider is initialized as it is attached to the parent axis, with the parent axis instance + </summary> + <param name="axis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance</param> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TickProvider`1.SciChart#Charting#Numerics#TickProviders#ITickProvider#GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns double representation of major ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to double)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TickProvider`1.SciChart#Charting#Numerics#TickProviders#ITickProvider#GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns double representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to double)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TickProvider`1.ConvertTicks``1(System.Collections.Generic.IList{``0})"> + <summary> + Converts ticks in generic format to Double, e.g. cast to double for numeric types, or cast DateTime.Ticks to double for DateTime types + </summary> + <param name="ticks"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TickProvider`1.GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns Generic-typed representation of major ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to T)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TickProvider`1.GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns Generic-typed representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to T)</returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProvider"> + <summary> + Provides tick coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProvider.GetTicks(System.IComparable)"> + <summary> + Returns <see cref="P:System.DateTime.Ticks" /> or <see cref="P:System.TimeSpan.Ticks" /> depending on derived type + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProvider.RoundUp(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Rounds up the <see cref="T:System.IComparable" /> to the nearest TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns> + The rounded value + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProvider.IsAdditionValid(System.IComparable,System.TimeSpan)"> + <summary> + Determines whether addition is valid between the current <see cref="T:System.IComparable" /> and the TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current.</param> + <param name="delta">The delta.</param> + <returns> + If True, addition is valid + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProvider.AddDelta(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Adds the <see cref="T:System.IComparable" /> to the nearest TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns> + The addition result + </returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProvider.IsDivisibleBy(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Determines whether the <see cref="T:System.IComparable" /> is divisible by the TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns> + If True, IsDivisibleBy + </returns> + </member> + <member name="T:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase"> + <summary> + A Common base class for TimeSpan and DateTimeTickProviders, which provide tick coordinates for the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /></summary> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.GetMajorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns Generic-typed representation of major ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to T)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.GetMinorTicks(SciChart.Charting.Visuals.Axes.IAxisParams)"> + <summary> + Returns Generic-typed representation of minor ticks array + </summary> + <param name="axis">The AxisParams for the axis</param> + <returns>The array of ticks to display (data values converted to T)</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.ConvertTicks``1(System.Collections.Generic.IList{``0})"> + <summary> + Converts ticks in generic format to Double, e.g. cast to double for numeric types, or cast DateTime.Ticks to double for DateTime types + </summary> + <param name="ticks"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.GetTicks(System.IComparable)"> + <summary> + Returns <see cref="P:System.DateTime.Ticks" /> or <see cref="P:System.TimeSpan.Ticks" /> depending on derived type + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.RoundUp(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Rounds up the <see cref="T:System.IComparable" /> to the nearest TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns>The rounded value</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.IsAdditionValid(System.IComparable,System.TimeSpan)"> + <summary> + Determines whether addition is valid between the current <see cref="T:System.IComparable" /> and the TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current.</param> + <param name="delta">The delta.</param> + <returns>If True, addition is valid</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.AddDelta(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Adds the <see cref="T:System.IComparable" /> to the nearest TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns>The addition result</returns> + </member> + <member name="M:SciChart.Charting.Numerics.TickProviders.TimeSpanTickProviderBase.IsDivisibleBy(System.IComparable,System.TimeSpan)"> + <summary> + When overriden in a derived class, Determines whether the <see cref="T:System.IComparable" /> is divisible by the TimeSpan specified by <paramref name="delta" /></summary> + <param name="current">The current value.</param> + <param name="delta">The delta.</param> + <returns>If True, IsDivisibleBy</returns> + </member> + <member name="T:SciChart.Charting.Properties.Resources"> + <summary> + A strongly-typed resource class, for looking up localized strings, etc. + </summary> + </member> + <member name="T:SciChart.Charting.Services.IRadarChartRenderer"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting.Services.RadarChartRenderer" />, which handles the render pass on the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="T:SciChart.Charting.Services.RendererErrorCode"> + <summary> + Error code returned by the Renderer in 2D or 3D + </summary> + </member> + <member name="M:SciChart.Charting.Services.RendererErrorCode.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Services.RendererErrorCode" /> class. + </summary> + <param name="value">The value.</param> + </member> + <member name="T:SciChart.Charting.Services.RendererErrorCodes"> + <summary> + Error codes for the SciChart internal renderer + </summary> + </member> + <member name="T:SciChart.Charting.Services.RenderPassInfo"> + <summary> + Defines data for the current render pass + </summary> + </member> + <member name="M:SciChart.Charting.Services.RenderPassInfo.#ctor(System.Int32,System.Windows.Size)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Services.RenderPassInfo" /> class. + </summary> + <param name="seriesCount">The number of renderable series to draw.</param> + <param name="viewportSize">The current viewport size.</param> + </member> + <member name="M:SciChart.Charting.Services.RenderPassInfo.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Services.RenderPassInfo" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.ViewportSize"> + <summary> + Gets or sets the current Viewport Size + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.RenderableSeries"> + <summary> + Gets or sets an array of RenderableSeries to draw + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.PointSeries"> + <summary> + Gets or sets an array of <see cref="T:SciChart.Data.Model.IPointSeries" /> which provide data + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.ResamplingHashes"> + <summary> + Gets or sets an array of resampling hashes for appropriate point series + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.DataSeries"> + <summary> + Gets or sets an array of <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> which source data + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.IndicesRanges"> + <summary> + Gets or sets an array of <see cref="T:SciChart.Data.Model.IntegerRange" /> which provide indices to the source data-series in view + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.XCoordinateCalculators"> + <summary> + Gets a keyed dictionary of XAxis CoordinateCalculators + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.YCoordinateCalculators"> + <summary> + Gets a keyed dictionary of YAxis CoordinateCalculators + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.TransformationStrategy"> + <summary> + Gets or sets the current pixel transformation strategy + </summary> + </member> + <member name="P:SciChart.Charting.Services.RenderPassInfo.Warnings"> + <summary> + Gets or sets a collection of warning messages + </summary> + </member> + <member name="M:SciChart.Charting.Services.RenderPassInfo.StoreXAxisCoordinateCalculators(SciChart.Charting.Model.AxisCollection)"> + <summary> + Stores coordinate calculators for a collection of X axes + </summary> + </member> + <member name="M:SciChart.Charting.Services.RenderPassInfo.StoreYAxisCoordinateCalculators(SciChart.Charting.Model.AxisCollection)"> + <summary> + Stores coordinate calculators for a collection of Y axes + </summary> + </member> + <member name="T:SciChart.Charting.Services.RenderPassTernaryInfo"> + <summary> + Defines data for the current Ternary render pass + </summary> + </member> + <member name="F:SciChart.Charting.Services.RenderPassTernaryInfo.RenderableSeries"> + <summary> + Gets or sets an array of RenderableSeries to draw + </summary> + </member> + <member name="F:SciChart.Charting.Services.RenderPassTernaryInfo.DataSeries"> + <summary> + Gets or sets an array of <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> which source data + </summary> + </member> + <member name="F:SciChart.Charting.Services.RenderPassTernaryInfo.XCoordinateCalculator"> + <summary> + Gets or sets a keyed dictionary of XAxis CoordinateCalculators + </summary> + </member> + <member name="F:SciChart.Charting.Services.RenderPassTernaryInfo.YCoordinateCalculator"> + <summary> + Gets or sets a keyed dictionary of YAxis CoordinateCalculators + </summary> + </member> + <member name="F:SciChart.Charting.Services.RenderPassTernaryInfo.ZCoordinateCalculator"> + <summary> + Gets or sets a keyed dictionary of ZAxis CoordinateCalculators + </summary> + </member> + <member name="T:SciChart.Charting.Services.ISciChartRenderer"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting.Services.SciChartRenderer" />, which handles the render pass on the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Services.ISciChartRenderer.RenderLoop(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Executes a single render pass. + </summary> + </member> + <member name="T:SciChart.Charting.Services.ITernaryChartRenderer"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting.Services.TernaryChartRenderer" />, which handles the render pass on the <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></summary> + </member> + <member name="T:SciChart.Charting.StrategyManager.IAnnotationPlacementStrategy"> + <summary> + Defines the interface for methods which allows to place annotation + </summary> + </member> + <member name="M:SciChart.Charting.StrategyManager.IAnnotationPlacementStrategy.PlaceAnnotation(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Places annotation with specific annotation coordinates + </summary> + <param name="coordinates"></param> + </member> + <member name="M:SciChart.Charting.StrategyManager.IAnnotationPlacementStrategy.GetBasePoints(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Gets base points for annotation instance + </summary> + <param name="coordinates"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.StrategyManager.IAnnotationPlacementStrategy.SetBasePoint(System.Windows.Point,System.Int32)"> + <summary> + Sets base point for annotation + </summary> + <param name="newPoint"></param> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.StrategyManager.IAnnotationPlacementStrategy.IsInBounds(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,SciChart.Charting.Visuals.Annotations.IAnnotationCanvas)"> + <summary> + Checks whether coordinates are within canvas bounds + </summary> + <param name="coordinates"></param> + <param name="annotationCanvas"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.StrategyManager.IAnnotationPlacementStrategy.MoveAnnotationTo(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,System.Double,System.Double,SciChart.Charting.Visuals.Annotations.IAnnotationCanvas)"> + <summary> + Moves the annotation to a specific horizontal and vertical offset + </summary> + <param name="coordinates"></param> + <param name="horizontalOffset"></param> + <param name="verticalOffset"></param> + <param name="annotationCanvas"></param> + </member> + <member name="T:SciChart.Charting.StrategyManager.IStrategyManager"> + <summary> + Provides access to different strategies for polar/cartesian chart + </summary> + </member> + <member name="M:SciChart.Charting.StrategyManager.IStrategyManager.GetTransformationStrategy"> + <summary> + Gets current transformation strategy + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.StrategyManager.ITransformationStrategy"> + <summary> + Defines interface for pixel transformation strategy + </summary> + </member> + <member name="M:SciChart.Charting.StrategyManager.ITransformationStrategy.Transform(System.Windows.Point)"> + <summary> + Peform transform of point according to current strategy + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.StrategyManager.ITransformationStrategy.ReverseTransform(System.Windows.Point)"> + <summary> + Perform reverse transform of point according to current strategy + </summary> + <param name="point"></param> + <returns></returns> + </member> + <member name="P:SciChart.Charting.StrategyManager.ITransformationStrategy.ViewportSize"> + <summary> + Current viewport size + </summary> + </member> + <member name="T:SciChart.Charting.ThemeAppliedEventArgs"> + <summary> + EventArgs used when the <see cref="E:SciChart.Charting.ThemeManager.ThemeApplied" /> event is raised + </summary> + <seealso cref="T:SciChart.Charting.ThemeManager" /> + <seealso cref="T:SciChart.Charting.Themes.IThemeProvider" /> + </member> + <member name="M:SciChart.Charting.ThemeAppliedEventArgs.#ctor(System.Windows.FrameworkElement,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ThemeAppliedEventArgs" /> class. + </summary> + <param name="control">The control which has the theme applied</param> + <param name="newTheme">The new theme string</param> + </member> + <member name="P:SciChart.Charting.ThemeAppliedEventArgs.Control"> + <summary> + Gets the control which has the theme applied + </summary> + </member> + <member name="P:SciChart.Charting.ThemeAppliedEventArgs.NewTheme"> + <summary> + Gets the new theme name + </summary> + </member> + <member name="T:SciChart.Charting.ThemeManager"> + <summary> + Provides automatic themeing of <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> via the Theme property. + <br /> + Allowable themes include: + <list type="bullet"><item><description>BlackSteel</description></item><item><description>BrightSpark</description></item><item><description>Chrome</description></item><item><description>Electric</description></item><item><description>ExpressionDark</description></item><item><description>ExpressionLight</description></item><item><description>Oscilloscope</description></item><item><description>SciChartv4Dark</description></item></list></summary> + <example> + <code title="ThemeManager Usage (XAML)" description="Demonstrates how to apply themes to elements within SciChart in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/scichart" --> + <s:SciChartSurface s:ThemeManager.Theme="BlackSteel"> + <!-- omitted for brevity --> + </s:SciChartSurface> + + <!-- and xmlns:s3D="http://schemas.abtsoftware.co.uk/scichart3D" --> + <s3D:SciChart3DSurface s:ThemeManager.Theme="Chrome"> + <!-- omitted for brevity --> + </s3D:SciChartSurface> + </code> + <code title="ThemeManager Usage (C#)" description="Demonstrates how to apply themes to elements within SciChart in Code" lang="cs"> + var sciChartSurface = new SciChartSurface(); + ThemeManager.SetTheme(sciChartSurface, "BlackSteel"); + </code> + </example> + <seealso cref="T:SciChart.Charting.Themes.IThemeProvider" /> + </member> + <member name="F:SciChart.Charting.ThemeManager.ThemeProperty"> + <summary> + Defines the Theme dependency property. + </summary> + </member> + <member name="M:SciChart.Charting.ThemeManager.GetTheme(System.Windows.DependencyObject)"> + <summary> + Gets the value of the Theme Attached Property. + </summary> + <param name="d">The dependency object.</param> + <returns>The current Theme.</returns> + </member> + <member name="M:SciChart.Charting.ThemeManager.SetTheme(System.Windows.DependencyObject,System.String)"> + <summary> + Sets the value of the Theme Attached property. For a list of All Themes, see the <see cref="P:SciChart.Charting.ThemeManager.AllThemes" /> property. + </summary> + <param name="d">The dependency object.</param> + <param name="value">The current theme.</param> + </member> + <member name="E:SciChart.Charting.ThemeManager.ThemeApplied"> + <summary> + Raised when a new theme has been applied to the SciChart application. + </summary> + </member> + <member name="P:SciChart.Charting.ThemeManager.AllThemes"> + <summary> + Gets a list of all available themes + </summary> + </member> + <member name="P:SciChart.Charting.ThemeManager.ThemeProvider"> + <summary> + Gets <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance + </summary> + </member> + <member name="M:SciChart.Charting.ThemeManager.AddTheme(System.String,System.Windows.ResourceDictionary)"> + <summary> + Add new theme and themeProvider into _theme and ThemeProviders respectively + </summary> + <param name="theme"></param> + <param name="dictionary"></param> + </member> + <member name="M:SciChart.Charting.ThemeManager.RemoveTheme(System.String)"> + <summary> + Add theme by string Key from _theme and appropriate themeProvider from ThemeProviders + </summary> + <param name="theme"></param> + </member> + <member name="M:SciChart.Charting.ThemeManager.GetThemeProvider(System.String)"> + <summary> + Gets a <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance for the named <paramref name="theme" /></summary> + <param name="theme">the named <paramref name="theme" /></param> + <returns>a <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance</returns> + </member> + <member name="T:SciChart.Charting.Themes.AxisCanvas"> + <summary> + The AxisCanvas provides an auto-sizing canvas for the axis labels + </summary> + <remarks> + Under MS-PL from http://themechanicalbride.blogspot.com/2008/11/auto-sizing-canvas-for-silverlight-and.html. + </remarks> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.ClipToBoundsProperty"> + <summary> + Identifies the SizeWidthToContent dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.SizeWidthToContentProperty"> + <summary> + Identifies the SizeWidthToContent dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.SizeHeightToContentProperty"> + <summary> + Identifies the SizeHeightToContent dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.LeftProperty"> + <summary> + Identifies the Left dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.RightProperty"> + <summary> + Identifies the Right dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.TopProperty"> + <summary> + Identifies the Top dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.BottomProperty"> + <summary> + Identifies the Bottom dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.CenterLeftProperty"> + <summary> + Identifies the CenterLeft dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.CenterRightProperty"> + <summary> + Identifies the CenterRight dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.CenterTopProperty"> + <summary> + Identifies the CenterTop dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.CenterBottomProperty"> + <summary> + Identifies the CenterBottom dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisCanvas.AllowCrossingEdgesProperty"> + <summary> + Identifies the AllowCrossingEdges dependency property. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetAllowCrossingEdges(System.Windows.UIElement)"> + <summary> + Gets the value of the AllowCrossingEdges attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The AllowCrossingEdges property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetAllowCrossingEdges(System.Windows.UIElement,System.Boolean)"> + <summary> + Sets the value of the AllowCrossingEdges attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed AllowCrossingEdges value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetLeft(System.Windows.UIElement)"> + <summary> + Gets the value of the Left attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Left property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetLeft(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Left attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Left value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetRight(System.Windows.UIElement)"> + <summary> + Gets the value of the Right attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Right property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetRight(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Right attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Right value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetTop(System.Windows.UIElement)"> + <summary> + Gets the value of the Top attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Top property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetTop(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Top attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Top value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetBottom(System.Windows.UIElement)"> + <summary> + Gets the value of the Bottom attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Bottom property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetBottom(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Bottom attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Bottom value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetCenterLeft(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterLeft attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterLeft property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetCenterLeft(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterLeft attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterLeft value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetCenterRight(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterRight attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterRight property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetCenterRight(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterRight attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterRight value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetCenterTop(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterTop attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterTop property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetCenterTop(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterTop attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterTop value.</param> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetCenterBottom(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterBottom attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterBottom property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SetCenterBottom(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterBottom attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterBottom value.</param> + </member> + <member name="P:SciChart.Charting.Themes.AxisCanvas.SizeWidthToContent"> + <summary> + Gets or sets a value indicating whether the dynamic canvas should + size its width to its content. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisCanvas.SizeHeightToContent"> + <summary> + Gets or sets a value indicating whether the canvas should size its + height to its content. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisCanvas.ClipToBounds"> + <summary> + Gets or sets the value which indicates whether to clip the content of this element. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetLayoutClip(System.Windows.Size)"> + <summary> + Returns a geometry for a clipping mask. The mask applies if the layout system attempts to arrange an element that is larger than the available display space. + </summary> + <param name="layoutSlotSize">The size of the part of the element that does visual presentation.</param> + <returns> + The clipping geometry. + </returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.MeasureOverride(System.Windows.Size)"> + <summary> + Measures all the children and returns their size. + </summary> + <param name="constraint">The available size.</param> + <returns>The desired size.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.ArrangeOverride(System.Windows.Size)"> + <summary> + Arranges all children in the correct position. + </summary> + <param name="arrangeSize">The size to arrange element's within. + </param> + <returns>The size that element's were arranged in.</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.GetArrangedRect(System.Windows.Size,System.Windows.UIElement)"> + <summary> + Get arranged rectangle of element + </summary> + <param name="arrangeSize">The size to arrange element within</param> + <param name="element">The element which need to be arranged</param> + <returns>Arranged Rect of element</returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.AdjustArrangedRectPosition(System.Windows.Rect,System.Windows.Size,System.Boolean)"> + <summary> + Adjust position of element before arranging + </summary> + <param name="arrangedRect">Rect of current element</param> + <param name="arrangeSize">The size to arrange element within</param> + <param name="allowCrossingEdges">Allow crossing panel edges</param> + <returns></returns> + </member> + <member name="P:SciChart.Charting.Themes.AxisCanvas.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisCanvas.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="T:SciChart.Charting.Themes.IAxisPanel"> + <summary> + Provides drawing capabilities for labels and ticks on an Axis within SciChart. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.IAxisPanel.ClearLabels"> + <summary> + Removes all the labels from an axis. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.IAxisPanel.Invalidate"> + <summary> + Forces the layout pass on this panel. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.IAxisPanel.DrawTicks(SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,System.Single)"> + <summary> + Draws ticks on an axis at the given coordinates. + </summary> + <param name="tickCoords"></param> + <param name="offset"></param> + </member> + <member name="M:SciChart.Charting.Themes.IAxisPanel.AddTickLabels(System.Action{SciChart.Charting.Themes.AxisCanvas})"> + <summary> + Draws labels on an axis using. + </summary> + <param name="addOnCanvas"></param> + </member> + <member name="T:SciChart.Charting.Themes.AxisPanel"> + <summary> + A panel providing a Bitmap and Labels Canvas for use on Axis within SciChart. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.DrawLabelsProperty"> + <summary> + The draw labels property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.DrawMinorTicksProperty"> + <summary> + The draw minor ticks property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.DrawMajorTicksProperty"> + <summary> + The draw major ticks property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.MajorTickLineStyleProperty"> + <summary> + The major tick line style property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.MinorTickLineStyleProperty"> + <summary> + The minor tick line style property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.AxisAlignmentProperty"> + <summary> + The axis alignment property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.AxisLabelToTickIndentProperty"> + <summary> + The AxisLabelToTickIndent property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.AxisPanel.IsLabelCullingEnabledProperty"> + <summary> + The IsLabelCullingEnabled DependencyProperty. + </summary> + </member> + <member name="E:SciChart.Charting.Themes.AxisPanel.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.IsLabelCullingEnabled"> + <summary> + Gets or sets a value indicating whether Label Culling is enabled (when labels overlap) on this AxisPanel instance. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.AxisAlignment"> + <summary> + Gets or sets the axis alignment. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.MajorTickLineStyle"> + <summary> + Gets or sets the major tick line style. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.MinorTickLineStyle"> + <summary> + Gets or sets the minor tick line style. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.DrawMajorTicks"> + <summary> + Gets or sets a value indicating whether this panel draws Major ticks. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.DrawMinorTicks"> + <summary> + Gets or sets a value indicating whether this panel draws Minor ticks. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.DrawLabels"> + <summary> + Gets or sets a value indicating whether this panel draws labels. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.IsHorizontalAxis"> + <summary> + Gets a value indicating whether this pabel is horizontal axis. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.LabelToTickIndent"> + <summary> + Gets the label to tick indent. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.MajorTickSize"> + <summary> + Gets the size of a major tick. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.MinorTickSize"> + <summary> + Gets the size of a minor tick. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.AxisPanel.AddLabels"> + <summary> + Used internally. Specifies a method which is used to fill the panel with tick labels. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.MeasureOverride(System.Windows.Size)"> + <summary> + Performs the measure pass on AxisPanel. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.ArrangeOverride(System.Windows.Size)"> + <summary> + Performs the arrange pass on AxisPanel. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.AddTickLabels(System.Action{SciChart.Charting.Themes.AxisCanvas})"> + <summary> + Draws the tick labels. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.DrawTicks(SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,System.Single)"> + <summary> + Draws ticks on axis. + </summary> + <param name="tickCoords"></param> + <param name="offset"></param> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.GetRenderContextSize"> + <summary> + Gets size of image for ticks drawing. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.DrawTicks(SciChart.Drawing.Common.IRenderContext2D,System.Windows.Style,System.Double,System.Single[],System.Single)"> + <summary> + Draws ticks on axis bitmap. + </summary> + <param name="renderContext"></param> + <param name="tickStyle"></param> + <param name="tickSize"></param> + <param name="tickCoords"></param> + <param name="offset"></param> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.ClearLabels"> + <summary> + Clears the <see cref="T:SciChart.Charting.Themes.AxisPanel" />. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.AxisPanel.OnPropertyChanged(System.String)"> + <summary> + <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation. + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="T:SciChart.Charting.Themes.ModifierAxisCanvas"> + <summary> + A canvas which overlays an axis and is used to place annotations, such as cursor labels and <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /></summary> + </member> + <member name="M:SciChart.Charting.Themes.ModifierAxisCanvas.AdjustArrangedRectPosition(System.Windows.Rect,System.Windows.Size,System.Boolean)"> + <summary> + Adjust position of element before arranging + </summary> + <param name="arrangedRect">Rect of current element</param> + <param name="arrangeSize">The size to arrange element within</param> + <param name="allowCrossingEdges">Allow crossing panel edges</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Themes.ModifierPopupCanvas"> + <summary> + A canvas which changes its size based on the internal children elements + </summary> + </member> + <member name="M:SciChart.Charting.Themes.ModifierPopupCanvas.#ctor"> + <summary> + Creates instance of <see cref="T:SciChart.Charting.Themes.ModifierPopupCanvas" /></summary> + </member> + <member name="M:SciChart.Charting.Themes.ModifierPopupCanvas.MeasureOverride(System.Windows.Size)"> + <summary> + Measures all the children and returns their size. + </summary> + <param name="constraint">The available size.</param> + <returns>The desired size.</returns> + </member> + <member name="T:SciChart.Charting.Themes.PolarAxisPanel"> + <summary> + A panel providing a Bitmap and Labels Canvas for use on <see cref="T:SciChart.Charting.Visuals.Axes.PolarXAxis" /> within SciChart + </summary> + </member> + <member name="M:SciChart.Charting.Themes.PolarAxisPanel.DrawTicks(SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,System.Single)"> + <summary> + Draws ticks on axis + </summary> + <param name="tickCoords"></param> + <param name="offset"></param> + </member> + <member name="M:SciChart.Charting.Themes.PolarAxisPanel.DrawTicks(SciChart.Drawing.Common.IRenderContext2D,System.Windows.Style,System.Double,System.Single[],System.Single)"> + <summary> + Draws ticks on axis bitmap + </summary> + <param name="renderContext"></param> + <param name="tickStyle"></param> + <param name="tickSize"></param> + <param name="tickCoords"></param> + <param name="offset"></param> + </member> + <member name="M:SciChart.Charting.Themes.PolarAxisPanel.GetRenderContextSize"> + <summary> + Gets size of image for ticks drawing + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Themes.PolarPanel"> + <summary> + The PolarPanel provides the panel which arranges items from center of panel to outer bounds + </summary> + </member> + <member name="F:SciChart.Charting.Themes.PolarPanel.StretchToSizeProperty"> + <summary> + Defines the StretchToSize DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Themes.PolarPanel.IsReversedOrderProperty"> + <summary> + Defines the IsReversedOrder DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Themes.PolarPanel.MinimimalItemSizeProperty"> + <summary> + Defines the MinimalItemSize DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Themes.PolarPanel.ShouldCopyThicknessToParentProperty"> + <summary> + Defines the ShouldCopyThicknessToParent AttachedProperty + </summary> + </member> + <member name="F:SciChart.Charting.Themes.PolarPanel.ThicknessProperty"> + <summary> + Defines the Thicknes AttachedProperty + </summary> + </member> + <member name="M:SciChart.Charting.Themes.PolarPanel.#ctor"> + <summary> + Initializes a new instance of <see cref="T:SciChart.Charting.Themes.PolarPanel" /> class + </summary> + </member> + <member name="P:SciChart.Charting.Themes.PolarPanel.StretchToSize"> + <summary> + Gets or sets whether panel should stretch children to its size or not + </summary> + </member> + <member name="P:SciChart.Charting.Themes.PolarPanel.IsReversedOrder"> + <summary> + Gets or sets whether panel should arrange child elements in reverse order + </summary> + </member> + <member name="P:SciChart.Charting.Themes.PolarPanel.MinimimalItemSize"> + <summary> + Gets or sets minimal child size of panel + </summary> + </member> + <member name="M:SciChart.Charting.Themes.PolarPanel.SetThickness(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Thickness attached property for a specified UIElement. + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.Themes.PolarPanel.GetThickness(System.Windows.UIElement)"> + <summary> + Gets the value of the Thickness attached property for a specified UIElement. + </summary> + <param name="element"></param> + </member> + <member name="M:SciChart.Charting.Themes.PolarPanel.SetShouldCopyThicknessToParent(System.Windows.UIElement,System.Boolean)"> + <summary> + Sets the value of the ShouldCopyThicknessToParent attached property for a specified UIElement. + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.Themes.PolarPanel.GetShouldCopyThicknessToParent(System.Windows.UIElement)"> + <summary> + Gets the value of the ShouldCopyThicknessToParent attached property for a specified UIElement. + </summary> + <param name="element"></param> + </member> + <member name="T:SciChart.Charting.Themes.RadarAxisPanel"> + <summary> + The RadarAxisPanel represents a UI container which arranges its children by a specific angle. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadarAxisPanel.AxisAngleOffsetProperty"> + <summary> + Defines the AxisAngleOffset DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadarAxisPanel.CentralAxisOffsetProperty"> + <summary> + Defines the CentralAxisOffset DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadarAxisPanel.AutoAxisAngleProperty"> + <summary> + Defines the AutoAxisAngle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadarAxisPanel.AutoAxisLengthProperty"> + <summary> + Defines the AutoAxisLength DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.RadarAxisPanel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Themes.RadarAxisPanel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.RadarAxisPanel.AutoAxisLength"> + <summary> + Gets or sets whether to calculate lengths of child axes automatically or to use preset ones. + See <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisLength" />. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.RadarAxisPanel.AutoAxisAngle"> + <summary> + Gets or sets whether to calculate angles for child axes automatically or to use preset ones. + See <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" />. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.RadarAxisPanel.CentralAxisOffset"> + <summary> + Gets or sets a value which defines the radius of the empty space inside a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.RadarAxisPanel.AxisAngleOffset"> + <summary> + Gets or sets the starting angle for axes. See <see cref="P:SciChart.Charting.Themes.RadarAxisPanel.AutoAxisAngle" />, <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" />. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.RadarAxisPanel.MeasureOverride(System.Windows.Size)"> + <summary> + When overridden in a derived class, measures the size in layout required for child elements and determines a size for the <see cref="T:System.Windows.FrameworkElement" />-derived class. + </summary> + <returns> + The size that this element determines it needs during layout, based on its calculations of child element sizes. + </returns> + <param name="availableSize">The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available.</param> + </member> + <member name="M:SciChart.Charting.Themes.RadarAxisPanel.ArrangeOverride(System.Windows.Size)"> + <summary> + When overridden in a derived class, positions child elements and determines a size for a <see cref="T:System.Windows.FrameworkElement" /> derived class. + </summary> + <returns> + The actual size used. + </returns> + <param name="finalSize">The final area within the parent that this element should use to arrange itself and its children.</param> + </member> + <member name="T:SciChart.Charting.Themes.RadialPanel"> + <summary> + The RadialPanel provdes panel which rotates its children with specified angle relative to center of panel + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadialPanel.AngleProperty"> + <summary> + Defines the Angle AttachedProperty + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadialPanel.IsHorizontalProperty"> + <summary> + Defines the IsHorizontal AttachedProperty + </summary> + </member> + <member name="F:SciChart.Charting.Themes.RadialPanel.OriginPointProperty"> + <summary> + Defines the OriginPoint AttachedProperty + </summary> + </member> + <member name="M:SciChart.Charting.Themes.RadialPanel.GetAngle(System.Windows.UIElement)"> + <summary> + Gets the value of the Angle attached property for a specified UIElement. + </summary> + <param name="element"></param> + </member> + <member name="M:SciChart.Charting.Themes.RadialPanel.SetAngle(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Angle attached property for a specified UIElement. + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.Themes.RadialPanel.SetOriginPoint(System.Windows.UIElement,System.Windows.Point)"> + <summary> + Sets the value of the OriginPoint attached property for a specified UIElement. + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.Themes.RadialPanel.GetOriginPoint(System.Windows.UIElement)"> + <summary> + Gets the value of the OriginPoint attached property for a specified UIElement. + </summary> + <param name="element"></param> + </member> + <member name="M:SciChart.Charting.Themes.RadialPanel.SetIsHorizontal(System.Windows.UIElement,System.Boolean)"> + <summary> + Sets the value of the IsHorizontal attached property for a specified UIElement. + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.Themes.RadialPanel.GetIsHorizontal(System.Windows.UIElement)"> + <summary> + Gets the value of the IsHorizontal attached property for a specified UIElement. + </summary> + <param name="element"></param> + </member> + <member name="T:SciChart.Charting.Themes.TabControlCompatible"> + <summary> + A cross-platform implementation of <see cref="T:System.Windows.Controls.TabControl" />, used in the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup" /> control in WPF and Silverlight editions + </summary> + </member> + <member name="T:SciChart.Charting.Themes.TernaryAxisCanvas"> + <summary> + The TernaryAxisCanvas provides an auto-sizing canvas for the ternary axis info + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.AxisAlignmentProperty"> + <summary> + The axis alignment property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.SizeWidthToContentProperty"> + <summary> + Identifies the SizeWidthToContent dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.SizeHeightToContentProperty"> + <summary> + Identifies the SizeHeightToContent dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.LeftProperty"> + <summary> + Identifies the Left dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.RightProperty"> + <summary> + Identifies the Right dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.TopProperty"> + <summary> + Identifies the Top dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.BottomProperty"> + <summary> + Identifies the Bottom dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.CenterLeftProperty"> + <summary> + Identifies the CenterLeft dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.CenterRightProperty"> + <summary> + Identifies the CenterRight dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.CenterTopProperty"> + <summary> + Identifies the CenterTop dependency property. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisCanvas.CenterBottomProperty"> + <summary> + Identifies the CenterBottom dependency property. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisCanvas.AxisAlignment"> + <summary> + Gets or sets the axis alignment. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetLeft(System.Windows.UIElement)"> + <summary> + Gets the value of the Left attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Left property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetLeft(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Left attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Left value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetRight(System.Windows.UIElement)"> + <summary> + Gets the value of the Right attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Right property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetRight(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Right attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Right value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetTop(System.Windows.UIElement)"> + <summary> + Gets the value of the Top attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Top property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetTop(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Top attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Top value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetBottom(System.Windows.UIElement)"> + <summary> + Gets the value of the Bottom attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The Bottom property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetBottom(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the Bottom attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed Bottom value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetCenterLeft(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterLeft attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterLeft property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetCenterLeft(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterLeft attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterLeft value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetCenterRight(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterRight attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterRight property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetCenterRight(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterRight attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterRight value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetCenterTop(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterTop attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterTop property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetCenterTop(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterTop attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterTop value.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.GetCenterBottom(System.Windows.UIElement)"> + <summary> + Gets the value of the CenterBottom attached property for a specified UIElement. + </summary> + <param name="element">The UIElement from which the property value is read.</param> + <returns>The CenterBottom property value for the UIElement.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.SetCenterBottom(System.Windows.UIElement,System.Double)"> + <summary> + Sets the value of the CenterBottom attached property to a specified UIElement. + </summary> + <param name="element">The UIElement to which the attached property is written.</param> + <param name="value">The needed CenterBottom value.</param> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisCanvas.SizeWidthToContent"> + <summary> + Gets or sets a value indicating whether the dynamic canvas should + size its width to its content. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisCanvas.SizeHeightToContent"> + <summary> + Gets or sets a value indicating whether the canvas should size its + height to its content. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisCanvas.ChildRotationAngle"> + <summary> + Gets or sets child rotation angle + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisCanvas.ChildTransformOrigin"> + <summary> + Gets or sets child transform origin + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.MeasureOverride(System.Windows.Size)"> + <summary> + Measures all the children and returns their size. + </summary> + <param name="availableSize">The available size.</param> + <returns>The desired size.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisCanvas.ArrangeOverride(System.Windows.Size)"> + <summary> + Arranges all children in the correct position. + </summary> + <param name="finalSize">The size to arrange element's within. + </param> + <returns>The size that element's were arranged in.</returns> + </member> + <member name="T:SciChart.Charting.Themes.TernaryAxisContainer"> + <summary> + A panel containing ternary axis. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisContainer.TernaryAxis"> + <summary> + Gets ternary axis inside a cointainer + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisContainer.MeasureOverride(System.Windows.Size)"> + <summary> + Performs the measure pass on TeranryAxisPanelContainer. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisContainer.ArrangeOverride(System.Windows.Size)"> + <summary> + Performs the arrange pass on TernaryAxisPanelContainer. + </summary> + </member> + <member name="T:SciChart.Charting.Themes.ITernaryAxisPanel"> + <summary> + Provides drawing capabilities for labels and ticks on a TernaryAxis within SciChart. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.ITernaryAxisPanel.AddTickLabels(System.Action{SciChart.Charting.Themes.TernaryAxisCanvas})"> + <summary> + Draws label ticks on an axis using. + </summary> + <param name="addOnCanvas"></param> + </member> + <member name="T:SciChart.Charting.Themes.TernaryAxisPanel"> + <summary> + A panel providing a Line, axis title and Label Ticks Canvas for use on TernaryAxis within SciChart. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryAxisPanel.TernaryAxisAlignmentProperty"> + <summary> + The axis alignment property. + </summary> + </member> + <member name="E:SciChart.Charting.Themes.TernaryAxisPanel.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisPanel.AxisAlignment"> + <summary> + Gets or sets the axis alignment. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisPanel.AxisLineLength"> + <summary> + Gets axis line lenght before putting label ticks on axis + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryAxisPanel.AddLabelTicks"> + <summary> + Used internally. Specifies a method which is used to fill the panel with label ticks. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisPanel.AddTickLabels(System.Action{SciChart.Charting.Themes.TernaryAxisCanvas})"> + <summary> + Draws the label ticks + </summary> + <param name="addOnCanvas"></param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisPanel.OnPropertyChanged(System.String)"> + <summary> + <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation. + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisPanel.MeasureOverride(System.Windows.Size)"> + <summary> + Performs the measure pass on TernaryAxisPanel. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryAxisPanel.ArrangeOverride(System.Windows.Size)"> + <summary> + Performs the arrange pass on TernaryAxisPanel. + </summary> + </member> + <member name="T:SciChart.Charting.Themes.TernaryChartContainer"> + <summary> + A panel containing all three ternary axes + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TernaryChartContainer.IsEquilateralProperty"> + <summary> + Defines the IsEquilateral DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TernaryChartContainer.IsEquilateral"> + <summary> + Gets or sets property that defines triangle is equilateral or can sides ca be resized + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryChartContainer.MeasureOverride(System.Windows.Size)"> + <summary> + Performs the measure pass on TeranryAxisPanelContainer. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TernaryChartContainer.ArrangeOverride(System.Windows.Size)"> + <summary> + Performs the arrange pass on TernaryAxisPanelContainer. + </summary> + </member> + <member name="T:SciChart.Charting.Themes.TernaryModifierAxisCanvas"> + <summary> + A canvas which overlays an axis and is used to place annotations, such as cursor labels and <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /></summary> + </member> + <member name="T:SciChart.Charting.Themes.TernaryTickLabelAxisCanvas"> + <summary> + A canvas which overlays an axis and is used to place Label Ticks + </summary> + </member> + <member name="T:SciChart.Charting.Themes.IThemeProvider"> + <summary> + Defines the interface to a SciChart Theme, which provides Brushes and Colors for the XAML control templates. + You may implement IThemeProvider yourself and pass to ThemeManager to set the global theme for all <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + controls. + </summary> + <seealso cref="T:SciChart.Charting.ThemeManager" /> + <seealso cref="T:SciChart.Charting.Themes.ThemeColorProvider" /> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.GridBorderBrush"> + <summary> + Gets or sets the brush used for Gridlines area border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.GridBackgroundBrush"> + <summary> + Gets or sets the background of the Gridlines area + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.SciChartBackground"> + <summary> + Gets or sets the background of the entire <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.TickTextBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> tick labels + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.MajorGridLinesBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> Major Grid lines. Expects a <see cref="T:System.Windows.Media.SolidColorBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.MinorGridLinesBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> Minor Grid lines. Expects a <see cref="T:System.Windows.Media.SolidColorBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.RolloverLineStroke"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> vertical line + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.RolloverLabelBorderBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> label border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.RolloverLabelBackgroundBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> label background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultCandleUpWickColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeUp" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultCandleDownWickColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeDown" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultCandleUpBodyBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillUp" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultCandleDownBodyBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillDown" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultColumnOutlineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />, which is used + to style the column outline. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultColumnFillBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.Fill" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultLineSeriesColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />. + which is used to define the line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultMountainLineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />. + which defines the mountain line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultDownBandFillColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.Fill" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultUpBandFillColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.FillY1" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultUpBandLineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeY1" />, + which defines the up band line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultDownBandLineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />, + which defines the down band line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultMountainAreaBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries.Fill" />. + Accepts <seealso cref="T:System.Windows.Media.SolidColorBrush" /> and <seealso cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultColorMapBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.ColorMap" />. + Accepts <seealso cref="T:System.Windows.Media.LinearGradientBrush" />. Gradient Stops are used to compute colors of the final heat signature + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.CursorLabelForeground"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> label text foreground + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.CursorLabelBackgroundBrush"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> label background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.CursorLabelBorderBrush"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> label border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.RubberBandFillBrush"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier" /> drag reticule fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.RubberBandStrokeBrush"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier" /> drag reticule border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.CursorLineBrush"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> line stroke + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.OverviewFillBrush"> + <summary> + Gets or sets the brush (fill) for the <seealso cref="T:SciChart.Charting.Visuals.SciChartOverview" /> non-selected area + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.ScrollbarViewportBackgroundBrush"> + <summary> + Gets or sets the brush (fill) for the <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport area + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.ScrollbarBackgroundBrush"> + <summary> + Gets or sets default brush for background of the scrollbar + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.ScrollbarBorderBrush"> + <summary> + Gets or sets default brush for border of the scrollbar + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.ScrollbarGripsBackgroundBrush"> + <summary> + Gets or sets default brush for backgrounds of the scrollbar grips + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.ScrollbarViewportBorderBrush"> + <summary> + Gets or sets the brush (fill) for the <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport area border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.LegendBackgroundBrush"> + <summary> + Gets or sets the brush for the <seealso cref="T:SciChart.Charting.Visuals.SciChartLegend" /> background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultTextAnnotationBackground"> + <summary> + Gets or sets the default brush for the <seealso cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /> background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultTextAnnotationForeground"> + <summary> + Gets or sets the default brush for the <seealso cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /> text foreground + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultAnnotationsGripsBorderBrush"> + <summary> + Gets or sets default brush for border of the annotations grips + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultAnnotationsGripsBackroundBrush"> + <summary> + Gets or sets default brush for backgrounds of the annotations grips + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultAxisMarkerAnnotationBackground"> + <summary> + Gets or sets the default brush for the <seealso cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.DefaultAxisMarkerAnnotationForeground"> + <summary> + Gets or sets the default brush for the <seealso cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> text-foreground + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.AxisBandsFill"> + <summary> + Gets or sets the color for the <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> axis bands fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.Axis3DBandsFill"> + <summary> + Gets or sets the color for the 3D Chart Axis plane bands fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.AxisPlaneBackgroundFill"> + <summary> + Gets or sets the color for the 3D Chart Axis plane background fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.ShadowEffectColor"> + <summary> + Gets or sets the color for the <see cref="T:System.Windows.Media.Effects.DropShadowEffect" /> for the Tooltips. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.IThemeProvider.PlaneBorderColor"> + <summary> + Gets or sets a color of the 3D Chart Axis plane border. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.IThemeProvider.ApplyTheme(SciChart.Charting.Themes.IThemeProvider)"> + <summary> + Applies a <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance to this instance, by overwriting all properties and raising + <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> where necessary + </summary> + <param name="newTheme">The new theme instance</param> + </member> + <member name="M:SciChart.Charting.Themes.IThemeProvider.ApplyTheme(System.Windows.ResourceDictionary)"> + <summary> + Applies a <see cref="T:System.Windows.ResourceDictionary" /> to this <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance, by searching for the resources + with the same keys (Names) as the property names in the <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance + </summary> + <param name="dictionary">The <seealso cref="T:System.Windows.ResourceDictionary" /> source</param> + </member> + <member name="T:SciChart.Charting.Themes.ThemeColorProvider"> + <summary> + Defines a SciChart Theme color provider, which provides Brushes and Colors for the XAML control templates. + You may implement IThemeProvider yourself and pass to ThemeManager to set the global theme for all <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + controls. + </summary> + <seealso cref="T:SciChart.Charting.ThemeManager" /> + <seealso cref="T:SciChart.Charting.Themes.ThemeColorProvider" /> + <seealso cref="T:SciChart.Charting.Themes.IThemeProvider" /> + </member> + <member name="M:SciChart.Charting.Themes.ThemeColorProvider.ApplyTheme(SciChart.Charting.Themes.IThemeProvider)"> + <summary> + Applies a <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance to this instance, by overwriting all properties and raising + <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> where necessary + </summary> + <param name="newTheme">The new theme instance</param> + </member> + <member name="M:SciChart.Charting.Themes.ThemeColorProvider.ApplyTheme(System.Windows.ResourceDictionary)"> + <summary> + Applies a <see cref="T:System.Windows.ResourceDictionary" /> to this <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance, by searching for the resources + with the same keys (Names) as the property names in the <see cref="T:SciChart.Charting.Themes.IThemeProvider" /> instance + </summary> + <param name="dictionary">The <see cref="T:System.Windows.ResourceDictionary" /> source</param> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.GridBorderBrush"> + <summary> + Gets or sets the brush used for Gridlines area border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.GridBackgroundBrush"> + <summary> + Gets or sets the background of the Gridlines area + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.SciChartBackground"> + <summary> + Gets or sets the background of the entire <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.TickTextBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> tick labels + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.MajorGridLinesBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> Major Grid lines. Expects a <see cref="T:System.Windows.Media.SolidColorBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.MinorGridLinesBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> Minor Grid lines. Expects a <see cref="T:System.Windows.Media.SolidColorBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.RolloverLineStroke"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> vertical line + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.RolloverLabelBorderBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> label border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.RolloverLabelBackgroundBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> label background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultCandleUpWickColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeUp" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultCandleDownWickColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeDown" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultCandleUpBodyBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillUp" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultCandleDownBodyBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillDown" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultColumnOutlineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />, which is used + to style the column outline. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultColumnFillBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.Fill" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultLineSeriesColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />. + which is used to define the line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultMountainLineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />. + which defines the mountain line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultMountainAreaBrush"> + <summary> + Gets or sets the default brush for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries.Fill" />. + Accepts <see cref="T:System.Windows.Media.SolidColorBrush" /> and <see cref="T:System.Windows.Media.LinearGradientBrush" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultColorMapBrush"> + <summary> + Gets or sets the default brush for the + <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.ColorMap" />. + Accepts + <seealso cref="T:System.Windows.Media.LinearGradientBrush" />. Gradient Stops are used to compute colors of the final heat signature + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultDownBandFillColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.Fill" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultUpBandFillColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.FillY1" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultUpBandLineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />, + which defines the up band line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultDownBandLineColor"> + <summary> + Gets or sets the default color for the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeY1" />, + which defines the down band line color + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.CursorLabelForeground"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> label text foreground + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.CursorLabelBackgroundBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> label background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.CursorLabelBorderBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> label border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.RubberBandFillBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier" /> drag reticule fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.RubberBandStrokeBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.RubberBandXyZoomModifier" /> drag reticule border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.CursorLineBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> line stroke + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.OverviewFillBrush"> + <summary> + Gets or sets the brush (fill) for the <see cref="T:SciChart.Charting.Visuals.SciChartOverview" /> non-selected area + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.ScrollbarViewportBackgroundBrush"> + <summary> + Gets or sets the brush (fill) for the <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport area + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.ScrollbarBackgroundBrush"> + <summary> + Gets or sets the background brush (fill) for the <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /></summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.ScrollbarGripsBackgroundBrush"> + <summary> + Gets or sets default brush for backgrounds of the scrollbar grips + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.ScrollbarViewportBorderBrush"> + <summary> + Gets or sets the brush (fill) for the <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport area border + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.ScrollbarBorderBrush"> + <summary> + Gets or sets default brush for border of the scrollbar + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.LegendBackgroundBrush"> + <summary> + Gets or sets the brush for the <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultTextAnnotationBackground"> + <summary> + Gets or sets the default brush for the <see cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /> background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultTextAnnotationForeground"> + <summary> + Gets or sets the default brush for the <see cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /> text foreground + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultAnnotationsGripsBorderBrush"> + <summary> + Gets or sets default brush for border of the annotations grips + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultAnnotationsGripsBackroundBrush"> + <summary> + Gets or sets default brush for backgrounds of the annotations grips + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultAxisMarkerAnnotationBackground"> + <summary> + Gets or sets the default brush for the <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> background + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.DefaultAxisMarkerAnnotationForeground"> + <summary> + Gets or sets the default brush for the <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> text-foreground + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.AxisBandsFill"> + <summary> + Gets or sets the color for the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> axis bands fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.Axis3DBandsFill"> + <summary> + Gets or sets the color for the 3D Chart Axis plane bands fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.AxisPlaneBackgroundFill"> + <summary> + Gets or sets the color for the 3D Chart Axis plane background fill + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.ShadowEffectColor"> + <summary> + Gets or sets the color for the <see cref="T:System.Windows.Media.Effects.DropShadowEffect" /> for the Tooltips. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.ThemeColorProvider.PlaneBorderColor"> + <summary> + Gets or sets a color of the 3D Chart Axis plane border. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.ThemeColorProvider.SetValue``1(``0@,``0,System.String)"> + <summary> + This method is used to set property value and raise PropertyChanged event handler + </summary> + </member> + <member name="T:SciChart.Charting.Themes.ThemeEffectsHelper"> + <summary> + Defines theme-based shadow effects for XAML control templates. + </summary> + <remarks> + All shadow effects are cloned and frozen to support multiple UI threads. + </remarks> + </member> + <member name="P:SciChart.Charting.Themes.ThemeEffectsHelper.Instance"> + <summary> + Gets the current instance of the <see cref="T:SciChart.Charting.Themes.ThemeEffectsHelper" /></summary> + </member> + <member name="M:SciChart.Charting.Themes.ThemeEffectsHelper.CreateShadowEffects(System.Windows.Media.Color)"> + <summary> + Creates theme-based shadow effects for this instance based on the current <see cref="T:SciChart.Charting.Themes.IThemeProvider" /></summary> + <param name="themeShadowColor">The color for the <see cref="T:System.Windows.Media.Effects.DropShadowEffect" /> on the tooltips</param> + </member> + <member name="P:SciChart.Charting.Themes.ThemeEffectsHelper.TooltipShadowEffect"> + <summary> + Gets or sets the shadow effect for the modifier tooltips. + </summary> + </member> + <member name="T:SciChart.Charting.Themes.TickLabelAxisCanvas"> + <summary> + A canvas which overlays an axis and is used to place Tick Labels + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TickLabelAxisCanvas.IsLabelCullingEnabledProperty"> + <summary> + Defines the IsLabelCullingEnabled DependendencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Themes.TickLabelAxisCanvas.AutoFitMarginalLabelsProperty"> + <summary> + Defines the AutoFitMarginalLabels DependencyProperty. + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TickLabelAxisCanvas.IsLabelCullingEnabled"> + <summary> + Gets or sets whether Label Culling is enabled on this Axis Canvas + </summary> + </member> + <member name="P:SciChart.Charting.Themes.TickLabelAxisCanvas.AutoFitMarginalLabels"> + <summary> + Gets or sets a value indicating whether marginal labels get shifted to fit inside an axis when too long. + </summary> + </member> + <member name="M:SciChart.Charting.Themes.TickLabelAxisCanvas.MeasureOverride(System.Windows.Size)"> + <summary> + Measures all the children and returns their size. + </summary> + <param name="constraint">The available size.</param> + <returns>The desired size.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TickLabelAxisCanvas.ArrangeOverride(System.Windows.Size)"> + <summary> + Arranges all children in the correct position. + </summary> + <param name="arrangeSize">The size to arrange element's within. + </param> + <returns>The size that element's were arranged in.</returns> + </member> + <member name="M:SciChart.Charting.Themes.TickLabelAxisCanvas.AdjustArrangedRectPosition(System.Windows.Rect,System.Windows.Size,System.Boolean)"> + <summary> + Adjust position of element before arranging + </summary> + <param name="arrangedRect">Rect of current element</param> + <param name="arrangeSize">The size to arrange element within</param> + <param name="allowCrossingEdges">Allow crossing panel edges</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Utility.InvalidateSciChartMessage"> + <summary> + When published, causes the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to queue up an asynchronous redraw + </summary> + </member> + <member name="M:SciChart.Charting.Utility.InvalidateSciChartMessage.#ctor(System.Object)"> + <summary> + Initializes a new instance of the MessageBase class. + </summary> + <param name="sender">Message sender (usually "this")</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Utility.ZoomExtentsMessage"> + <summary> + When published, causes the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to zoom to extents and redraw + </summary> + </member> + <member name="P:SciChart.Charting.Utility.ZoomExtentsMessage.ZoomYOnly"> + <summary> + If set to <c>true</c> zooms in the Y-direction only. + </summary> + </member> + <member name="M:SciChart.Charting.Utility.ZoomExtentsMessage.#ctor(System.Object)"> + <summary> + Initializes a new instance of the MessageBase class. + </summary> + <param name="sender">Message sender (usually "this")</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Utility.ZoomExtentsMessage.#ctor(System.Object,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Utility.ZoomExtentsMessage" /> class. + </summary> + <param name="sender">The sender.</param> + <param name="zoomYOnly">if set to <c>true</c> zooms in the Y-direction only.</param> + </member> + <member name="T:SciChart.Charting.Utility.SciChartResizedMessage"> + <summary> + Published by <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> after the chart surface resizes + </summary> + </member> + <member name="M:SciChart.Charting.Utility.SciChartResizedMessage.#ctor(System.Object)"> + <summary> + Initializes a new instance of the MessageBase class. + </summary> + <param name="sender">Message sender (usually "this")</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Utility.SciChartRenderedMessage"> + <summary> + Published by <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> immediately before the end of a render pass + </summary> + </member> + <member name="M:SciChart.Charting.Utility.SciChartRenderedMessage.#ctor(System.Object,SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Utility.SciChartRenderedMessage" /> class. + </summary> + <param name="sender">The sender.</param> + <param name="renderContext">The render context.</param> + </member> + <member name="P:SciChart.Charting.Utility.SciChartRenderedMessage.BitmapContext"> + <summary> + OBSOLETE + </summary> + </member> + <member name="P:SciChart.Charting.Utility.SciChartRenderedMessage.RenderContext"> + <summary> + Gets the RenderContext + </summary> + </member> + <member name="T:SciChart.Charting.ViewportManagers.DefaultViewportManager"> + <summary> + The DefaultViewportManager performs a naive calculation for X and Y Axis VisibleRange. + On each render of the parent SciChartSurface, either autorange to fit the data (depending on the Axis.AutoRange property value), + or return the original axis range (no change) + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.DefaultViewportManager.OnVisibleRangeChanged(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> changes for an axis. Override in derived types to get a notification of this occurring + </summary> + <param name="axis">The <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.DefaultViewportManager.OnParentSurfaceRendered(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> is rendered. + </summary> + <param name="sciChartSurface">The SciChartSurface instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.DefaultViewportManager.OnCalculateNewXRange(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> requests the XAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="xAxis">The XAxis</param> + <returns> + The new VisibleRange for the XAxis + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.DefaultViewportManager.OnCalculateNewYRange(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> requests a YAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="yAxis">The YAxis</param> + <param name="renderPassInfo"></param> + <returns> + The new VisibleRange for the YAxis + </returns> + </member> + <member name="T:SciChart.Charting.ViewportManagers.IViewportManager"> + <summary> + Defines the interface to a ViewportManager, which may be used to intercept the X,Y axis ranging during render and invalidate the parent surface + </summary> + </member> + <member name="P:SciChart.Charting.ViewportManagers.IViewportManager.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.ViewportManagers.IViewportManager.IsAttached"> + <summary> + Returns <value>True</value> when a <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> has the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> attached to. + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.OnVisibleRangeChanged(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> changes for an axis. Override in derived types to get a notification of this occurring + </summary> + <param name="axis">The <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.CalculateNewYAxisRange(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Called by the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> during render to calculate the new YAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="yAxis">The YAxis to calculate for</param> + <param name="renderPassInfo">The current <see cref="T:SciChart.Charting.Services.RenderPassInfo" /> containing render data</param> + <returns>The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis</returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.CalculateNewXAxisRange(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called by the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> during render to calculate the new XAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="xAxis">The XAxis to calculate for</param> + <returns>The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis</returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.CalculateAutoRange(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called by the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> during render to perform autoranging. Override in derived types to return a custom value + </summary> + <param name="axis">The axis to calculate for</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.OnParentSurfaceRendered(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> is rendered. + </summary> + <param name="sciChartSurface">The SciChartSurface instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode)"> + <summary> + May be called to trigger a redraw on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. See tne <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> for available options. + </summary> + <param name="rangeMode">Tne <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> with options for the re-draw</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.AttachSciChartSurface(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is attached to a <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" />. May be overridden to get notification of attachment. + </summary> + <param name="scs">The <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.DetachSciChartSurface"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is detached from a <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" />. May be overridden to get notification of detachment. + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.IViewportManager.BeginInvoke(System.Action,SciChart.Core.Framework.DispatchPriority)"> + <summary> + Asynchronously invokes the <paramref name="action" /> on the UI Thread + </summary> + <param name="action">The action.</param> + <param name="dispatcherPriority">The dispatcher priority.</param> + </member> + <member name="T:SciChart.Charting.ViewportManagers.ViewportManagerBase"> + <summary> + Defines a base class for a ViewportManager, which may be used to control visible range and ranging on a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ViewportManagers.ViewportManagerBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.ViewportManagers.ViewportManagerBase.IsAttached"> + <summary> + Gets the value indicating whether a <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> has the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> attached to. + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.AttachSciChartSurface(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="scs">The SciChartSurface instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.DetachSciChartSurface"> + <summary> + Called when the <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> is detached from a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.ViewportManagers.ViewportManagerBase.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.BeginInvoke(System.Action,SciChart.Core.Framework.DispatchPriority)"> + <summary> + Asynchronously invokes the <paramref name="action" /> on the UI Thread + </summary> + <param name="action">The action.</param> + <param name="dispatcherPriority">The dispatcher priority.</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.ZoomExtents"> + <summary> + Zooms the chart to the extents of the data, plus any X or Y Grow By fraction set on the X and Y Axes + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.AnimateZoomExtents(System.TimeSpan)"> + <summary> + Zooms to extents with the specified animation duration + </summary> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.ZoomExtentsY"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.AnimateZoomExtentsY(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.ZoomExtentsX"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.AnimateZoomExtentsX(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.CalculateAutoRange(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> requests to perform autoranging. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="axis">The axis</param> + <returns> + The new VisibleRange for the YAxis + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.CalculateNewXAxisRange(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called by the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> during render to calculate the new XAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="xAxis"></param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.CalculateNewYAxisRange(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Called by the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> during render to calculate the new YAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="yAxis">The YAxis to calculate for</param> + <param name="renderPassInfo">The current <see cref="T:SciChart.Charting.Services.RenderPassInfo" /> containing render data</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.OnCalculateNewXRange(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> requests the XAxis VisibleRange. + + The Range returned by this method will be applied to the chart on render + </summary> + <param name="xAxis">The XAxis</param> + <returns>The new VisibleRange for the XAxis</returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.OnCalculateNewYRange(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> requests a YAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="yAxis">The YAxis</param> + <param name="renderPassInfo">The render pass info.</param> + <returns> + The new VisibleRange for the YAxis + </returns> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.OnVisibleRangeChanged(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> changes for an axis. Override in derived types to get a notification of this occurring + </summary> + <param name="axis">The <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.OnParentSurfaceRendered(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> is rendered. + </summary> + <param name="sciChartSurface">The SciChartSurface instance</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode)"> + <summary> + Triggers a redraw on the parent surface with the specified RangeMode + </summary> + <param name="rangeMode">The <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> specifying how to redraw the parent surface</param> + </member> + <member name="M:SciChart.Charting.ViewportManagers.ViewportManagerBase.OnInvalidateParentSurface(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Raises the <see cref="E:InvalidateParentSurface" /> event. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation"> + <summary> + An Anchor-Point annotation is an <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> which only has one X1,Y1 point. + This annotation may be anchored around the coordinate using various alignmnets. See the <see cref="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.HorizontalAnchorPoint" /> and <see cref="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.VerticalAnchorPoint" /> properties + for more information + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.HorizontalAnchorPointProperty"> + <summary> + Defines the HorizontalAnchorPoint DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.VerticalAnchorPointProperty"> + <summary> + Defines the VerticalAnchorPointProperty DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.HorizontalAnchorPoint"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.HorizontalAnchorPoint" />. + The value of Left means the X1,Y1 coordinate of the annotation is on the Left horizontally. + The value of Center means the X1,Y1 coordinate of the annotation is at the center horizontally. + The value of Right means the X1,Y1 coordinate of the annotation is at the right horizontally. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.VerticalAnchorPoint"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.VerticalAnchorPoint" />. + The value of Top means the X1,Y1 coordinate of the annotation is on the Top vertically. + The value of Center means the X1,Y1 coordinate of the annotation is at the center vertically. + The value of Bottom means the X1,Y1 coordinate of the annotation is at the Bottom vertically. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.VerticalOffset"> + <summary> + Gets the computed VerticalOffset in pixels to apply to this annotation when placing + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.HorizontalOffset"> + <summary> + Gets the computed HorizontalOffset in pixels to apply to this annotation when placing + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.GetAnchorAnnotationCoordinates(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Applies <see cref="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.HorizontalOffset" /> and <see cref="P:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.VerticalOffset" /> to annotationCoordinates + </summary> + <param name="annotationCoordinates"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnchorPointAnnotation.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationCanvas"> + <summary> + Enumeration constants to define the Annotation Canvas that an <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> is placed on + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.AboveChart"> + <summary> + The annotation is placed above the chart + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.BelowChart"> + <summary> + The annotation is placed below the chart + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.YAxis"> + <summary> + The annotation is placed on the YAxis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.XAxis"> + <summary> + The annotation is placed on the XAxis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.ModifierSurface"> + <summary> + The annotation is placed on the ModifierSurface + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode"> + <summary> + Enumeration constants to define the Coordinate mode used to place an annotation + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute"> + <summary> + Absolute, requires that coordinates X1,Y1,X2,Y2 are data-values + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative"> + <summary> + Relative, requires that coordinates X1,Y1,X2,Y2 are double values between 0.0 and 1.0 + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.RelativeX"> + <summary> + RelativeX, requires that coordinates X1,X2 are double values between 0.0 and 1.0, whereas Y1,Y2 are data-values + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.RelativeY"> + <summary> + RelativeY, requires that coordinates Y1,Y2 are double values between 0.0 and 1.0, whereas X1,X2 are data-values + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates"> + <summary> + Used internally by the Annotation API. Struct to hold transformed coordinates for placement of an annotation on the chart. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates.X1Coord"> + <summary>Gets or sets the X1 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates.X2Coord"> + <summary>Gets or sets the X2 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates.Y1Coord"> + <summary>Gets or sets the Y1 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates.Y2Coord"> + <summary>Gets or sets the Y2 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates.YOffset"> + <summary>Gets or sets the offset of the YAxis which the annotation is associated with.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates.XOffset"> + <summary>Gets or sets the offset of the YAxis which the annotation is associated with.</summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationBase"> + <summary> + Provides a base class for annotations to be rendered over the chart + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.ParentCoordinatesProperty"> + <summary> + Defines the ParentCoordinates attached property, which is set by a CompositeAnnotation on its children. + Returns the coordinates of the parental CompositeAnnotation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.SetParentCoordinates(System.Windows.DependencyObject,System.Nullable{SciChart.Charting.Visuals.Annotations.AnnotationCoordinates})"> + <summary> + Sets the ParentCoordinates attached property on a child of a CompositeAnnotation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetParentCoordinates(System.Windows.DependencyObject)"> + <summary> + Gets the ParentCoordinates attached property for a child of a CompositeAnnotation. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.XAxisIdProperty"> + <summary>Defines the YAxisId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.YAxisIdProperty"> + <summary>Defines the YAxisId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.X1Property"> + <summary>Defines the X1 DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.Y1Property"> + <summary>Defines the Y1 DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.X2Property"> + <summary>Defines the X2 DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.Y2Property"> + <summary>Defines the Y2 DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationCanvasProperty"> + <summary>Defines the AnnotationCanvas DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.CoordinateModeProperty"> + <summary>Defines the CoordinateMode DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsSelectedProperty"> + <summary>Defines the IsSelected DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsEditableProperty"> + <summary>Defines the IsEditable DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHiddenProperty"> + <summary>Defines the IsHidden DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDirectionsProperty"> + <summary>Defines the DragDirections DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.ResizeDirectionsProperty"> + <summary>Defines the ResizeDirection DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.CanEditTextProperty"> + <summary>Defines the CanEditText DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.SelectedCommandProperty"> + <summary>Defines the SelectedCommand DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.UnselectedCommandProperty"> + <summary>Defines the UnSelectedCommand DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragStartedCommandProperty"> + <summary>Defines the DragStartedCommand DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragEndedCommandProperty"> + <summary>Defines the DragEndedCommand DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDeltaCommandProperty"> + <summary>Defines the DragDeltaCommand DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHiddenChangedCommandProperty"> + <summary>Defines the IsHiddenChangedCommand DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.ResizingGripsStyleProperty"> + <summary> + Defines the ResizingGripsStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationRoot"> + <summary> + The Root Element of the Annotation to be displayed on the Canvas + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.Selected"> + <summary> + Occurs when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes selected. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.Unselected"> + <summary> + Occurs when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes unselected. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragStarted"> + <summary> + Occurs when a Drag or move operation starts + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragEnded"> + <summary> + Occurs when a Drag or move operation ends + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDelta"> + <summary> + Occurs when current <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> is dragged or moved + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHiddenChanged"> + <summary> + Occurs when the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHidden" /> property is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.MouseMiddleButtonDown"> + <summary> + Occurs when the middle mouse button is pressed while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.MouseMiddleButtonUp"> + <summary> + Occurs when the middle mouse button is released while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. However, this event will only be raised if a caller marks the preceding <see cref="E:System.Windows.UIElement.MouseRightButtonDown" /> event as handled; see Remarks. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.SavedCoordinates"> + <summary> + Coordinates saved during the last update for CompositeAnnotation. Later it will be passed to all CopmositAnnotation children as ParentCoordinates + Used internally, only for Composite Annotation API + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHiddenChangedCommand"> + <summary> + Gets or sets the command to invoke when the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHidden" /> property is changed. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDeltaCommand"> + <summary> + Gets or sets the command to invoke when current <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> is dragged or moved. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragEndedCommand"> + <summary> + Gets or sets the command to invoke when a Drag or move operation ends. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragStartedCommand"> + <summary> + Gets or sets the command to invoke when a Drag or move operation starts. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.UnselectedCommand"> + <summary> + Gets or sets the command to invoke when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes unselected. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.SelectedCommand"> + <summary> + Gets or sets the command to invoke when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes selected. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.ParentAnnotation"> + <summary> + Returns the parental <see cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation" /> for every child in the <see cref="P:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.Annotations" /> collection. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.ResizingGripsStyle"> + <summary> + Gets or sets the Style which is applied to the resizing grips appearing when the annotation gets selected. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.CanEditText"> + <summary> + Gets or sets whether text can be edited on this <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" />. + Supported by Text or label annotations only + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsResizable"> + <summary> + Gets value, indicates whether current instance is resizable + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this Annotation is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDirections"> + <summary> + Limits the Drag direction when dragging the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.ResizeDirections"> + <summary> + Limits the Resize direction when resizing the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.CoordinateMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode" /> to use when placing the annotation. E.g. the default of Absolute requires that X1,Y1 coordinates are data-values. The value + of Relative requires that X1,Y1 are double values from 0.0 to 1.0 + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationCanvas"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationCanvas" /> to place the annotation on. The default is <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCanvas.AboveChart" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsSelected"> + <summary> + Gets or sets whether the current annotation is selected. When selected, an Adorner is placed over the annotation to allow dynamic resizing and dragging by the user. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsEditable"> + <summary> + Gets or sets whether the current annotation is editable. When editable, the user may click to select and interact with the annotation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsHidden"> + <summary> + Gets or sets value, indicates whether current annotation was hidden by <see cref="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.Hide" /> call + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.X1"> + <summary> + Gets or sets the X1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.X2"> + <summary> + Gets or sets the X2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.Y1"> + <summary> + Gets or sets the Y1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.Y2"> + <summary> + Gets or sets the Y2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the top of the YAxis and 1.0 is the bottom + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnDragStarted"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragStarted" /> event, called when a drag operation starts + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnDragEnded"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragEnded" /> event, called when a drag operation ends + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnDragDelta"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDelta" /> event, called when a drag operation is in progress and each time the X1 Y1 X2 Y2 points update in the annotation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsAttached"> + <summary> + Gets or sets whether this Element is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <value> + <c>true</c> if this instance is attached; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.YAxis"> + <summary> + Gets the YAxis, which current annotation is bound to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.XAxis"> + <summary> + Gets the XAxis, which current annotation is bound to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationOverlaySurface"> + <summary> + Gets the canvas over the Series on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationUnderlaySurface"> + <summary> + Gets the canvas under the Series on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.SciChart#Charting#Visuals#Annotations#IAnnotation#OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Raises notification when parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /> changes. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.SciChart#Charting#Visuals#Annotations#IAnnotation#OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Raises notification when parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /> changes. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAxisAlignmentChanged(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment" /> has changed + </summary> + <param name="axis"></param> + <param name="oldAlignment"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Virtual method to override if you wish to be notified that the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Virtual method to override if you wish to be notified that the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnYAxisIdChanged"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.YAxisId" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnXAxisIdChanged"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.XAxisId" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.FocusInputTextArea"> + <summary> + Focuses the input text area. Applicable only for Text and label annotations + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.RemoveFocusInputTextArea"> + <summary> + Remove focus from input text area. Applicable only for Text and label annotation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAttached"> + <summary> + Called when the Annotation is attached to parent surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAnnotationLoaded(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Gets called as soon as the Loaded event occurs. + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.AttachInteractionHandlersTo(System.Windows.FrameworkElement)"> + <summary> + Attaches handlers to particular events of passed object + </summary> + <param name="source">Mouse events source</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAnnotationMouseDown(System.Object,System.Windows.Input.MouseButtonEventArgs)"> + <summary> + Contains interaction logic of handling mouse down event + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAnnotationMouseMove(System.Object,System.Windows.Input.MouseEventArgs)"> + <summary> + Contains interaction logic of handling mouse move event + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAnnotationMouseUp(System.Object,System.Windows.Input.MouseButtonEventArgs)"> + <summary> + Contains interaction logic of handling mouse up event + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnDetached"> + <summary> + Called immediately before the Annotation is detached from its parent surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.DetachInteractionHandlersFrom(System.Windows.FrameworkElement)"> + <summary> + When called in a derived class, detaches any mouse events which may have been previously attached to the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /></summary> + <param name="source"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.Refresh"> + <summary> + Refreshes the annnotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, without causing a full redraw of the chart + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.TryUpdate(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates annotation if coordinate calculators are valid + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates the coordinate calculators and refreshes the annotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="xCoordinateCalculator">The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + <param name="yCoordinateCalculator">The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.Hide"> + <summary> + Hides the Annotation by removing adorner markers from the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.AdornerLayerCanvas" /> + and setting Visibility to Collapsed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.Show"> + <summary> + Shows annotation which being hidden by <see cref="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.Hide" /> call + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.MakeInvisible"> + <summary> + Called internally by layout system when annotation is out of surface's bounds + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.HideAdornerMarkers"> + <summary> + Hides adorner markers by calling <see cref="M:SciChart.Charting.Visuals.Annotations.AdornerBase.Clear" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetUsedAdorners``1(System.Windows.Controls.Canvas)"> + <summary> + Gets a collection of the Adorners currently used on the Annotation, given the Annotation AdornerLayer Canvas + </summary> + <typeparam name="T">The type of Adorners to search for</typeparam> + <param name="adornerLayer">The adorner layer canvas</param> + <returns>A list of adorners matching type T</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.MakeVisible(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Called internally by layout system when annotation come into surface's bounds + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsInBounds(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,SciChart.Charting.Visuals.Annotations.IAnnotationCanvas)"> + <summary> + Performs a simple rectangular bounds-check to see if the X1,X2,Y1,Y2 coordinates passed in are within the Canvas extends + </summary> + <param name="coordinates">The normalised AnnotationCoordinates</param> + <param name="canvas">The canvas to check if the annotation is within bounds</param> + <returns>True if in bounds</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.PlaceAnnotation(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Override in derived classes to handle specific placement of the annotation at the given <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates" /></summary> + <param name="coordinates">The normalised <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetCanvas(SciChart.Charting.Visuals.Annotations.AnnotationCanvas)"> + <summary> + Gets the Canvas instance for this annotation + </summary> + <param name="annotationCanvas">The <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationCanvas" /> enumeration</param> + <returns>The canvas instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnRenderablePropertyChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + DependencyProperty changed handler which can be used to refresh the annotation on property changed + </summary> + <param name="d">The DependencyObject sender.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAnnotationPositionChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + DependencyProperty changed handler which can be used to refresh the annotation on property and position changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.UpdatePosition(System.Windows.Point,System.Windows.Point)"> + <summary> + Updates the position and values of the annotation during a drag or resize operation, by setting X1,Y1,X2,Y2 and X,Y pixel coordinates together, + from a pixel coordinate input + </summary> + <param name="point1">The first input pixel coordinate</param> + <param name="point2">The second input pixel coordinate</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.FromCoordinates(System.Windows.Point)"> + <summary> + Converts pixel coordinates to data-values + </summary> + <param name="coords">The X, Y coordinates </param> + <returns> + The data values + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.FromCoordinates(System.Double,System.Double)"> + <summary> + Converts pixel coordinates to data-values + </summary> + <param name="xCoord">The X coordinate</param> + <param name="yCoord">The Y coordinate</param> + <returns> + The data values + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.FromCoordinate(System.Double,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Converts a pixel coordinate to data-value + </summary> + <param name="coord">The pixel coordinate.</param> + <param name="axis">The axis for which the data value is calculated</param> + <returns> + The datavalue + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.FromRelativeCoordinate(System.Double,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Converts a relative coordinate (e.g. 0.0 to 1.0) to data-value + </summary> + <param name="coord">The relative coordinate, in the range of 0.0 to 1.0 for extremes of the viewport.</param> + <param name="axis">The axis for which the data value is calculated</param> + <returns> + The datavalue + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.ToCoordinate(System.IComparable,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Converts a data value to pixel coordinate + </summary> + <param name="dataValue">The data value to convert</param> + <param name="axis">The axis for which the coordinate is calculated</param> + <returns>The coordinate in pixels</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.ToCoordinates(System.IComparable,System.IComparable,SciChart.Charting.Visuals.Annotations.IAnnotationCanvas,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Converts a data-values to pixel coordinates + </summary> + <param name="xDataValue">The X data-value, e.g. value of X1 or X2</param> + <param name="yDataValue">The Y data-value, e.g. value of Y1 or Y2 </param> + <param name="canvas">The <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.AnnotationCanvas" /></param> + <param name="xCoordCalc">The current X <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> valid for the current render pass</param> + <param name="yCoordCalc">The current Y <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> valid for the current render pass</param> + <returns> + The pixel coordinates + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.ToCoordinate(System.IComparable,System.Double,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.XyDirection)"> + <summary> + Converts a Data-Value to Pixel Coordinate + </summary> + <param name="dataValue">The Data-Value to convert</param> + <param name="canvasMeasurement">The size of the canvas in the X or Y direction</param> + <param name="coordCalc">The current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1">Coordinate Calculator</see></param> + <param name="direction">The X or Y direction for the transformation</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetCoordinates(SciChart.Charting.Visuals.Annotations.IAnnotationCanvas,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates" /> struct containing pixel coordinates to place or update the annotation in the current render pass + </summary> + <param name="canvas">The canvas the annotation will be placed on</param> + <param name="xCalc">The current XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> to perform data to pixel transformations</param> + <param name="yCalc">The current YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> to perform data to pixel transformations</param> + <returns>The <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates" /> struct containing pixel coordinates</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.MoveAnnotation(System.Double,System.Double)"> + <summary> + This method is used internally by the <see cref="!:AnnotationDragAdorner" />. Programmatically moves the annotation by an X,Y offset. + </summary> + <param name="horizOffset">The horizontal offset to move in pixels</param> + <param name="vertOffset">The vertical offset to move in pxiels</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.MoveAnnotationTo(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates,System.Double,System.Double)"> + <summary> + Moves the annotation to a specific horizontal and vertical offset + </summary> + <param name="coordinates">The initial coordinates.</param> + <param name="horizOffset">The horizontal offset.</param> + <param name="vertOffset">The vertical offset.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsCoordinateValid(System.Double,System.Double)"> + <summary> + Determines whether the coordinate is valid for placing on the canvas, e.g. is greater than zero and less than <paramref name="canvasMeasurement" /></summary> + <param name="coord">The coordinate.</param> + <param name="canvasMeasurement">The canvas dimension in this axis.</param> + <returns> + <c>true</c> if coordinate is valid; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetBasePoints"> + <summary> + This method is used in internally by the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner" />. Gets the adorner point positions + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetBasePoints(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + This method is used in internally by the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner" />. Gets the adorner point positions + </summary> + <param name="coordinates">The previously calculated <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCoordinates" /> in screen pixels.</param> + <returns>A list of points in screen pixels denoting the Adorner corners</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.SetBasePoint(System.Windows.Point,System.Int32)"> + <summary> + This method is used in internally by the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner" />. Programmatically sets an adorner point position + </summary> + <param name="newPoint"></param> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.MoveBasePointTo(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally to marshal pixel points to X1,Y1,X2,Y2 values. + Taking a pixel point (<paramref name="newPoint" />) and base point <paramref name="index" />, sets the X,Y data-values. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.SetBasePoint(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally to marshal pixel points to X1,Y1,X2,Y2 values. + Taking a pixel point (<paramref name="newPoint" />) and base point <paramref name="index" />, sets the X,Y data-values. + </summary> + <param name="newPoint">The pixel point</param> + <param name="index">The base point index, where 0, 1, 2, 3 refer to the four corners of an Annotation</param> + <param name="yAxis">The current Y-Axis</param> + <param name="xAxis">The current X-Axis </param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetPropertiesFromIndex(System.Int32,System.Windows.DependencyProperty@,System.Windows.DependencyProperty@)"> + <summary> + Used internally to derive the X1Property, Y1Property, X1Property, Y2Property pair for the given index around the annotation.. + + e.g. index 0 returns X1,Y1 + index 1 returns X2,Y1 + index 2 returns X2,Y2 + index 3 returns X1,Y2 + </summary> + <param name="index">The index</param> + <param name="x">The X coordinate dependency property, either X1Property or X2Property</param> + <param name="y">The Y coordinate dependency property, either Y1Property or Y2Property</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetAdornerLayer"> + <summary> + Gets the Adorner Canvas to place annotation adorners + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.AddAdorners(System.Windows.Controls.Canvas)"> + <summary> + When overriden in a derived class, places the appropriate adorners on the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /></summary> + <param name="adornerLayer">The adorner layer</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.RemoveAdorners(System.Windows.Controls.Canvas)"> + <summary> + Removes all adorners from the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /></summary> + <param name="adornerLayer">The adorner layer</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The input point relative to this <see cref="T:SciChart.Core.Framework.IHitTestable" /></param> + <param name="relativeTo">The other <see cref="T:SciChart.Core.Framework.IHitTestable" /> to use when transforming the point</param> + <returns> + The transformed Point + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element relative to another <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="relativeTo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.OnAnnotationDragging(SciChart.Charting.Visuals.Events.AnnotationDragDeltaEventArgs)"> + <summary> + Initiates the DragDelta event + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes the updates. + </summary> + <param name="updateSuspender">The update suspender.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationBase.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection"> + <summary> + Contains a collection of <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> derived types, which allow custom drawing elements + over or under the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.Annotations.IAnnotation})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationCollection.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to perform operations on + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.SubscribeSurfaceEvents(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Subscribes the AnnotationCollection to events on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + Should be called internally by the Annotations API when attaching to a surface. + </summary> + <param name="parentSurface">The parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.UnsubscribeSurfaceEvents(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Unsubscribes the AnnotationCollection to events on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + Should be called internally by the Annotations API when detaching from a surface. + </summary> + <param name="parentSurface">The parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.UnsubscribeInnerCollection"> + <summary> + Removes event handlers and clears the reference for the internal collection. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.DeselectAll"> + <summary> + Deselects all annotations in the AnnotationCollection + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.ClearItems"> + <summary> + Clears all Annotations from the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.RefreshPositions(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Refreshes positions of all annotations within the collection + </summary> + <param name="rpi"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.GetCoordinateCalculator(System.Collections.Generic.IDictionary{System.String,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double}},SciChart.Charting.Visuals.Annotations.IAnnotation,System.String,System.Boolean)"> + <summary> + Returns the coordinate calculator for the axis by axis string ID + </summary> + <param name="coordinateCalculators">The keyed dictionary of axis coordinate calculators</param> + <param name="annotation">The annotation item</param> + <param name="axisId">The string ID of the axis</param> + <param name="isXAxis">The parameter which shows whether the axis is X or Y</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.TrySelectAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <summary> + Gets attempt to select annotation, and returns whether attempt was successful or not + </summary> + <param name="annotationBase">Annotation <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> for selection</param> + <returns></returns> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationCollection.OnRootGridMouseDownHandled"> + <summary> + Used internally for unit tests + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called with the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /><see cref="T:SciChart.Charting.Model.AxisCollection" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationCollection.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LabelPlacement"> + <summary> + Enumeration constants to define label placement + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.Right"> + <summary>Places on the right</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.TopRight"> + <summary>Places at the top right</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.BottomRight"> + <summary>Places at the bottom right</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.Bottom"> + <summary>Places at the bottom</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.Left"> + <summary>Places on the left</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.TopLeft"> + <summary>Places on the top left</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.BottomLeft"> + <summary>Places on the bottom left</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.Top"> + <summary>Places at the top</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.Axis"> + <summary>Places on the axis</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LabelPlacement.Auto"> + <summary>Automatic Placement (Default)</summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel"> + <summary> + Defines an AnnotationLabel which may be used in <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /> and <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /> instances + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.TextProperty"> + <summary>Defines the Text DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.LabelPlacementProperty"> + <summary>Defines the LabelPlacement DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.LabelStyleProperty"> + <summary>Defines the LabelStyle DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.AxisLabelStyleProperty"> + <summary>Defines the AxisLabel DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.CornerRadiusProperty"> + <summary>Defines the CornerRadius DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.RotationAngleProperty"> + <summary>Defines the RotationAngle DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.DefaultRotationAngleProperty"> + <summary>Defines the DefaultRotationAngle DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.CanEditTextProperty"> + <summary>Defines the CanEditText DependnecyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AnnotationLabel.TextFormattingProperty"> + <summary>Defines the TextFormatting DependnecyProperty</summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationLabel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.CanEditText"> + <summary> + Gets or sets whether the text in the label is editable + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.RotationAngle"> + <summary> + Gets or sets the angle, in degrees, of clockwise rotation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.DefaultRotationAngle"> + <summary> + Gets the angle, in degrees, of clockwise default rotation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.ParentAnnotation"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /> that this label is attached to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.Text"> + <summary> + Gets or sets the Text of the label + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.LabelPlacement"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.LabelPlacement" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.TextFormatting"> + <summary> + Gets or sets the TextFormatting to use on the label, when the Text property is bound to a Data-Value. + This works in a similar way to the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> TextFormatting property + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.LabelStyle"> + <summary> + Gets or sets a <see cref="T:System.Windows.Style" /> to apply to the label + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.AxisLabelStyle"> + <summary> + Gets or sets a <see cref="T:System.Windows.Style" /> to apply to the Axis Label + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AnnotationLabel.CornerRadius"> + <summary> + Gets or sets the CornerRadius of the Label element + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationLabel.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call <see cref="M:System.Windows.Controls.Control.ApplyTemplate" />. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AnnotationLabel.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.IAnnotationResizeAdorner"> + <summary> + Defines the inteface to an annotation resize adorner, which is placed over an <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> + when selected, allowing the user to move or resize it by dragging + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotationResizeAdorner.AdornerMarkers"> + <summary> + Gets the Adorner Markers placed by this annotation (e.g. grippers to resize, move) + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LineAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.LineAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LineArrowAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.LineArrowAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineArrowAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.LineArrowAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.BoxAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.BoxAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.BoxAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.BoxAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.BoxAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.CompositeAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.TextAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.TextAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TextAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.HorizontalLineAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.VerticalLineAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.AxisMarkerAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.CustomAnnotationForMvvm"> + <summary> + INTERNAL USE ONLY: Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.Annotations.CustomAnnotation" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.CustomAnnotationViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CustomAnnotationForMvvm.#ctor"> + <summary> + INTERNAL USE ONLY: Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.Annotations.CustomAnnotationForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation"> + <summary> + The AxisMarkerAnnotation provides an axis label which is data-bound to its Y-value. Used to place a marker on the Y-Axis it can give feedback about the latest value of a series, or + important points in a series. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.FormattedValueProperty"> + <summary> + Defines the FormattedValue DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.MarkerPointWidthProperty"> + <summary> + Defines the MarkerPointWidth DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.LabelTemplateProperty"> + <summary> + Defines the LabelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.PointerTemplateProperty"> + <summary> + Defines the PointerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.AxisInfoProperty"> + <summary> + Defines the AxisInfo DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.FormattedValue"> + <summary> + Gets or sets the Formatted Value of the Axis Marker. By default this is data-bound to Y1 + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.MarkerPointWidth"> + <summary> + Gets or sets the Marker tip width, this is the width of the point of the marker in pixels. Default value is 8. + Change this property if the marker looks squashed! + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.LabelTemplate"> + <summary> + Gets or sets label template of <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.PointerTemplate"> + <summary> + Gets or sets pointer template of <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.Axis"> + <summary> + Gets <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> intance where <see cref="T:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation" /> is placed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.AxisInfo"> + <summary> + Gets AxisInfo for current MarkerValue + Used internally as DataContext for <see cref="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.PointerTemplate" /> and <see cref="P:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.LabelTemplate" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.OnAxisAlignmentChanged(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment" /> has changed + </summary> + <param name="axis"></param> + <param name="oldAlignment"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.TryUpdate(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates annotation if appropriate coordinate calculator is valid + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates the coordinate calculators and refreshes the annotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="xCoordinateCalculator">The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + <param name="yCoordinateCalculator">The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.ToCoordinate(System.IComparable,System.Double,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.XyDirection)"> + <summary> + Converts a Data-Value to Pixel Coordinate + </summary> + <param name="dataValue">The Data-Value to convert</param> + <param name="canvasMeasurement">The size of the canvas in the X or Y direction</param> + <param name="coordCalc">The current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1">Coordinate Calculator</see></param> + <param name="direction">The X or Y direction for the transformation</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.AxisMarkerAnnotation.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.BoxAnnotation"> + <summary> + Defines a rectangle or box annotation, which may be placed on the chart at specific X1,Y1,X2,Y2 coordinates + </summary> + <example> + <code title="BoxAnnotation Example" description="Shows how to create and add a BoxAnnotation to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/scichart"--> + <s:SciChartSurface> + <!-- RenderableSeries omitted for brevity --> + + <s:SciChartSurface.XAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.XAxis> + <s:SciChartSurface.YAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.YAxis> + + <s:SciChartSurface.Annotations> + <!-- Declare a BoxAnnotation at X1,X2,Y1,Y2 --> + <!-- NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis --> + <s:BoxAnnotation X1="1" X2="2" Y1="3" Y2="4" + BorderBrush="Orange" Background="#33FF6600" BorderThickness="2" CornerRadius="2" + AnnotationCanvas="AboveChart" + IsSelected="False" + IsEditable="False" + XAxisId="DefaultAxisId" + YAxisId="DefaultAxisId" /> + </s:SciChartSurface.Annotations> + </s:SciChartSurface> + </code> + <code title="BoxAnnotation Example" description="Shows how to create and add a BoxAnnotation to a SciChartSurface in Code" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.XAxis = new NumericAxis() { Id = "DefaultAxisId" }; + sciChartSurface.YAxis = new NumericAxis() { Id = "DefaultAxisId" }; + + // Declare a BoxAnnotation at X1,X2,Y1,Y2 + // NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis + sciChartSurface.Annotations.Add(new BoxAnnotation() + { + X1 = 1, X2 = 2, Y1 = 3, Y2 = 4, + BorderBrush = new SolidColorBrush(Colors.Orange), + Background = new SolidColorBrush(Colors.FromArgb(0x33, 0xFF, 0x66, 0x00), + BorderThickness = new Thickness(2), + CornerRadius = new Thickness(2), + AnnotationCanvas = AnnotationCanvas.AboveChart, + IsSelected = false, + IsEditable = false, + XAxisId = "DefaultAxisId", + YAxisId = "DefaultAxisId", + }); + </code> + </example> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.BoxAnnotation.CornerRadiusProperty"> + <summary> + Defines the CornerRadius DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.BoxAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.BoxAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.BoxAnnotation.CornerRadius"> + <summary> + Gets or sets the CornerRadius of the box + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.BoxAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.BoxAnnotation.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.BoxAnnotation.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation"> + <summary> + Defines an annotation, which group the collection of <see cref="P:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.Annotations" /> together, so they interact like one composite annotation + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.AnnotationsProperty"> + <summary> + Defines the Annotations DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.Annotations"> + <summary> + Gets or sets the <see cref="T:System.Collections.ObjectModel.ObservableCollection`1" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates the coordinate calculators and refreshes the annotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="xCoordinateCalculator">The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + <param name="yCoordinateCalculator">The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.MoveBasePointTo(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally to marshal pixel points to X1,Y1,X2,Y2 values. + Taking a pixel point (<paramref name="newPoint" />) and base point <paramref name="index" />, sets the X,Y data-values. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.OnAttached"> + <summary> + Called when the Annotation is attached to the parent surface. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.AttachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <summary> + Attaches an <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> instance as a child of this <see cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation" />. + All attached annotations will delegate mouse events to their <see cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation" /> parent. + </summary> + <remarks>Called internally for all annotations from the <see cref="P:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.Annotations" /> collection.</remarks> + <param name="item">The annotation to attach.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.OnDetached"> + <summary> + Called when the Annotation is detached from the parent surface. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.DetachAnnotation(SciChart.Charting.Visuals.Annotations.IAnnotation)"> + <summary> + Detaches an <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> instance. + Detached annotations are not rendered and don't respond to mouse events. + </summary> + <remarks>Called internally for all annotations from the <see cref="P:SciChart.Charting.Visuals.Annotations.CompositeAnnotation.Annotations" /> collection.</remarks> + <param name="item">The annotation to detach.</param> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.CompositeTradingAnnotationBase"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeTradingAnnotationBase.GetCurrentPlacementStrategy"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeTradingAnnotationBase.MoveBasePointTo(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeTradingAnnotationBase.OnAnnotationPointerPressed(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeTradingAnnotationBase.OnAnnotationPointerMoved(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeTrendLineAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates the coordinate calculators and refreshes the annotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="xCoordinateCalculator">The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + <param name="yCoordinateCalculator">The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TrendLineCoordinates.X1DataValue"> + <summary>Gets or sets the X1 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TrendLineCoordinates.X2DataValue"> + <summary>Gets or sets the X2 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TrendLineCoordinates.Y1DataValue"> + <summary>Gets or sets the Y1 coordinate.</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TrendLineCoordinates.Y2DataValue"> + <summary>Gets or sets the Y2 coordinate.</summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CompositeTrendLineAnnotationBase.ToCoordinates(System.IComparable,System.IComparable,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Converts a data-values to pixel coordinates + </summary> + <param name="xDataValue">The X data-value, e.g. value of X1 or X2</param> + <param name="yDataValue">The Y data-value, e.g. value of Y1 or Y2 </param> + <returns> + The pixel coordinates + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.CustomAnnotation"> + <summary> + CustomAnnotation is a ContentControl which can be overlaid on the annotation surfaces. For examples of use, see the Annotations Are Easy and Create Annotations Dynamically examples in the trial download + </summary> + <example> + <code title="LineAnnotation Example" description="Shows how to create and add a LineAnnotation to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/scichart"--> + <s:SciChartSurface> + <!-- RenderableSeries omitted for brevity --> + + <s:SciChartSurface.XAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.XAxis> + <s:SciChartSurface.YAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.YAxis> + + <s:SciChartSurface.Annotations> + <!-- Declare a CustomAnnotation at X1,X2 --> + <!-- NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis --> + <s:CustomAnnotation X1="1" X2="2" + HorizontalAnchorPoint="Center" + VerticalAnchorPoint="Top" + AnnotationCanvas="AboveChart" + IsSelected="False" + IsEditable="False" + XAxisId="DefaultAxisId" + YAxisId="DefaultAxisId"> + <s:CustomAnnotation.Content> + <Path Data="m 4 14 4 0 0 -8 3 0 -5 -5 -5 5 3 0 z" Fill="#571CB61C" Stroke="#FF00B400" StrokeThickness="1"/> + </s:CustomAnnotation.Content> + </s:CustomAnnotation> + </s:SciChartSurface.Annotations> + </s:SciChartSurface> + </code> + <code title="LineAnnotation Example" description="Shows how to create and add a LineAnnotation to a SciChartSurface in Code" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.XAxis = new NumericAxis() { Id = "DefaultAxisId" }; + sciChartSurface.YAxis = new NumericAxis() { Id = "DefaultAxisId" }; + + // Declare a LineAnnotation at X1,X2,Y1,Y2 + // NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis + sciChartSurface.Annotations.Add(new CustomAnnotation() + { + X1 = 1, X2 = 2 + Stroke = new SolidColorBrush(Colors.Orange), + HorizontalAnchorPoint = HorizontalAnchorPoint.Center, + VerticalAnchorPoint = VerticalAnchorPoint.Top, + AnnotationCanvas = AnnotationCanvas.AboveChart, + IsSelected = false, + IsEditable = false, + XAxisId = "DefaultAxisId", + YAxisId = "DefaultAxisId", + Content = new Path() + { + Data = Geometry.Parse("m 4 14 4 0 0 -8 3 0 -5 -5 -5 5 3 0 z"), + Fill = new SolidColorBrush(Color.FromArgb(0x57, 0x1C, 0xB6, 0x1C)), + Stroke = new SolidColorBrush(Color.FromArgb(0xFF, 0x00, 0xB4, 0x00)), + StrokeThickness = 1, + }, + }); + </code> + </example> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CustomAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.CustomAnnotation" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CustomAnnotation.OnContentChanged(System.Object,System.Object)"> + <summary> + Called when the <see cref="P:System.Windows.Controls.ContentControl.Content" /> property changes. + </summary> + <param name="oldContent">The old value of the <see cref="P:System.Windows.Controls.ContentControl.Content" /> property.</param> + <param name="newContent">The new value of the <see cref="P:System.Windows.Controls.ContentControl.Content" /> property.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CustomAnnotation.OnContentTemplateChanged(System.Windows.DataTemplate,System.Windows.DataTemplate)"> + <summary> + Called when the <see cref="P:System.Windows.Controls.ContentControl.ContentTemplate" /> property changes. + </summary> + <param name="oldContentTemplate">The old value of the <see cref="P:System.Windows.Controls.ContentControl.ContentTemplate" /> property.</param> + <param name="newContentTemplate">The new value of the <see cref="P:System.Windows.Controls.ContentControl.ContentTemplate" /> property.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CustomAnnotation.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.CustomLineAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.CustomLineAnnotation" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.HorizontalAnchorPoint"> + <summary> + Enumeration constants used by <see cref="T:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation" /> to define horizontal alignment around the X1,Y1 coordinates + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.HorizontalAnchorPoint.Left"> + <summary> + Align Left + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.HorizontalAnchorPoint.Center"> + <summary> + Align Center + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.HorizontalAnchorPoint.Right"> + <summary> + Align Right + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation"> + <summary> + A class for <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.HorizontalAlignmentProperty"> + <summary> + Defines the HorizontalAlignment Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.YDragStepProperty"> + <summary> + Defines the YDragStep Property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.#ctor"> + <summary> + Creates new instance of <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.HorizontalAlignment"> + <summary> + Gets or sets docking of <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.YDragStep"> + <summary> + Gets or sets the value which determines a drag step for this <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.ApplyPlacement(SciChart.Charting.Visuals.Annotations.AnnotationLabel,SciChart.Charting.Visuals.Annotations.LabelPlacement)"> + <summary> + Positions the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> using the value of the <see cref="T:SciChart.Charting.Visuals.Annotations.LabelPlacement" /> enum + </summary> + <param name="label">The label to place</param> + <param name="placement">Placement arguments</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.GetUsedAxis"> + <summary> + Returns axis, which current annotation shows data value for + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.GetPropertiesFromIndex(System.Int32,System.Windows.DependencyProperty@,System.Windows.DependencyProperty@)"> + <summary> + Used internally to derive the X1Property, Y1Property, X1Property, Y2Property pair for the given index around the annotation.. + e.g. index 0 returns X1,Y1 + index 1 returns X2,Y1 + index 2 returns X2,Y2 + index 3 returns X1,Y2 + </summary> + <param name="index">The index</param> + <param name="X"></param> + <param name="Y"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation.MoveBasePointTo(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally to marshal pixel points to X1,Y1,X2,Y2 values. + Taking a pixel point (<paramref name="newPoint" />) and base point <paramref name="index" />, sets the X,Y data-values. + </summary> + <param name="newPoint">The pixel point</param> + <param name="index">The base point index, where 0, 1, 2, 3 refer to the four corners of an Annotation</param> + <param name="xAxis">The current X-Axis</param> + <param name="yAxis">The current Y-Axis</param> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation"> + <summary> + Defines the interface to an Anchor-Point annotation, which is an <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> which only has one X1,Y1 point. + This annotation may be anchored around the coordinate using various alignmnets. See the <see cref="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.HorizontalAnchorPoint" /> and <see cref="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.VerticalAnchorPoint" /> properties + for more information + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.HorizontalAnchorPoint"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.HorizontalAnchorPoint" />. + + The value of Left means the X1,Y1 coordinate of the annotation is on the Left horizontally. + The value of Center means the X1,Y1 coordinate of the annotation is at the center horizontally. + The value of Right means the X1,Y1 coordinate of the annotation is at the right horizontally. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.VerticalAnchorPoint"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.VerticalAnchorPoint" />. + + The value of Top means the X1,Y1 coordinate of the annotation is on the Top vertically. + The value of Center means the X1,Y1 coordinate of the annotation is at the center vertically. + The value of Bottom means the X1,Y1 coordinate of the annotation is at the Bottom vertically. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.VerticalOffset"> + <summary> + Gets the computed VerticalOffset in pixels to apply to this annotation when placing + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation.HorizontalOffset"> + <summary> + Gets the computed HorizontalOffset in pixels to apply to this annotation when placing + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.IAnnotation"> + <summary> + Defines the interface to an annotation, a custom drawable element over or under the SciChartSurface + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.IAnnotation.DragStarted"> + <summary> + Occurs when a Drag or move operation starts + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.IAnnotation.DragEnded"> + <summary> + Occurs when a Drag or move operation ends + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.IAnnotation.DragDelta"> + <summary> + Occurs when current <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> is dragged or moved + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.IAnnotation.Selected"> + <summary> + Occurs when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes selected. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Annotations.IAnnotation.Unselected"> + <summary> + Occurs when <see cref="T:SciChart.Charting.Visuals.Annotations.IAnnotation" /> becomes unselected. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.XAxisId"> + <summary> + Gets or sets the XAxis Id that this annotation is measured against. See <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.Id" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.YAxisId"> + <summary> + Gets or sets the YAxis Id that this annotation is measured against. See <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.Id" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.IsAttached"> + <summary> + Gets or sets whether the current annotation is attached + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.IsSelected"> + <summary> + Gets or sets whether the current annotation is selected + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.IsEditable"> + <summary> + Gets or sets whether you can interact current annotation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.IsHidden"> + <summary> + Gets or sets value, indicates whether current annotation was hidden by <see cref="M:SciChart.Charting.Visuals.Annotations.IAnnotation.Hide" /> call + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.YAxis"> + <summary> + Gets the primary YAxis, this is the first axis in the YAxes collection + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.YAxes"> + <summary> + Returns the YAxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.XAxis"> + <summary> + Gets the XAxis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.XAxes"> + <summary> + Returns the XAxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.Services"> + <summary> + Gets or sets a <see cref="T:SciChart.Core.Utility.IServiceContainer" /> container + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.X1"> + <summary> + Gets or sets the X1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.Y1"> + <summary> + Gets or sets the Y1 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the bottom of the YAxis and 1.0 is the top + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.X2"> + <summary> + Gets or sets the X2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the X-Axis such as a DateTime for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> or integer index for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the far left of the XAxis and 1.0 is the far right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.Y2"> + <summary> + Gets or sets the Y2 Coordinate of the Annotation. + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Absolute" />, this must be a data-value on the Y-Axis such as a double for <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + + For <see cref="F:SciChart.Charting.Visuals.Annotations.AnnotationCoordinateMode.Relative" />, this must be a double value between 0.0 and 1.0, where 0.0 is the bottom of the YAxis and 1.0 is the top + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> that this Annotation belongs to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.DragDirections"> + <summary> + Limits the Drag direction when dragging the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.ResizeDirections"> + <summary> + Limits the Resize direction when resiaing the annotation using the mouse, e.g in the X-Direction, Y-Direction or XyDirection. See the <see cref="T:SciChart.Charting.XyDirection" /> enumeration for options + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.IsResizable"> + <summary> + Gets value, indicates whether current instance is resizable + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotation.DataContext"> + <summary> + Gets or sets the data context + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.CaptureMouse"> + <summary> + Captures the mouse + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.ReleaseMouseCapture"> + <summary> + Releases mouse capture + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.Update(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Updates the coordinate calculators and refreshes the annotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="xCoordinateCalculator">The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + <param name="yCoordinateCalculator">The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnDetached"> + <summary> + Called when the Annotation is detached from its parent surface + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnAttached"> + <summary> + Called when the Annotation is attached to parent surface + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.Hide"> + <summary> + Hides the Annotation by removing adorner markers from the <see cref="P:SciChart.Charting.Visuals.Annotations.IAnnotation.ParentSurface" /> AdornerLayerCanvas + and setting Visibility to Collapsed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.Show"> + <summary> + Shows annotation which being hidden by <see cref="M:SciChart.Charting.Visuals.Annotations.IAnnotation.Hide" /> call + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.MoveAnnotation(System.Double,System.Double)"> + <summary> + This method is used internally by the <see cref="!:AnnotationDragAdorner" />. Programmatically moves the annotation by an X,Y offset. + </summary> + <param name="offsetX"></param> + <param name="offsetY"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.SetBasePoint(System.Windows.Point,System.Int32)"> + <summary> + This method is used in internally by the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner" />. Programmatically sets an adorner point position + </summary> + <param name="newPoint"></param> + <param name="index"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.GetBasePoints"> + <summary> + This method is used in internally by the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationResizeAdorner" />. Gets the adorner point positions + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.Refresh"> + <summary> + Refreshes the annnotation position on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, without causing a full redraw of the chart + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnDragStarted"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragStarted" /> event, called when a drag operation starts + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnDragEnded"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragEnded" /> event, called when a drag operation ends + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnDragDelta"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDelta" /> event, called when a drag operation is in progress and each time the X1 Y1 X2 Y2 points update in the annotation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Raises notification when parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /> changes. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotation.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Raises notification when parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /> changes. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.IAnnotationAdorner"> + <summary> + Defines the interface to an annotation adorner, which may be placed to drag, or resize an annotation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotationAdorner.Initialize"> + <summary> + Initializes this adorner. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotationAdorner.Clear"> + <summary> + Clears child markers from the adorner layer + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.IAnnotationAdorner.UpdatePositions"> + <summary> + Causes a refresh to update the positions of the adorner + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotationAdorner.AdornedAnnotation"> + <summary> + Gets the associated annotation that this instance adorns + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.IAnnotationCanvas"> + <summary> + Defines the base interface for annotation canvas + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.IAnnotationCanvas.Children"> + <summary> + Gets children elements of current annotation canvas + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.AnnotationSurface"> + <summary> + A canvas which is used to place annotations on chart + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.ICompositeAnnotation"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting.Visuals.Annotations.CompositeAnnotation" />, which uses combine collection of annotations into one group + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.ICompositeAnnotation.Annotations"> + <summary> + Gets or sets the <see cref="T:System.Collections.ObjectModel.ObservableCollection`1" /></summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LineAnnotation"> + <summary> + Defines a read-only or editable Line annotation, which may be placed on the chart at specific X1,Y1,X2,Y2 coordinates + </summary> + <example> + <code title="LineAnnotation Example" description="Shows how to create and add a LineAnnotation to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/scichart"--> + <s:SciChartSurface> + <!-- RenderableSeries omitted for brevity --> + + <s:SciChartSurface.XAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.XAxis> + <s:SciChartSurface.YAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.YAxis> + + <s:SciChartSurface.Annotations> + <!-- Declare a LineAnnotation at X1,X2,Y1,Y2 --> + <!-- NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis --> + <s:LineAnnotation X1="1" X2="2" Y1="3" Y2="4" + Stroke="Orange" StrokeThickness="2" StrokeDashArray="2 2" + AnnotationCanvas="AboveChart" + IsSelected="False" + IsEditable="False" + XAxisId="DefaultAxisId" + YAxisId="DefaultAxisId" /> + </s:SciChartSurface.Annotations> + </s:SciChartSurface> + </code> + <code title="LineAnnotation Example" description="Shows how to create and add a LineAnnotation to a SciChartSurface in Code" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.XAxis = new NumericAxis() { Id = "DefaultAxisId" }; + sciChartSurface.YAxis = new NumericAxis() { Id = "DefaultAxisId" }; + + // Declare a LineAnnotation at X1,X2,Y1,Y2 + // NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis + sciChartSurface.Annotations.Add(new LineAnnotation() + { + X1 = 1, X2 = 2, Y1 = 3, Y2 = 4, + Stroke = new SolidColorBrush(Colors.Orange), + StrokeThickness = 2, + StrokeDashArray = new DoubleCollection(new double[] { 2, 2 }), + AnnotationCanvas = AnnotationCanvas.AboveChart, + IsSelected = false, + IsEditable = false, + XAxisId = "DefaultAxisId", + YAxisId = "DefaultAxisId", + }); + </code> + </example> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotation" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LineAnnotationBase"> + <summary> + A base class with shared properties for <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotation" />, <see cref="T:SciChart.Charting.Visuals.Annotations.HorizontalLineAnnotation" /> and <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeDashArrayProperty"> + <summary>Defines the StrokeDashArray DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeThicknessProperty"> + <summary>Defines the StrokeThickness DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeProperty"> + <summary>Defines the Stroke DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeStartLineCapProperty"> + <summary> Defines the StrokeStartLineCap DependencyProperty </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeEndLineCapProperty"> + <summary> Defines the StrokeStartLineCap DependencyProperty </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeStartLineCap"> + <summary> + Gets or sets the Stroke start line cap of the line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeEndLineCap"> + <summary> + Gets or sets the Stroke end line cap of the line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.Stroke"> + <summary> + Gets or sets the Stroke brush of the line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.StrokeDashArray"> + <summary> + Gets or sets the StrokeDashArray of the line + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.GetPropertiesFromIndex(System.Int32,System.Windows.DependencyProperty@,System.Windows.DependencyProperty@)"> + <summary> + Used internally to derive the X1Property, Y1Property, X1Property, Y2Property pair for the given index around the annotation.. + + e.g. index 0 returns X1,Y1 + index 1 returns X2,Y1 + index 2 returns X2,Y2 + index 3 returns X1,Y2 + </summary> + <param name="index">The index</param> + <param name="x">The X coordinate dependency property, either X1Property or X2Property</param> + <param name="y">The Y coordinate dependency property, either Y1Property or Y2Property</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationBase.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase"> + <summary> + Provides a base class for HorizontalLineAnnotation, VerticalLineAnnotation + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.ShowLabelProperty"> + <summary> + Defines the ShowLabel Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.DefaultLabelValueProperty"> + <summary> + Defines the DefaultLabelValue Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelPlacementProperty"> + <summary> + Defines the LabelPlacement Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelValueProperty"> + <summary> + Defines the LabelValue Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelTextFormattingProperty"> + <summary> + Defines the LabelTextFormatting Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.FormattedLabelProperty"> + <summary> + Defines the FormattedLabel Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.AnnotationLabelsProperty"> + <summary> + Defines the AnnotationLabels Property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.DefaultLabelValue"> + <summary> + Gets or sets value which labels will be bound to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.FormattedLabel"> + <summary> + Gets the formatted label value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.AnnotationLabels"> + <summary> + Gets or sets a collection of annotation labels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.ShowLabel"> + <summary> + Gets or sets value, indicating whether show the default label or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelPlacement"> + <summary> + Gets or sets placement for the default label + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelValue"> + <summary> + Gets or sets a value for the default label + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelTextFormatting"> + <summary> + Gets or sets formatting string which is applied to all annotation labels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.AttachLabels(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.Annotations.AnnotationLabel})"> + <summary> + Adds a collection of <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> instances to the <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /></summary> + <param name="labels">The collection of labels to add</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.DetachLabels(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.Annotations.AnnotationLabel})"> + <summary> + Removes a collection of <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> instances to the <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /></summary> + <param name="labels">The collection of labels to remove</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnDetached"> + <summary> + Called immediately before the Annotation is detached from its parent surface + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.Attach(SciChart.Charting.Visuals.Annotations.AnnotationLabel)"> + <summary> + Called internally to attach an <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> to the current instance + </summary> + <param name="label">The AnnotationLabel to attach</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.ApplyOrientation(SciChart.Charting.Visuals.Annotations.AnnotationLabel)"> + <summary> + Rotates the <paramref name="label" /> according to <see cref="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelPlacement" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.GetUsedAxis"> + <summary> + Returns axis, which current annotation shows data value for + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnXAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Virtual method to override if you wish to be notified that the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxes" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.InvalidateLabel(SciChart.Charting.Visuals.Annotations.AnnotationLabel)"> + <summary> + Invalidates annotation label + </summary> + <param name="annotationLabel">Label to invalidate</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnYAxesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Virtual method to override if you wish to be notified that the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurface.YAxes" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnYAxisIdChanged"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.YAxisId" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnXAxisIdChanged"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Annotations.AnnotationBase.XAxisId" /> has changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnAxisAlignmentChanged(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Virtual method to override if you wish to be notified that the <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment" /> has changed + </summary> + <param name="axis"></param> + <param name="oldAlignment"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.MakeInvisible"> + <summary> + Hides current instance of <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.MakeVisible(SciChart.Charting.Visuals.Annotations.AnnotationCoordinates)"> + <summary> + Hides current instance of <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.OnAttached"> + <summary> + Called when the Annotation is attached to parent surface + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.AddLabel"> + <summary> + Adds new label to <see cref="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.AnnotationLabels" /></summary> + <returns>Label which has been created</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.TryPlaceAxisLabels(System.Windows.Point)"> + <summary> + Try to place all annotation labels on ModifierAxisCanvas of appropriate axis at <paramref name="offset" /> position. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.PlaceAxisLabel(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Annotations.AnnotationLabel,System.Windows.Point)"> + <summary> + Place <paramref name="axisLabel" /> on ModifierAxisCanvas of appropriate axis at <paramref name="offset" /> position. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.Detach(SciChart.Charting.Visuals.Annotations.AnnotationLabel)"> + <summary> + Detaches the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> from the current <see cref="T:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase" /></summary> + <param name="label">The label to detach</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.ApplyPlacement(SciChart.Charting.Visuals.Annotations.AnnotationLabel,SciChart.Charting.Visuals.Annotations.LabelPlacement)"> + <summary> + Positions the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> using the value of the <see cref="P:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.LabelPlacement" /> enum + </summary> + <param name="label">The label to place</param> + <param name="placement">Placement arguments</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineAnnotationWithLabelsBase.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation"> + <summary> + The LineArrowAnnotation provides a Line with X1,Y1,X2,Y2 coordinates and an arrow head at the tip. + </summary> + <example> + <code title="LineArrowAnnotation Example" description="Shows how to create and add a LineArrowAnnotation to a SciChartSurface in XAML" lang="xaml"> + <!-- where xmlns:s="http://schemas.abtsoftware.co.uk/scichart"--> + <s:SciChartSurface> + <!-- RenderableSeries omitted for brevity --> + + <s:SciChartSurface.XAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.XAxis> + <s:SciChartSurface.YAxis> + <s:NumericAxis Id="DefaultAxisId"/> + </s:SciChartSurface.YAxis> + + <s:SciChartSurface.Annotations> + <!-- Declare a LineArrowAnnotation at X1,X2,Y1,Y2 --> + <!-- NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis --> + <s:LineArrowAnnotation X1="1" X2="2" Y1="3" Y2="4" + HeadWidth="8.0" + HeadLength="4.0" + Stroke="Orange" StrokeThickness="2" StrokeDashArray="2 2" + AnnotationCanvas="AboveChart" + IsSelected="False" + IsEditable="False" + XAxisId="DefaultAxisId" + YAxisId="DefaultAxisId" /> + </s:SciChartSurface.Annotations> + </s:SciChartSurface> + </code> + <code title="LineArrowAnnotation Example" description="Shows how to create and add a LineArrowAnnotation to a SciChartSurface in Code" lang="cs"> + var sciChartSurface = new SciChartSurface(); + sciChartSurface.XAxis = new NumericAxis() { Id = "DefaultAxisId" }; + sciChartSurface.YAxis = new NumericAxis() { Id = "DefaultAxisId" }; + + // Declare a LineArrowAnnotation at X1,X2,Y1,Y2 + // NOTE: XAxisId and YAxisId are optional if you use default Ids on a single X,Y Axis + sciChartSurface.Annotations.Add(new LineArrowAnnotation() + { + X1 = 1, X2 = 2, Y1 = 3, Y2 = 4, + HeadLength = 4.0, + HeadWidth = 8.0, + Stroke = new SolidColorBrush(Colors.Orange), + StrokeThickness = 2, + StrokeDashArray = new DoubleCollection(new double[] { 2, 2 }), + AnnotationCanvas = AnnotationCanvas.AboveChart, + IsSelected = false, + IsEditable = false, + XAxisId = "DefaultAxisId", + YAxisId = "DefaultAxisId", + }); + </code> + </example> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.HeadLengthProperty"> + <summary> + Defines the HeadLength DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.HeadWidthProperty"> + <summary> + Defines the HeadWidth DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.HeadLength"> + <summary> + Gets or sets the Head Length in pixels. Change this along with <see cref="P:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.HeadWidth" /> to make the line-arrow head larger or smaller + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.HeadWidth"> + <summary> + Gets or sets the Head Length in pixels. Change this along with <see cref="P:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.HeadLength" /> to make the line-arrow head larger or smaller + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.LineArrowAnnotation.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.SeriesValueAxisMarkerAnnotation"> + <summary> + Used by <see cref="T:SciChart.Charting.ChartModifiers.SeriesValueModifier" /> to create AxisMarkers which are bound to the series latest Y value in a viewport. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.SeriesValueAxisMarkerAnnotation.#ctor"> + <summary> + Initializes a new <see cref="T:SciChart.Charting.Visuals.Annotations.SeriesValueAxisMarkerAnnotation" /> instance. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.TextAnnotation"> + <summary> + Defines a Text annotation, which may be used to place read-only labels or read-write Textboxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TextAnnotation.CornerRadiusProperty"> + <summary>Defines the CornerRadius DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TextAnnotation.TextProperty"> + <summary>Defines the Text DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TextAnnotation.TextAlignmentProperty"> + <summary>Defines the TextAlignment DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.TextAnnotation.TextStretchProperty"> + <summary>Defines the TextStretch DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TextAnnotation.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.TextAnnotation.CornerRadius"> + <summary> + Gets or sets the CornerRadius of the TextAnnotation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.TextAnnotation.TextAlignment"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Annotations.TextAnnotation.TextAlignment" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.TextAnnotation.Text"> + <summary> + Gets or sets the Text of the TextAnnotation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TextAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TextAnnotation.FocusInputTextArea"> + <summary> + Focuses the text input area on the <see cref="T:SciChart.Charting.Visuals.Annotations.TextAnnotation" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TextAnnotation.RemoveFocusInputTextArea"> + <summary> + Remove focus from input text area. Applicable only for Text and label annotation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TextAnnotation.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.TrendLineAnnotationBase.ToCoordinate(System.IComparable,System.Double,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.XyDirection)"> + <summary> + Converts a Data-Value to Pixel Coordinate + </summary> + <param name="dataValue">The Data-Value to convert</param> + <param name="canvasMeasurement">The size of the canvas in the X or Y direction</param> + <param name="coordCalc">The current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1">Coordinate Calculator</see></param> + <param name="direction">The X or Y direction for the transformation</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.VerticalAnchorPoint"> + <summary> + Enumeration constants used by <see cref="T:SciChart.Charting.Visuals.Annotations.IAnchorPointAnnotation" /> to define vertical alignment around the X1,Y1 coordinates + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.VerticalAnchorPoint.Top"> + <summary> + Align Top + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.VerticalAnchorPoint.Center"> + <summary> + Align Center + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.VerticalAnchorPoint.Bottom"> + <summary> + Align Bottom + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation"> + <summary> + A class for <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.VerticalAlignmentProperty"> + <summary> + Defines the VerticalAlignment Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.LabelsOrientationProperty"> + <summary> + Defines the LabelDirection Property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.#ctor"> + <summary> + Creates new instance of <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.LabelsOrientation"> + <summary> + Gets or sets value, indicating whether labels will be placed vertically or horizontally + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.VerticalAlignment"> + <summary> + Gets or sets docking of <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.GetUsedAxis"> + <summary> + Returns axis, which current annotation shows data value for + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.ApplyPlacement(SciChart.Charting.Visuals.Annotations.AnnotationLabel,SciChart.Charting.Visuals.Annotations.LabelPlacement)"> + <summary> + Positions the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationLabel" /> using the value of the <see cref="T:SciChart.Charting.Visuals.Annotations.LabelPlacement" /> enum + </summary> + <param name="label">The label to place</param> + <param name="placement">Placement arguments</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.GetSelectedCursor"> + <summary> + Gets the <see cref="T:System.Windows.Input.Cursor" /> to use for the annotation when selected + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.MoveBasePointTo(System.Windows.Point,System.Int32,SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally to marshal pixel points to X1,Y1,X2,Y2 values. + Taking a pixel point (<paramref name="newPoint" />) and base point <paramref name="index" />, sets the X,Y data-values. + </summary> + <param name="newPoint">The pixel point</param> + <param name="index">The base point index, where 0, 1, 2, 3 refer to the four corners of an Annotation</param> + <param name="xAxis">The current X-Axis</param> + <param name="yAxis">The current Y-Axis</param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation.GetPropertiesFromIndex(System.Int32,System.Windows.DependencyProperty@,System.Windows.DependencyProperty@)"> + <summary> + Used internally to derive the X1Property, Y1Property, X1Property, Y2Property pair for the given index around the annotation.. + + e.g. index 0 returns X1,Y1 + index 1 returns X2,Y1 + index 2 returns X2,Y2 + index 3 returns X1,Y2 + </summary> + <param name="index">The index</param> + <param name="x">The X coordinate dependency property, either X1Property or X2Property</param> + <param name="y">The Y coordinate dependency property, either Y1Property or Y2Property</param> + </member> + <member name="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection"> + <summary> + Contains a collection of <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotation" /> instances, which allow custom vertical lines + over or under the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection.#ctor"> + <summary> + Creates a new instance of the <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection.UnsubscribeInnerCollection"> + <summary> + Removes event handlers and clears the reference for the internal collection. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection.ClearItems"> + <summary> + Clears the items in the collection. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection.GetSchema"> + <summary> + Returns XML representation of the current <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> instance. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.Annotations.VerticalLineAnnotationCollection" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AutoRange"> + <summary> + Provides values which defines autorange behavior for <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> implementers. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AutoRange.Once"> + <summary> + Allows the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance decide whether autorange or not when show <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> first time, e.g. if the current VisibleRange is null or undefined + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AutoRange.Always"> + <summary> + Autorange the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance always. In this case zooming is not allowed by user. Only AxisDragModifier UI interaction is allowed. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AutoRange.Never"> + <summary> + Never autoranges the the <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisAlignment"> + <summary> + Enumeration constants to define the alignment of an axis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Right"> + <summary> + Axis is on the Right-side of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Left"> + <summary> + Axis is on the Left-side of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Top"> + <summary> + Axis is on the Top-edge of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Bottom"> + <summary> + Axis is on the Bottom-edge of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Default"> + <summary> + Axis is on the Bottom-edge of the chart surface + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisArea"> + <summary> + Provides a container for Axis within the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. Styled by control template + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisArea.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.AxisArea" /> class. + </summary> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1"> + <summary> + Provides base class for drawing axis bands. + See <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisBandsProvider" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.AxisBands"> + <summary> + Gets a collection of custom axis bands. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.DrawAxisBands(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.DrawCustomAxisBands(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Draws a collection of custom axis bands <see cref="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.AxisBands" />. + See <see cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo`1" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.CoerceBandRange(`0,`0)"> + <summary> + Called to clip band range if it exceeds current <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.GetAxisBandsFor(`0)"> + <summary> + Called to obtain colors and ranges for axis bands in a viewport. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1.DrawAxisBand(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo{`0},System.Windows.Point,System.Windows.Point,SciChart.Drawing.Common.IBrush2D)"> + <summary> + Called to draw one axis band. + </summary> + <param name="renderContext">Drawing context used to draw on a <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurface" />.</param> + <param name="axisBandInfo">Contains information about the axis band.</param> + <param name="pt1">Top-left corner of the axis band.</param> + <param name="pt2">Bottom-right corner of the axis band.</param> + <param name="fillBrush">Brush to fill the axis band.</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.DateTimeAxisBandsProvider"> + <inheritdoc cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.DateTimeAxisBandsProvider.CoerceBandRange(SciChart.Data.Model.DateRange,SciChart.Data.Model.DateRange)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.TimeSpanAxisBandsProvider"> + <inheritdoc cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1" /> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.NumericAxisBandsProvider"> + <inheritdoc cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandsProviderBase`1" /> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo.BandRange"> + <summary> + Gets a range of the axis band. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo.BandColor"> + <summary> + Gets a color of the axis band. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo`1"> + <summary> + Provides an interface for types that can store additional info about axis bands. + </summary> + <typeparam name="T">Any type that implements <see cref="T:SciChart.Data.Model.IRange" /></typeparam> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo`1.BandRange"> + <summary> + Gets a range of the axis band. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandInfo`1"> + <inheritdoc cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandInfo`1" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandInfo`1.#ctor(`0,System.Windows.Media.Color)"> + <summary> + Initializes an instance of <see cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandInfo`1" />. + </summary> + <param name="bandRange"></param> + <param name="bandColor"></param> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandInfo`1.SciChart#Charting#Visuals#Axes#AxisBandProviders#IAxisBandInfo#BandRange"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandInfo`1.BandRange"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.AxisBandInfo`1.BandColor"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandsProvider"> + <summary> + Provides an interface for drawing custom axis bands. + See <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisBandsProvider" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandsProvider.ParentAxis"> + <summary> + Gets the axis current provider instance was initialized with. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandsProvider.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the provider instance is initialized as it is attached to the parent axis, with the parent axis instance. + </summary> + <param name="parentAxis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxisCore" /> instance.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandsProvider.DrawAxisBands(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + Called by <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> to draw axis bands. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisBase"> + <summary> + Provides base functionality for Axes throughout SciChart. Derived types include <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" />, which supports any + numeric value, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" />, which supports Date values. Axes may be styled, see the <see href="http://www.scichart.com/tutorials">tutorials</see> for more details + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeChangedCommandProperty"> + <summary> + Defines the VisibleRangeChangedCommand DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.IsPrimaryAxisProperty"> + <summary> + Defines the IsPrimaryAxis DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.IsCenterAxisProperty"> + <summary> + Defines the IsCenterAxis DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeLimitProperty"> + <summary> + Defines the VisibleRangeLimit DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeLimitModeProperty"> + <summary> + Defines the VisibleRangeLimitMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.OrientationProperty"> + <summary> + Defines the Orientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignmentProperty"> + <summary> + Defines the AxisAlignment DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.TitleFontWeightProperty"> + <summary> + Defines the TitleFontWeight DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.TitleFontSizeProperty"> + <summary> + Defines the TitleFontWeight DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.ScrollbarProperty"> + <summary> + Defines the Axis ScrollBar + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.IsLabelCullingEnabledProperty"> + <summary> + Defines the IsLabelCullingEnabled DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.AutoFitMarginalLabelsProperty"> + <summary> + Defines the AutoFitMarginalLabels DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.AxisBandsProviderProperty"> + <summary> + Defines the AxisBandsProvider DependencyProperty. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.AxisBase.Arranged"> + <summary> + Event raised immediately after the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> measures itself + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.AxisBase.DataRangeChanged"> + <summary> + Raised when data range is changed + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase._currentCoordinateCalculator"> + <summary> + The current CoordinateCalculator for this render pass + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase._currentInteractivityHelper"> + <summary> + The current InteractivityHelper for this render pass + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisBase.MinDistanceToBounds"> + <summary> + Defines the minimum distance to the edge of the chart to cull axis labels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisBandsProvider"> + <summary> + Gets or sets an object of type <see cref="T:SciChart.Charting.Visuals.Axes.AxisBandProviders.IAxisBandsProvider" /> + that determines where and how axis bands appear. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.IsHorizontalAxis"> + <summary> + Gets whether the current axis is horizontal or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.IsAxisFlipped"> + <summary> + Gets whether the current axis is flipped (e.g. YAxis on the bottom or top, or XAxis on the left or right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.IsLabelCullingEnabled"> + <summary> + Gets or sets a value indicating whether Label Culling is enabled (when labels overlap) on this AxisPanel instance + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.AutoFitMarginalLabels"> + <summary> + Gets or sets a value indicating whether marginal labels get shifted to fit inside an axis when too long. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.IsCenterAxis"> + <summary> + Gets or sets whether current Axis should placed in the center of chart or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.IsPrimaryAxis"> + <summary> + Gets or sets whether current Axis is the main one in axis collection + </summary> + <remarks>Primary axis determinate coordinate grid</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.SciChart#Charting#Visuals#IDrawable#Width"> + <summary> + Gets or sets the width of the element. + </summary> + <returns>The width of the element, in device-independent units (1/96th inch per unit). The default value is <see cref="F:System.Double.NaN" />. This value must be equal to or greater than 0.0. See Remarks for upper bound information.</returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.SciChart#Charting#Visuals#IDrawable#Height"> + <summary> + Gets or sets the suggested height of the element. + </summary> + <returns>The height of the element, in device-independent units (1/96th inch per unit). The default value is <see cref="F:System.Double.NaN" />. This value must be equal to or greater than 0.0. See Remarks for upper bound information.</returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Axis is associated with + </summary> + <value>The parent surface.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.TitleFontWeight"> + <summary> + Gets or sets the Axis Title Font Weight + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.TitleFontSize"> + <summary> + Gets or sets the Axis Title Font Size + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.Orientation"> + <summary> + Gets or sets the Axis Orientation, e.g. Horizontal (XAxis) or Vertical (YAxis) + </summary> + <value>The orientation.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignment"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignment" /> for this Axis. Default is Right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.StrokeThickness"> + <summary> + Gets or sets the stroke thickness. + </summary> + <value>The stroke thickness.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.Scrollbar"> + <summary> + Gets or Sets Axis ScrollBar + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.ModifierAxisCanvas"> + <summary> + Gets the ModifierAxisCanvas, which may be used to overlay markers on the canvas + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.RenderSurface"> + <summary> + Get the <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.RenderSurface" /> instance off the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.IsPolarAxis"> + <summary> + Gets a value indicating whether this instance is a polar axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeLimit"> + <summary> + Gets or sets the VisibleRangeLimit of the Axis. This will be used to clip the axis during ZoomExtents and AutoRange operations + </summary> + <value>The visible range.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeLimitMode"> + <summary> + Gets or setts the VisibleRangeLimitMode of the Axis. This property defines which parts of <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeLimit" /> will be used by axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.VisibleRangeChangedCommand"> + <summary> + Gets or sets the command to invoke when the VisibleRange is changed. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisBase.DataRange"> + <summary> + Gets the DataRange (full extents of the data) of the Axis. + </summary> + <value>The data range</value> + <remarks>Note: The performance implications of calling this is axis will perform a full recalculation on each get. + It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Gets the aligned VisibleRange of the axis, with optional ZoomToFit flag. + If ZoomToFit is true, it will return the DataRange plus any GrowBy applied to the axis + </summary> + <param name="renderPassInfo">Struct containing data for the current render pass</param> + <returns>The VisibleRange of the axis</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.CalculateDataRange"> + <summary> + Calculates data range of current axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetWindowedYRange(System.Collections.Generic.IDictionary{System.String,SciChart.Data.Model.IRange})"> + <summary> + Returns the max range only for that axis (by the data-series on it), based on <paramref name="xRanges" /> + "windowed" = "displayed in current viewport" + uses GrowBy() + </summary> + <param name="xRanges">Calculates the max range based on corresponding x ranges</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Scroll(System.Double,SciChart.Charting.ClipMode)"> + <summary> + Scrolls current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> by the specified number of pixels + </summary> + <param name="pixelsToScroll">Scroll N pixels from the current visible range</param> + <param name="clipMode">Defines how scrolling behaves when you reach the edge of the Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Scroll(SciChart.Data.Model.IRange,System.Double,SciChart.Charting.ClipMode)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels + </summary> + <param name="startVisibleRange">The start visible range</param> + <param name="pixelsToScroll">Scroll N pixels from the start visible range</param> + <param name="clipMode">Defines how scrolling behaves when you reach the edge of the Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Scroll(System.Double,SciChart.Charting.ClipMode,System.TimeSpan)"> + <summary> + Scrolls current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> by the specified number of pixels with the specified animation duration + </summary> + <param name="pixelsToScroll">Scroll N pixels from the current visible range</param> + <param name="clipMode">Defines how scrolling behaves when you reach the edge of the Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside</param> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ScrollByDataPoints(System.Int32)"> + <summary> + Translates current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> by the specified number of datapoints + </summary> + <param name="pointAmount">Amount of data points that the start visible range is scrolled by</param> + <remarks> + For XAxis only, is suitable for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + where data is regularly spaced + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ScrollByDataPoints(System.Int32,System.TimeSpan)"> + <summary> + Translates current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> by the specified number of datapoints with the specified animation duration + </summary> + <param name="pointAmount">Amount of points that the start visible range is scrolled by</param> + <param name="duration">The duration of animation when zooming to extents</param> + <exception cref="T:System.InvalidOperationException">ScrollXRange is only valid on the CategoryDateTimeAxis</exception> + <remarks> + For XAxis only, is suitable for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + where data is regularly spaced + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Zoom(System.Double,System.Double)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="fromCoord" /> as a coordinate of new range start and + <paramref name="toCoord" /> as a coordinate of new range end + </summary> + <param name="fromCoord">The coordinate of new range start in pixels</param> + <param name="toCoord">The coordinate of new range end in pixels</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Zoom(System.Double,System.Double,System.TimeSpan)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="fromCoord" /> as a coordinate of new range start and + <paramref name="toCoord" /> as a coordinate of new range end + </summary> + <param name="fromCoord">The coordinate of new range start in pixels</param> + <param name="toCoord">The coordinate of new range end in pixels</param> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ZoomBy(System.Double,System.Double)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="minFraction" /> as a multiplier of range start and + <paramref name="maxFraction" /> as a multiplier of range end + </summary> + <param name="minFraction">The multiplier of range start</param> + <param name="maxFraction">The multiplier of range end</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ZoomBy(System.Double,System.Double,System.TimeSpan)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="minFraction" /> as a multiplier of range start and + <paramref name="maxFraction" /> as a multiplier of range end + </summary> + <param name="minFraction">The multiplier of range start</param> + <param name="maxFraction">The multiplier of range end</param> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ScrollTo(SciChart.Data.Model.IRange,System.Double)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels + </summary> + <param name="startVisibleRange">The start visible range</param> + <param name="pixelsToScroll">Scroll N pixels from the start visible range</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ScrollToWithLimit(SciChart.Data.Model.IRange,System.Double,SciChart.Data.Model.IRange)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels, with the specified range limit + </summary> + <param name="startVisibleRange">The start visible range</param> + <param name="pixelsToScroll">Scroll N pixels from the start visible range</param> + <param name="rangeLimit">The range limit.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.AssertDataType(System.Type)"> + <summary> + Asserts the type passed in is supported by the current axis implementation + </summary> + <param name="dataType"></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetSupportedTypes"> + <summary> + Returns a list of types which current axis is designed to work with + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.SetMouseCursor(System.Windows.Input.Cursor)"> + <summary> + Sets the cursor for this Axis + </summary> + <param name="cursor">The Cursor instance</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.Clear"> + <summary> + Clears axis labels, ticks off this axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.SciChart#Charting#Visuals#Axes#IAxis#GetModifersAxisLabel(System.Func{SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl})"> + <summary> + Returns the axis label for corresponding modifier to place it on axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.SciChart#Charting#Visuals#Axes#IAxis#CacheModifersAxisLabel(System.Action{SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl},SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresopngin axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.SciChart#Charting#Visuals#Axes#IAxis#GetModifersAxisLabelTempalte(System.Func{SciChart.Charting.Visuals.Axes.AxisBase,System.Windows.DataTemplate})"> + <summary> + Returns the axis label template for corresponding modifier + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.SciChart#Charting#Visuals#Axes#IAxis#GetModifersAxisLabelStyle(System.Func{SciChart.Charting.Visuals.Axes.AxisBase,System.Windows.Style})"> + <summary> + Returns the axis label style for corresponding modifier + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetCurrentInteractivityHelper"> + <summary> + Returns the current <see cref="T:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper" />, valid for the current render pass, which may be used to + interact with the axis (Scroll, Zoom, Pan). + </summary> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper" /> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetCurrentCoordinateCalculator"> + <summary> + Gets the current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> for this Axis, based on current Visible Range and axis type + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.CoerceVisibleRange(SciChart.Data.Model.IRange)"> + <summary> + When overridden in derived classes, changes value of the VisibleRange according to axis requirements + before it is applied + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.IsVisibleRangeConstrained(SciChart.Data.Model.IRange)"> + <summary> + Checks whether the current <see cref="!:VisibleRange" /> meets <see cref="!:MinimalZoomConstrain" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetAxisSize"> + <summary> + Gets the size of the axis in the Viewport + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.OnBeginRenderPass"> + <summary> + Called internally immediately before a render pass begins + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetAxisOffset"> + <summary> + Returns the offset of the axis relative to the <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.RenderSurface" />. + Is used for cases where axes are vertically or horizontally stacked. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.HitTest(System.Windows.Point)"> + <summary> + Performs a hit test on the Axis, returning the Data Value at the specific x or y pixel coordinate. This operation is the opposite of <see cref="M:SciChart.Charting.Visuals.Axes.AxisCore.GetCoordinate(System.IComparable)" /></summary> + <remarks>If the Axis is an XAxis, the coordinate passed in is an X-pixel. If the axis is a Y Axis, the coordinate is a Y-pixel</remarks> + <param name="atPoint">The pixel coordinate on this Axis corresponding to the input DataValue</param> + <returns>An <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> struct containing the datavalue and formatted data value at this coordinate</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.HitTest(System.IComparable)"> + <summary> + Performs a HitTest operation on the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />. The supplied <paramref name="dataValue" /> is used to convert to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> struct, which contains information about the axis, as well as formatted values + </summary> + <param name="dataValue">The data value.</param> + <returns>The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> result</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.FormatText(System.IComparable,System.String)"> + <summary> + String formats the text, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <param name="format">A composite format string</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.FormatText(System.IComparable)"> + <summary> + String formats the text, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.FormatCursorText(System.IComparable)"> + <summary> + String formats text for the cursor, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current HitTestable element + </summary> + <param name="point">The point to test</param> + <returns>true if the Point is within the bounds</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other hittestable element + </summary> + <param name="point">The point.</param> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current HitTestable element relative to another HitTestable element + </summary> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called when the instance is drawn + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> used for drawing</param> + <param name="renderPassData">Contains arguments and parameters for this render pass</param> + <seealso cref="T:SciChart.Charting.Visuals.IDrawable" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.IsValidForDrawing"> + <summary> + Gets a value indicating whether this axis is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + Called internal to draw gridlines before Axis drawing + </summary> + <remarks></remarks> + </member> + <!-- Badly formed XML comment ignored for member "M:SciChart.Charting.Visuals.Axes.AxisBase.OnTickOrGridLineStyleChanged" --> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,SciChart.Charting.XyDirection,System.Single)"> + <summary> + Draws a single grid line on the <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.RenderSurface" />, using the specified Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), <see cref="T:SciChart.Charting.XyDirection" /> and integer coordinate. + </summary> + <remarks>If direction is <see cref="F:SciChart.Charting.XyDirection.XDirection" />, the coodinate is an X-coordinate, else it is a Y-coordinate</remarks> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance to draw to</param> + <param name="linePen">The pen (TargetType <see cref="T:SciChart.Drawing.Common.IPen2D" />) to apply to the grid line</param> + <param name="direction">The X or Y direction to draw the </param> + <param name="atPoint">The integer coordinate to draw at. If direction is <see cref="F:SciChart.Charting.XyDirection.XDirection" />, the coodinate is an X-coordinate, else it is a Y-coordinate</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.OnDrawAxis(SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + Called when the axis should redraw itself. + </summary> + <param name="tickCoords"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetOffsetForLabels"> + <summary> + Returns an offset for the axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.DrawTickLabels(SciChart.Charting.Themes.AxisCanvas,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,System.Single)"> + <summary> + Draws the ticks and gridlines during a render pass + </summary> + <param name="canvas">The canvas to draw labels on.</param> + <param name="tickCoords">The tick coords containing all coordinates for ticks and gridlines.</param> + <param name="offset"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ConvertTickToDataValue(System.IComparable)"> + <summary> + When overridden in a derived class, converts a tick value to a data value. For instance, this may be overridden in the + <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> to convert between indices and DateTimes + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetMajorTickIndex(System.Double)"> + <summary> + Returns major tick index e.g value 0 has index #0, 0 + MajorDelta - #1, 0 + 2*MajorDelta - #2 etc... + </summary> + <param name="tick"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.OnApplyTemplate" />. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.OnVisibleRangeChanged(SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs)"> + <summary> + Raises the VisibleRangeChanged event + </summary> + <param name="args">The <see cref="T:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs" /> containing event data</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.InvalidateParent(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Provides a DependencyProperty callback which invalidates the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="d"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.InvalidateParentSurface"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisBase.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisCore"> + <summary> + A shared class for 2D and 3D Axis types throughout the SciChart SDK + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TickCoordinatesProviderProperty"> + <summary> + Defines the TickCoordinatesProvider DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.IsStaticAxisProperty"> + <summary> + Defines the IsStaticAxis DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MajorDeltaProperty"> + <summary> + Defines the MajorDelta DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MinorDeltaProperty"> + <summary> + Defines the MinorDelta DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MinorsPerMajorProperty"> + <summary> + Defines the MinorDelta DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.GrowByProperty"> + <summary> + Defines the GrowBy DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRangeProperty"> + <summary> + Defines the VisibleRange DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.AnimatedVisibleRangeProperty"> + <summary> + Defines the Animated VisibleRange DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRangePointProperty"> + <summary> + Defines the VisibleRangePoint DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MaxAutoTicksProperty"> + <summary> + Defines the MaxAutoTicks DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.AutoTicksProperty"> + <summary> + Defines the AutoTicks DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TextFormattingProperty"> + <summary> + Defines the TextFormatting DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TickTextBrushProperty"> + <summary> + Defines the TickTextBrush DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormattingProperty"> + <summary> + Defines the CursorTextFormatting DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.AxisTitleProperty"> + <summary> + Defines the AxisTitle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.AxisTitleOffsetProperty"> + <summary> + Defines the AxisTitleOffset DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TickLabelsOffsetProperty"> + <summary> + Defines the TickLableOffset DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicksProperty"> + <summary> + Defines the DrawMajorTicks DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicksProperty"> + <summary> + Defines the DrawMinorTicks DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabelsProperty"> + <summary> + Defines the DrawLabels DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TitleStyleProperty"> + <summary> + Defines the TitleStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MinimalZoomConstrainProperty"> + <summary> + Defines the MinimalZoomConstrain DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MajorTickLineStyleProperty"> + <summary> + Defines the MajorTickLineStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MinorTickLineStyleProperty"> + <summary> + Defines the MinorTickLineStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MajorGridLineStyleProperty"> + <summary> + Defines the MajorGridLineStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.MinorGridLineStyleProperty"> + <summary> + Defines the MinorGridLineStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLinesProperty"> + <summary> + Defines the DrawMajorGridLines DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLinesProperty"> + <summary> + Defines the DrawMinorGridLines DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBandsProperty"> + <summary> + Defines the DrawMajorBands DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.AxisBandsFillProperty"> + <summary> + Defines the AxisBandsFill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TickLabelStyleProperty"> + <summary> + Defines the AutoTicks DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.FlipCoordinatesProperty"> + <summary> + Defines the FlipCoordinates DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.AutoRangeProperty"> + <summary> + Defines the AutoRange DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.TickProviderProperty"> + <summary> + Defines the TickProvider DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.LabelProviderProperty"> + <summary> + Defines the LabelFormatter DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DefaultLabelProviderProperty"> + <summary> + Defines the DefaultFormatter DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.ZeroRangeGrowBy"> + <summary> + Gets GrowBy Min and Max which applied to VisibleRange if VisibleRange.Min == VisibleRAnge.Max + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.IdProperty"> + <summary> + Defines the Id DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisCore.DefaultAxisId"> + <summary> + The Default Axis Id for new Axes + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRangeChanged"> + <summary> + Raised when the VisibleRange is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.AxisCore.PropertyChanged"> + <summary> + Raised when properties are changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.AxisCore" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.AxisTitle"> + <summary> + Gets or sets the Axis Title + </summary> + <value>The axis title.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.AxisTitleOffset"> + <summary> + Gets or sets an offset of the title to axis plane. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TickLabelsOffset"> + <summary> + Gets or sets an offset of a tick labels to axis plane. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.FlipCoordinates"> + <summary> + Gets or sets a flag indicating whether to flip the tick and pixel coordinate generation for this axis, causing the axis ticks to decrement and chart to be flipped in the axis direction + </summary> + <value> + If <c>true</c> reverses the ticks and coordinates for the axis. + </value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TitleStyle"> + <summary> + Gets or sets the Style of the Axis Title + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting"> + <summary> + Gets or sets the Text Formatting String for Tick Labels on this axis + </summary> + <value>The text formatting.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TickTextBrush"> + <summary> + Gets or sets the tick text brush applied to text labels + </summary> + <value>The tick text brush</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.IsCategoryAxis"> + <summary> + Gets a value indicating whether this instance is a category axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.SciChart#Charting#Visuals#Axes#IAxisCore#IsXAxis"> + <summary> + Gets whether the current axis is an X-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.IsXAxis"> + <summary> + Gets whether the current axis is an X-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy"> + <summary> + Gets or sets the GrowBy Factor. e.g. GrowBy(0.1, 0.2) will increase the axis extents by 10% (min) and 20% (max) outside of the data range + </summary> + <value>The grow by factor as a DoubleRange.</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta"> + <summary> + Gets or sets the Major Delta + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> instance, which may be used to programmatically override the formatting of text and cursor labels. + For examples, see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DefaultLabelProvider" /> and <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DefaultLabelProvider"> + <summary> + Gets the default <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> instance. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta"> + <summary> + Gets or sets the Minor Delta + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorsPerMajor"> + <summary> + Gets or sets the number of Minor Delta ticks per Major Tick + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MaxAutoTicks"> + <summary> + Gets or sets the max ticks. + </summary> + <value>The max ticks.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.AutoTicks"> + <summary> + Gets or sets value, that indicates whether calculate ticks automatically. Default is True. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorTickLineStyle"> + <summary> + Gets or sets the Major Tick Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all major ticks on this axis + </summary> + <value>The major tick line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorTickLineStyle"> + <summary> + Gets or sets the Minor Tick Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all minor ticks on this axis + </summary> + <value>The minor tick line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorGridLineStyle"> + <summary> + Gets or sets the Major Grid Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all major gridlines drawn by this axis + </summary> + <value>The major grid line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorGridLineStyle"> + <summary> + Gets or sets the Minor Grid Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all minor gridlines drawn by this axis + </summary> + <value>The minor grid line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks"> + <summary> + If True, draws Minor Tick Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels"> + <summary> + If True, draw labels for each major tick on the Axis, else skips this step + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks"> + <summary> + If True, draws Major Tick Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines"> + <summary> + If True, draws Major Grid Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines"> + <summary> + If True, draws Minor Grid Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands"> + <summary> + If True, draws Major Axis Bands (a filled area between major gridlines), else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.AxisBandsFill"> + <summary> + Gets or sets the Fill of the Axis Bands. Also see <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" /> to enable this behaviour + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.AutoRange"> + <summary> + Gets or sets AutoRange Mode + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TickProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Numerics.TickProviders.ITickProvider" /> instance on current axis, + which is used to compute the data-values of Axis Gridlines, Ticks and Labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.AnimatedVisibleRange"> + <summary> + Gets or sets the animated VisibleRange of the Axis. + When this property is set, the axis animates the VisibleRange to the new value over a duration of 500ms + </summary> + <value>The visible range.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange"> + <summary> + Gets or sets the VisibleRange of the Axis. + </summary> + <value>The visible range.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TickLabelStyle"> + <summary> + Gets or sets a style for the labels on this Axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting"> + <summary> + Gets or sets the Text Formatting String for Labels on this cursor + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance and shared between various scichart components throughout the surface instance. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.IsLogarithmicAxis"> + <summary> + Gets a value indicating whether this instance is a logarithmic axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.HasValidVisibleRange"> + <summary> + Gets whether the VisibleRange is valid, e.g. is not null, is not NaN and the difference between Max and Min is not zero + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.HasDefaultVisibleRange"> + <summary> + Gets whether the VisibleRange has default value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.TickCoordinatesProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Numerics.CoordinateProviders.ITickCoordinatesProvider" /> instance on current axis, + which is used to transform the data-values received from the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisCore.TickProvider" /> instance + to the coordinates for Axis Gridlines, Ticks and Labels drawing. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.IsStaticAxis"> + <summary> + Gets or sets whether current Axis is a static axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.AxisCore.Id"> + <summary> + Gets or sets the string Id of this axis. Used to associate RenderableSeries, ChartModifiers and Annotations + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns>The disposable Update Suspender</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is valid visible range for this axis + </summary> + <param name="range"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.ValidateAxis"> + <summary> + Called to check if the axis properties are valid for rendering. Will throw an exception if not + </summary> + <exception cref="T:System.InvalidOperationException">Thrown if any property is invalid for drawing</exception> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetCurrentCoordinateCalculator"> + <summary> + Gets the current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> for this Axis, based on current Visible Range and axis type + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetAxisSize"> + <summary> + Gets the size of the axis in the Viewport + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetAxisOffset"> + <summary> + Returns the offset of the Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetDataValue(System.Double)"> + <summary> + Transforms a pixel coordinate into a data value for this axis. + </summary> + <param name="pixelCoordinate"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetCoordinate(System.IComparable)"> + <summary> + Given the Data Value, returns the x or y pixel coordinate at that value on the Axis. This operation is the opposite of <see cref="M:SciChart.Charting.Visuals.Axes.AxisBase.HitTest(System.Windows.Point)" /></summary> + <remarks>If the Axis is an XAxis, the coordinate returned is an X-pixel. If the axis is a Y Axis, the coordinate returned is a Y-pixel</remarks> + <param name="value">The DataValue as input</param> + <returns>The pixel coordinate on this Axis corresponding to the input DataValue</returns> + <example> + Given an axis with a VisibleRange of 1..10 and height of 100, a value of 7 passed in to GetCoordinate would return 70 pixels + </example> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.AnimateVisibleRangeTo(SciChart.Data.Model.IRange,System.TimeSpan,System.Action)"> + <summary> + Animates the visible range of the axis to the destination VisibleRange, over the specified Duration. + Also see <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.AnimatedVisibleRange" /> property which has a default duration of 500ms + </summary> + <param name="to">The end range</param> + <param name="duration">The duration of the animation.</param> + <param name="onCompleted">Completed callback when animation stops</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is not Null and is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.OnDependencyPropertyChanged"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <!-- Badly formed XML comment ignored for member "M:SciChart.Charting.Visuals.Axes.AxisCore.OnTickOrGridLineStyleChanged" --> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.OnIdChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.CoerceVisibleRange(SciChart.Data.Model.IRange)"> + <summary> + When overridden in derived classes, changes value of the VisibleRange according to axis requirements + before it is applied + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.CalculateTicks"> + <summary> + Overridden by derived types, called internal to calculate MinorTicks, MajorTicks before Axis drawing + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.CalculateDelta"> + <summary> + Calculates the deltas for use in this render pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.GetMaxAutoTicks"> + <summary> + Calculates max auto ticks amount, which is >= 1 + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.OnVisibleRangeChanged(SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs)"> + <summary> + Raises the VisibleRangeChanged event + </summary> + <param name="args">The <see cref="T:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs" /> containing event data</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.AssertRangeType(SciChart.Data.Model.IRange)"> + <summary> + Asserts the <see cref="T:SciChart.Data.Model.IRange" /> is of the correct type for this axis + </summary> + <param name="range">The range to assert</param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.IsVisibleRangeValid"> + <summary> + Checks if the VisibleRange is valid, e.g. is not null, is not NaN, the difference between Max and Min is positive + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.OnFlipCoordinatesChanged"> + <summary> + Called when the FlippedCoordinates DependencyProperty changes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.IsVisibleRangeConstrained"> + <summary> + Checks whether the current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> meets <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinimalZoomConstrain" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.OnPropertyChanged(System.String)"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.Axes.AxisCore.PropertyChanged" /> event, as part of <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisCore.CoerceZeroRange(SciChart.Data.Model.IRange)"> + <summary> + Coerce <seealso cref="T:SciChart.Data.Model.IRange" /> if current range is zero range + </summary> + <param name="maximumRange">Current maximum range</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisMode"> + <summary> + Defines constants for how Axes behave + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisMode.Linear"> + <summary> + The Axis is a Linear Axis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.AxisMode.Logarithmic"> + <summary> + The Axis is a Logarithmic Axis + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.AxisParams"> + <summary> + Defines constants for the current axis setup for this render pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisParams.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" /> is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisParams.Equals(SciChart.Charting.Visuals.Axes.AxisParams)"> + <summary> + Equals the specified other. + </summary> + <param name="other">The other.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.AxisParams.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns> + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis"> + <summary> + Provides a Linear, Category DateTime Axis, capable of rendering DateTime ticks on the X-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + The CategoryDateTimeAxis is specifically used in stock-charts or financial charts, since the category-nature of the axis automatically + collapses weekend gaps and overnight gaps in trading charts. + + Each data-point is treated as equidistant despite the X Data-value. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.BarTimeFrameProperty"> + <summary> + Defines the BarTimeFrame DependencyProperty. A default value of -1 allows the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> to estimate the time frame + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.SubDayTextFormattingProperty"> + <summary> + Defines the SubDayTextFormatting DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.ShowAxisOffsetsProperty"> + <summary>Defines the ShowAxisOffsets DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.ShowAxisOffsets"> + <summary> + Gets or sets to show data point width offset or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.SubDayTextFormatting"> + <summary> + Gets or sets the Text Formatting String used for Axis Tick Labels when the range of the axis is sub-day + </summary> + <value>The text formatting.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.BarTimeFrame"> + <summary> + Gets or sets the Bar Time Frame in seconds. This is the number of seconds that each data-point represents on the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> and is required for proper rendering. + A default value of -1 allows the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> to estimate the time frame + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.CurrentDatapointWidth"> + <summary> + Gets the current data-point width, which is the width of one data-point in pixels on the category axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.IsCategoryAxis"> + <summary> + Gets a value indicating whether this instance is category axis. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Calculates the zoom-to-fit Y-Range of the axis, accounting for the data that + is in the viewport and applying any GrowBy margin + </summary> + <param name="renderPassInfo">Struct containing data for the current render pass</param> + <returns> + The VisibleRange of the axis + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.CalculateDataRange"> + <summary> + Calculates data range of current axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.CalculateDelta"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetCoordinate(System.IComparable)"> + <summary> + Given the Data Value, returns the x or y pixel coordinate at that value on the Axis. This operation is the opposite of <see cref="M:SciChart.Charting.Visuals.Axes.AxisBase.HitTest(System.Windows.Point)" /></summary> + <param name="value">The DataValue as input</param> + <returns> + The pixel coordinate on this Axis corresponding to the input DataValue + </returns> + <example> + Given an axis with a VisibleRange of 1..10 and height of 100, a value of 7 passed in to GetCoordinate would return 70 pixels + </example> + <remarks> + If the Axis is an XAxis, the coordinate returned is an X-pixel. If the axis is a Y Axis, the coordinate returned is a Y-pixel + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetDataValue(System.Double)"> + <summary> + Transforms a pixel coordinate into a data value for this axis. + </summary> + <param name="pixelCoordinate"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.ConvertTickToDataValue(System.IComparable)"> + <summary> + When overridden in a derived class, converts a tick value to a data value. For instance, this may be overridden in the + <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> to convert between indices and DateTimes + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is valid visible range for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.OnBeginRenderPass"> + <summary> + Called internally immediately before a render pass begins + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.CoerceVisibleRange(SciChart.Data.Model.IRange)"> + <summary> + When overridden in derived classes, changes value of the VisibleRange according to axis requirements + before it is applied + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.ScrollByDataPoints(System.Int32,System.TimeSpan)"> + <summary> + Translates current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> by the specified number of data points with the specified animation duration + </summary> + <param name="pointAmount">Amount of points that the start visible range is scrolled by</param> + <param name="duration">The duration of animation when zooming to extents</param> + <exception cref="T:System.InvalidOperationException">ScrollXRange is only valid on the CategoryDateTimeAxis</exception> + <remarks> + For XAxis only, is suitable for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + where data is regularly spaced + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.ToDateRange(SciChart.Data.Model.IndexRange)"> + <summary> + Converts the CategoryDateTimeAxis's <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> of type <see cref="T:SciChart.Data.Model.IndexRange" /> to a <see cref="T:SciChart.Data.Model.DateRange" /> of concrete date-values. + Note: If either index is outside of the range of data on the axis, the date values will be interpolated. + </summary> + <param name="visibleRange">The input <see cref="T:SciChart.Data.Model.IndexRange" /></param> + <returns>The <see cref="T:SciChart.Data.Model.DateRange" /> with transformed dates that correspond to input indices</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis.GetSupportedTypes"> + <summary> + Returns a list of types which current axis is designed to work with + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis"> + <summary> + Provides a Linear, Category double Axis, capable of rendering double ticks on the X-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + The CategoryNumericAxis is specifically used in stock-charts or financial charts, since the category-nature of the axis automatically + collapses weekend gaps and overnight gaps in trading charts. + + Each data-point is treated as equidistant despite the X Data-value. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.ShowAxisOffsetsProperty"> + <summary>Defines the ShowAxisOffsets DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.ShowAxisOffsets"> + <summary> + Gets or sets to show data point width offset or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.CurrentDatapointWidth"> + <summary> + Gets the current data-point width, which is the width of one data-point in pixels on the category axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.IsCategoryAxis"> + <summary> + Gets a value indicating whether this instance is category axis. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Calculates the zoom-to-fit Y-Range of the axis, accounting for the data that + is in the viewport and applying any GrowBy margin + </summary> + <param name="renderPassInfo">Struct containing data for the current render pass</param> + <returns> + The VisibleRange of the axis + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.CalculateDataRange"> + <summary> + Calculates data range of current axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.CalculateDelta"> + <summary> + Calculates the delta's for use in this render pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetCoordinate(System.IComparable)"> + <summary> + Given the Data Value, returns the x or y pixel coordinate at that value on the Axis. This operation is the opposite of <see cref="M:SciChart.Charting.Visuals.Axes.AxisBase.HitTest(System.Windows.Point)" /></summary> + <param name="value">The DataValue as input</param> + <returns> + The pixel coordinate on this Axis corresponding to the input DataValue + </returns> + <example> + Given an axis with a VisibleRange of 1..10 and height of 100, a value of 7 passed in to GetCoordinate would return 70 pixels + </example> + <remarks> + If the Axis is an XAxis, the coordinate returned is an X-pixel. If the axis is a Y Axis, the coordinate returned is a Y-pixel + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetDataValue(System.Double)"> + <summary> + Transforms a pixel coordinate into a data value for this axis. + </summary> + <param name="pixelCoordinate"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.ConvertTickToDataValue(System.IComparable)"> + <summary> + When overridden in a derived class, converts a tick value to a data value. For instance, this may be overridden in the + <see cref="T:SciChart.Charting.Visuals.Axes.CategoryNumericAxis" /> to convert between indices and double + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is valid visible range for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.OnBeginRenderPass"> + <summary> + Called internally immediately before a render pass begins + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.CoerceVisibleRange(SciChart.Data.Model.IRange)"> + <summary> + When overridden in derived classes, changes value of the VisibleRange according to axis requirements + before it is applied + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.CategoryNumericAxis.GetSupportedTypes"> + <summary> + Returns a list of types which current axis is designed to work with + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DateTimeAxis"> + <summary> + Provides a Linear, Value DateTime Axis, capable of rendering DateTime ticks on the X-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DateTimeAxis.SubDayTextFormattingProperty"> + <summary> + Defines the SubDayTextFormatting DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.DateTimeAxis.SubDayTextFormatting"> + <summary> + Gets or sets the Text Formatting String used for Axis Tick Labels when the range of the axis is sub-day + </summary> + <value>The text formatting.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Calculates the zoom-to-fit Y-Range of the axis, accounting for the data that + is in the viewport and applying any GrowBy margin + </summary> + <param name="renderPassInfo">Struct containing data for the current render pass</param> + <returns> + The VisibleRange of the axis + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.CoerceZeroRange(SciChart.Data.Model.IRange)"> + <summary> + Coerce <seealso cref="T:SciChart.Data.Model.IRange" /> if current range is zero range + </summary> + <param name="maximumRange">Current maximum range</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.AssertDataType(System.Type)"> + <summary> + Asserts the type passed in is supported by the current axis implementation + </summary> + <param name="dataType"></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.ToVisibleRange(System.IComparable,System.IComparable)"> + <summary> + When overriden in a derived class, converts a Min Max <see cref="T:System.IComparable" /> value into an <see cref="T:SciChart.Data.Model.IRange" /> of the correct type for this axis + </summary> + <param name="min">The min value</param> + <param name="max">The max value</param> + <returns> + The <see cref="T:SciChart.Data.Model.IRange" /> instance + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.ConvertTickToDataValue(System.IComparable)"> + <summary> + When overridden in a derived class, converts a tick value to a data value. For instance, this may be overridden in the + <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> to convert between indices and DateTimes + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is not Null and is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DateTimeAxis.GetSupportedTypes"> + <summary> + Returns a list of types which current axis is designed to work with + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency"> + <summary> + Defines a set of values indicating the frequency of axis bands alternation. + See <see cref="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.AxisBandsFrequency" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency.Auto"> + <summary> + Chart background will alternate based on the top scale ticks frequency of <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency.Hourly"> + <summary> + Chart background will alternate on hourly basis. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency.Daily"> + <summary> + Chart background will alternate on daily basis. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency.Weekly"> + <summary> + Chart background will alternate on weekly basis. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency.Monthly"> + <summary> + Chart background will alternate on monthly basis. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.AxisBandsFrequency.Yearly"> + <summary> + Chart background will alternate on yearly basis. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis"> + <summary> + Provides a Value Discontinuous DateTime Axis, capable of rendering DateTime ticks on the X-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + The axis has two scales. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.DrawAxisScaleBandsProperty"> + <summary> + Defines the DrawAxisBands DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.AxisBandsFrequencyProperty"> + <summary> + Defines the AxisBandsFrequency DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.TopScaleLabelProviderProperty"> + <summary> + Defines the TopScaleLabelProvider DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.DrawAxisScaleBands"> + <summary> + Gets or sets a value indicating whether to fill regions between major ticks on axis scales with the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.AxisBandsFill" /> brush or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.AxisBandsFrequency"> + <summary> + Gets or sets a value that specifies the frequency of axis bands alternation. + See <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.TopScaleLabelProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> instance, which may be used to programmatically override the formatting of text and cursor labels. + The <see cref="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.TopScaleLabelProvider" /> is applied to the top scale of <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis" />. + </summary> + <remarks>To apply a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> to the bottom scale, please set the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property.</remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.OnApplyTemplate" />. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.OnCalendarChanged(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.CalculateDelta"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.GetMajorTickIndex(System.Double)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.CalculateTicks"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.DrawTickLabels(SciChart.Charting.Themes.AxisCanvas,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,System.Single)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.UpdateAxisLabel(SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel,System.IComparable,SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.OnDrawAxis(SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousDateTimeAxis.DrawAxisScaleMajorBands(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + Draws axis bands (shadowed areas) on the axis itself. + </summary> + <param name="axisRenderContext">Drawing context of the axis.</param> + <param name="bottomScaleTickCoords">Coordinates of ticks on the bottom scale.</param> + <param name="topScaleTickCoords">Coordinates of ticks on the top scale.</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper"> + <summary> + Provides implementation of interaction with discontinuous range + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.BusinessHours"> + <summary> + Gets business hours + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.#ctor(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar)"> + <summary> + Initializes new instance of <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper" /></summary> + <param name="calendar">The calendar that helper interact with</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.IsValueInGap(System.DateTime)"> + <summary> + Checks if current data time is in a gap + </summary> + <param name="dateTime">The date time to check</param> + <returns>True if a day is in a gap</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.IsDayGap(System.DateTime)"> + <summary> + Checks if current day is in a gap + </summary> + <param name="dateTime">The day to check</param> + <returns>True if a day is in a gap</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.GetDiffBetweenValues(System.DateTime,System.DateTime,System.Boolean)"> + <summary> + Calculates units beetwen two values in ticks + </summary> + <param name="start">Start value to make calculation</param> + <param name="end">End value to make calculation</param> + <param name="includeEnd">True if end is included, used for tick and range calculation</param> + <returns>Number of ticks betwen values taking gaps into account</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.GetValueByOffset(System.DateTime,System.Double)"> + <summary> + Gets DateTime from start shifted by deltapoint + </summary> + <param name="start">Start DateTime</param> + <param name="deltaPoint">Value in ticks that start should be shifted to</param> + <returns>New DateTime after shifting</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.FindClosestDateToBigger(System.DateTime)"> + <summary> + Gets the closest available bigger date + </summary> + <param name="dateTime">Date time that shoud be rounded to the first bigger available date</param> + <returns>The first bigger available date</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousAxisHelper.FindClosestDateToSmaller(System.DateTime)"> + <summary> + Gets the closest available smaller date + </summary> + <param name="dateTime">Date time that shoud be rounded to the first smaller available date</param> + <returns>The first smaller available date</returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis"> + <summary> + Provides a Linear, Value Discontinuous DateTime Axis, capable of rendering DateTime ticks on the X or Y-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.CalendarProperty"> + <summary> + Defines the CalendarProperty DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.Calendar"> + <summary> + Gets or sets the calendar with time ranges to skip. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.GetDefaultNonZeroRange"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.CoerceVisibleRange(SciChart.Data.Model.IRange)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.CalculateDelta"> + <summary> + Calculates the deltas for use in this render pass + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.GetMajorTickIndex(System.Double)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.OnCalendarChanged(SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar,SciChart.Charting.Numerics.Calendars.IDiscontinuousDateTimeCalendar)"> + <summary> + Called by <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /> when <see cref="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.Calendar" /> gets changed. + </summary> + <param name="oldCalendar">Old value of the <see cref="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.Calendar" /> property.</param> + <param name="newCalendar">New value of the <see cref="P:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.Calendar" /> property.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.IDiscontinuousHelper`1"> + <summary> + Defines a set of operations which allows to interact with axis that owns current instance of <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.IDiscontinuousHelper`1" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.IDiscontinuousHelper`1.GetDiffBetweenValues(`0,`0,System.Boolean)"> + <summary> + Calculates difference between two values taking gaps into account + </summary> + <param name="startValue">Start value to make calculation</param> + <param name="endValue">End value to make calculation</param> + <param name="includeEnd">True if end is included, used for tick and range calculation</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.IDiscontinuousHelper`1.GetValueByOffset(`0,System.Double)"> + <summary> + Gets value from start by offset + </summary> + <param name="startValue">Start value</param> + <param name="offset">Value that start should be shifted to</param> + <returns>Data value after shifting</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.IDiscontinuousHelper`1.FindClosestAvailableValue(`0,System.Boolean)"> + <summary> + Finds closest available value that is not in the gap + </summary> + <param name="value">Value to check</param> + <param name="toBigger">True if it will be rounded to bigger value that is not in a gap</param> + <returns>Closest available data value</returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousAxisBottomScaleLabelProvider"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousAxisBottomScaleLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousAxisBottomScaleLabelProvider.FormatLabel(System.IComparable)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousAxisTopScaleLabelProvider"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousAxisTopScaleLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DoubleScaleDiscontinuousAxisTopScaleLabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + <exception cref="T:System.InvalidOperationException">The DiscontinuousDateTimeLabelProvider is only valid on instances of DiscontinuousDateTimeAxis</exception> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.GridLinesPanel"> + <summary> + Provides a panel to draw the background behind a SciChartSurface gridlines area only. Since v2.0 this panel no longer draws gridlines, these are deferred to the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.GridLinesPanel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.GridLinesPanel.EventAggregator"> + <summary> + Sets the event aggregator instance used throughout SciChart + </summary> + <value>The event aggregator instance.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.GridLinesPanel.Clear(SciChart.Charting.XyDirection)"> + <summary> + Clears the grid lines in a specific direction + </summary> + <param name="xyDirection">The <see cref="T:SciChart.Charting.XyDirection" /> to clear in, e.g. <see cref="F:SciChart.Charting.XyDirection.XDirection" /> clears the X-Axis gridlines</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.GridLinesPanel.AddLine(SciChart.Charting.XyDirection,System.Windows.Shapes.Line)"> + <summary> + Adds a line to the panel in the specific <see cref="T:SciChart.Charting.XyDirection" /></summary> + <param name="xyDirection">The <see cref="T:SciChart.Charting.XyDirection" /> to clear in, e.g. <see cref="F:SciChart.Charting.XyDirection.XDirection" /> adds an X-Axis gridline</param> + <param name="line">The line to add</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.GridLinesPanel.SciChart#Charting#Visuals#Axes#IGridLinesPanel#Width"> + <summary> + Gets the width of the panel in pixels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.GridLinesPanel.SciChart#Charting#Visuals#Axes#IGridLinesPanel#Height"> + <summary> + Gets the height of the panel in pixels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.GridLinesPanel.GenerateElement(System.Int32,SciChart.Charting.XyDirection,System.Windows.Style)"> + <summary> + Generates and adds a <see cref="T:System.Windows.Shapes.Line" /> element to the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" />. Applies the direction and style to the line as + well as Id so they may be re-used (pooled) + </summary> + <param name="lineId">The line Id</param> + <param name="xyDirection">The direction, X or Y</param> + <param name="lineStyle">The style to apply to the line</param> + <returns>The <see cref="T:System.Windows.Shapes.Line" /> instance, which has been added to the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" /></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.GridLinesPanel.RemoveElementsAfter(SciChart.Charting.XyDirection,System.Int32)"> + <summary> + Removes all <see cref="T:System.Windows.Shapes.Line" /> instances after the specified index. This method is used when re-drawing the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + when the number of lines has reduced from one redraw to the next. + </summary> + <param name="xyDirection">The direction to clear, X or Y</param> + <param name="index">The index to remove after (inclusive)</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.IAxis"> + <summary> + Defines the base interface to an Axis used throughout Scichart + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.IAxis.VisibleRangeChanged"> + <summary> + Raised when the VisibleRange is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.IAxis.DataRangeChanged"> + <summary> + Raised when data range is changed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.DataContext"> + <summary> + Gets or sets the binding DataContext on the Axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.DataRange"> + <summary> + Gets the DataRange (full extents of the data) of the Axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Axis is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.Orientation"> + <summary> + Gets or sets the Axis Orientation, e.g. Horizontal (XAxis) or Vertical (YAxis) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.LabelProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> instance, which may be used to programmatically override the formatting of text and cursor labels. + For examples, see the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider" /> and <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsHorizontalAxis"> + <summary> + Gets whether this axis is horizontal or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsStaticAxis"> + <summary> + Gets or sets whether current Axis is a static axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.TickTextBrush"> + <summary> + Gets or sets the tick text brush applied to text labels + </summary> + <value>The tick text brush</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.HorizontalAlignment"> + <summary> + Gets or sets the horizontal alignment characteristics that are applied to a <see cref="T:System.Windows.FrameworkElement" /> when it is composed in a layout parent, such as a panel or items control. + </summary> + <returns> + A horizontal alignment setting, as a value of the enumeration. The default is <see cref="F:System.Windows.HorizontalAlignment.Stretch" />. + </returns> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.VerticalAlignment"> + <summary> + Gets or sets the vertical alignment characteristics that are applied to a <see cref="T:System.Windows.FrameworkElement" /> when it is composed in a parent object such as a panel or items control. + </summary> + <returns> + A vertical alignment setting. The default is <see cref="F:System.Windows.VerticalAlignment.Stretch" />. + </returns> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment" /> for this Axis. Default is Right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsCategoryAxis"> + <summary> + Gets a value indicating whether this instance is a category axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsPolarAxis"> + <summary> + Gets a value indicating whether this instance is a polar axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsCenterAxis"> + <summary> + Gets or sets whether current Axis should placed in the center of chart or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsPrimaryAxis"> + <summary> + Gets or sets whether current Axis is the main one in axis collection. This is the axis which is responsible for drawing grid lines on the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" /> and by default, + is the first axis in the collection + </summary> + <remarks>Primary axis determines grid coordinates</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.ModifierAxisCanvas"> + <summary> + Gets the modifier axis canvas, which is used by the CursorModifier to overlay cursor labels and by AxisMarkerAnnotations + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.Visibility"> + <summary> + Gets or sets the visibility of the Axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsAxisFlipped"> + <summary> + Gets whether the current axis is flipped (e.g. YAxis on the bottom or top, or XAxis on the left or right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.VisibleRangeLimit"> + <summary> + Gets or sets the VisibleRangeLimit of the Axis. This will be used to clip the axis during ZoomExtents and AutoRange operations + </summary> + <value>The visible range.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.VisibleRangeLimitMode"> + <summary> + Gets or setts the VisibleRangeLimitMode of the Axis. This property defines which parts of <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.VisibleRangeLimit" /> will be used by axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxis.IsLabelCullingEnabled"> + <summary> + Gets or sets a value indicating whether Label Culling is enabled (when labels overlap) on this AxisPanel instance + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetCurrentInteractivityHelper"> + <summary> + Gets the current <see cref="T:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper" /> for this Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.CaptureMouse"> + <summary> + Captures the mouse for this Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ReleaseMouseCapture"> + <summary> + Releases the mouse for this Axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.SetMouseCursor(System.Windows.Input.Cursor)"> + <summary> + Sets the cursor for this Axis + </summary> + <param name="cursor">The Cursor instance</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.HitTest(System.Windows.Point)"> + <summary> + Performs a HitTest on this axis. Given the input mouse point, returns an AxisInfo struct containing the Value and FormattedValue closest to that point + </summary> + <param name="atPoint">The mouse x,y point</param> + <returns>The AxisInfo struct containing the value and formatted value closest to the mouse point</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Gets the aligned VisibleRange of the axis, with optional ZoomToFit flag. + If ZoomToFit is true, it will return the DataRange plus any GrowBy applied to the axis + </summary> + <returns>The VisibleRange of the axis</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetWindowedYRange(System.Collections.Generic.IDictionary{System.String,SciChart.Data.Model.IRange})"> + <summary> + Called by the SciCharXtSurface internally. Returns the max range only for that axis (by the data-series on it), based on <paramref name="xRanges" /> + "windowed" = "displayed in current viewport" + uses GrowBy() + </summary> + <param name="xRanges">Calculates the max range based on corresponding x ranges</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.OnBeginRenderPass"> + <summary> + Called internally immediately before a render pass begins + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Scroll(System.Double,SciChart.Charting.ClipMode)"> + <summary> + Scrolls current <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> by the specified number of pixels + </summary> + <param name="pixelsToScroll">Scroll N pixels from the current visible range</param> + <param name="clipMode">Defines how scrolling behaves when you reach the edge of the Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Scroll(System.Double,SciChart.Charting.ClipMode,System.TimeSpan)"> + <summary> + Scrolls current <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> by the specified number of pixels with the specified animation duration + </summary> + <param name="pixelsToScroll">Scroll N pixels from the current visible range</param> + <param name="clipMode">Defines how scrolling behaves when you reach the edge of the Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside</param> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Scroll(SciChart.Data.Model.IRange,System.Double,SciChart.Charting.ClipMode)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels + </summary> + <param name="startVisibleRange">The start visible range</param> + <param name="pixelsToScroll">Scroll N pixels from the start visible range</param> + <param name="clipMode">Defines how scrolling behaves when you reach the edge of the Axis extents. + e.g. ClipMode.ClipAtExtents prevents panning outside of the Axis, ClipMode.None allows panning outside</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ScrollByDataPoints(System.Int32)"> + <summary> + Translates current <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> by the specified number of datapoints + </summary> + <param name="pointAmount">Amount of data points that the start visible range is scrolled by</param> + <remarks>For XAxis only, is suitable for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + where data is regularly spaced</remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ScrollByDataPoints(System.Int32,System.TimeSpan)"> + <summary> + Translates current <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> by the specified number of datapoints with the specified animation duration + </summary> + <param name="pointAmount">Amount of points that the start visible range is scrolled by</param> + <remarks>For XAxis only, is suitable for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + where data is regularly spaced</remarks> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Zoom(System.Double,System.Double)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="fromCoord" /> as a coordinate of new range start and + <paramref name="toCoord" /> as a coordinate of new range end + </summary> + <param name="fromCoord">The coordinate of new range start in pixels</param> + <param name="toCoord">The coordinate of new range end in pixels</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Zoom(System.Double,System.Double,System.TimeSpan)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="fromCoord" /> as a coordinate of new range start and + <paramref name="toCoord" /> as a coordinate of new range end + </summary> + <param name="fromCoord">The coordinate of new range start in pixels</param> + <param name="toCoord">The coordinate of new range end in pixels</param> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ZoomBy(System.Double,System.Double)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="minFraction" /> as a multiplier of range start and + <paramref name="maxFraction" /> as a multiplier of range end + </summary> + <param name="minFraction">The multiplier of range start</param> + <param name="maxFraction">The multiplier of range end</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ZoomBy(System.Double,System.Double,System.TimeSpan)"> + <summary> + Performs zoom on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="minFraction" /> as a multiplier of range start and + <paramref name="maxFraction" /> as a multiplier of range end + </summary> + <param name="minFraction">The multiplier of range start</param> + <param name="maxFraction">The multiplier of range end</param> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ScrollTo(SciChart.Data.Model.IRange,System.Double)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels + </summary> + <param name="startVisibleRange">The start visible range</param> + <param name="pixelsToScroll">Scroll N pixels from the start visible range</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.ScrollToWithLimit(SciChart.Data.Model.IRange,System.Double,SciChart.Data.Model.IRange)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels, with the specified range limit + </summary> + <param name="startVisibleRange">The start visible range</param> + <param name="pixelsToScroll">Scroll N pixels from the start visible range</param> + <param name="rangeLimit">The range limit.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.AssertDataType(System.Type)"> + <summary> + Asserts the type passed in is supported by the current axis implementation + </summary> + <param name="dataType"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.FormatText(System.IComparable,System.String)"> + <summary> + String formats the text, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + /// <param name="format">A composite format string</param><returns>The string formatted data value</returns></member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.FormatText(System.IComparable)"> + <summary> + String formats the text, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.FormatCursorText(System.IComparable)"> + <summary> + String formats text for the cursor, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.Clear"> + <summary> + Clears the axis of tick-marks and labels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetModifersAxisLabel(System.Func{SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl})"> + <summary> + Returns the axis label for corresponding modifier to place it on axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.CacheModifersAxisLabel(System.Action{SciChart.Charting.Visuals.Axes.AxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl},SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresopngin axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetModifersAxisLabelTempalte(System.Func{SciChart.Charting.Visuals.Axes.AxisBase,System.Windows.DataTemplate})"> + <summary> + Returns the axis label template for corresponding modifier + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxis.GetModifersAxisLabelStyle(System.Func{SciChart.Charting.Visuals.Axes.AxisBase,System.Windows.Style})"> + <summary> + Returns the axis label style for corresponding modifier + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.IAxisCore"> + <summary> + A shared base interface for 2D and 3D Axis types throughout the SciChart SDK + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.AxisTitle"> + <summary> + Gets or sets the Axis Title + </summary> + <value>The axis title.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.FlipCoordinates"> + <summary> + Gets or sets a flag indicating whether to flip the tick and pixel coordinate generation for this axis, causing the axis ticks to decrement and chart to be flipped in the axis direction + </summary> + <value> + If <c>true</c> reverses the ticks and coordinates for the axis. + </value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.TitleStyle"> + <summary> + Gets or sets the Style of the Axis Title + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.TextFormatting"> + <summary> + Gets or sets the Text Formatting String for Tick Labels on this axis + </summary> + <value>The text formatting.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MinorsPerMajor"> + <summary> + Gets or sets the number of Minor Delta ticks per Major Tick + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MaxAutoTicks"> + <summary> + Gets or sets the max ticks. + </summary> + <value>The max ticks.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.AutoTicks"> + <summary> + Gets or sets value, that indicates whether calculate ticks automatically. Default is True. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.TickProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Numerics.TickProviders.ITickProvider" /> instance on current axis, + which is used to compute the data-values of Axis Gridlines, Ticks and Labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MajorTickLineStyle"> + <summary> + Gets or sets the Major Tick Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all major ticks on this axis + </summary> + <value>The major tick line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MinorTickLineStyle"> + <summary> + Gets or sets the Minor Tick Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all major ticks on this axis + </summary> + <value>The minor tick line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MajorGridLineStyle"> + <summary> + Gets or sets the Major Grid Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all major gridlines drawn by this axis + </summary> + <value>The major grid line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.MinorGridLineStyle"> + <summary> + Gets or sets the Minor Grid Line Style (TargetType <see cref="T:System.Windows.Shapes.Line" />), applied to all minor gridlines drawn by this axis + </summary> + <value>The minor grid line style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawMinorTicks"> + <summary> + If True, draws Minor Tick Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawLabels"> + <summary> + If True, draw labels for each major tick on the Axis, else skips this step + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawMajorTicks"> + <summary> + If True, draws Major Tick Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawMajorGridLines"> + <summary> + If True, draws Major Grid Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawMinorGridLines"> + <summary> + If True, draws Minor Grid Lines, else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawMajorBands"> + <summary> + If True, draws Major Axis Bands (a filled area between major gridlines), else skips this step + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.AxisBandsFill"> + <summary> + Gets or sets the Fill of the Axis Bands. Also see <see cref="P:SciChart.Charting.Visuals.Axes.IAxisCore.DrawMajorBands" /> to enable this behaviour + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.AutoRange"> + <summary> + Gets or sets whether this current axis <see cref="P:SciChart.Charting.Visuals.Axes.IAxisCore.AutoRange" />. Default is AutoRange.Once + </summary> + <value>If AutoRange.Always, the axis should scale to fit the data, else AutoRange.Once, the axis will try to fit the data once. + If AutoRange.Never, then the axis will never autorange.</value> + <remarks>GrowBy is applied when the axis scales to fit</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.AnimatedVisibleRange"> + <summary> + Gets or sets the animated VisibleRange of the Axis. When this property is set, the axis animates the VisibleRange to the new value + </summary> + <value>The visible range.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.TickLabelStyle"> + <summary> + Gets or sets a style for the labels on this Axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.CursorTextFormatting"> + <summary> + Gets or sets the Text Formatting String for Labels on this cursor + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance and shared between various scichart components throughout the surface instance. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.IsLogarithmicAxis"> + <summary> + Gets a value indicating whether this instance is a logarithmic axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.HasValidVisibleRange"> + <summary> + Gets whether the VisibleRange is valid, e.g. is not null, is not NaN and the difference between Max and Min is not zero + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.HasDefaultVisibleRange"> + <summary> + Gets whether the VisibleRange has default value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.IsXAxis"> + <summary> + Gets whether this axis is an X-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisCore.Id"> + <summary> + Gets or sets the string Id of this axis. Used to associated <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> and <see cref="T:SciChart.Charting.ChartModifiers.YAxisDragModifier" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.AnimateVisibleRangeTo(SciChart.Data.Model.IRange,System.TimeSpan,System.Action)"> + <summary> + Animates the visible range of the axis to the destination VisibleRange, over the specified Duration. + Also see <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.AnimatedVisibleRange" /> property which has a default duration of 500ms + </summary> + <param name="to">The end range</param> + <param name="duration">The duration of the animation.</param> + <param name="onCompleted">Completed action called when the animation completes</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is valid visible range for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.ValidateAxis"> + <summary> + Called by the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> internally to validate current axis during render pass + </summary> + <remarks>Throws if <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.AutoTicks" /> is False + and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" /> aren't set</remarks> + <exception cref="T:System.InvalidOperationException" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.GetCurrentCoordinateCalculator"> + <summary> + Gets the current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> for this Axis, based on current Visible Range and axis type + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.GetAxisSize"> + <summary> + Gets the size of the axis in the Viewport + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.GetCoordinate(System.IComparable)"> + <summary> + Given the Data Value, returns the x or y pixel coordinate at that value on the Axis + </summary> + <example> + Given an axis with a VisibleRange of 1..10 and height of 100, a value of 7 passed in to GetCoordinate would return 70 pixels + </example> + <param name="value">The DataValue as input</param> + <returns>The pixel coordinate on this Axis corresponding to the input DataValue</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.GetDataValue(System.Double)"> + <summary> + Given the x or y pixel coordinate, returns the data value at that coordinate + </summary> + <param name="pixelCoordinate">The x or y pixel coordinate as input</param> + <returns>The data value on this Axis corresponding to the input x or y pixel coordinate</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisCore.GetAxisOffset"> + <summary> + Returns the offset of the Axis + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper"> + <summary> + Defines a set of operations which allows to interact with axis that owns current instance of <see cref="T:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.Zoom(SciChart.Data.Model.IRange,System.Double,System.Double)"> + <summary> + Calculates and returns a Zoomed Range on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="fromCoord" /> as a coordinate of new range start and + <paramref name="toCoord" /> as a coordinate of new range end + </summary> + <param name="initialRange">Initial range</param> + <param name="fromCoord">The coordinate of new range start in pixels</param> + <param name="toCoord">The coordinate of new range end in pixels</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.ZoomBy(SciChart.Data.Model.IRange,System.Double,System.Double)"> + <summary> + Calculates and returns a Zoomed Range on current <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, using <paramref name="minFraction" /> as a multiplier of range start and + <paramref name="maxFraction" /> as a multiplier of range end + </summary> + <param name="initialRange">Initial range</param> + <param name="minFraction">The multiplier of range start</param> + <param name="maxFraction">The multiplier of range end</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.ScrollInMinDirection(SciChart.Data.Model.IRange,System.Double)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels in Min direction + </summary> + <param name="rangeToScroll">The start range</param> + <param name="pixels">Scroll N pixels from the start visible range</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.ScrollInMaxDirection(SciChart.Data.Model.IRange,System.Double)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels in Max direction + </summary> + <param name="rangeToScroll">The start range</param> + <param name="pixels">Scroll N pixels from the start visible range</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.Scroll(SciChart.Data.Model.IRange,System.Double)"> + <summary> + From the starting <see cref="T:SciChart.Data.Model.IRange" />, scrolls to a new range by the specified number of pixels + </summary> + <param name="rangeToScroll">The start range</param> + <param name="pixels">Scroll N pixels from the start visible range</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.ScrollBy(SciChart.Data.Model.IRange,System.Int32)"> + <summary> + Translates the passed range by the specified number of datapoints + </summary> + <param name="rangeToScroll">The start range</param> + <param name="pointAmount">Amount of points that the start visible range is scrolled by</param> + <remarks>For XAxis only, is suitable for <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" />, <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + where data is regularly spaced</remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisInteractivityHelper.ClipRange(SciChart.Data.Model.IRange,SciChart.Data.Model.IRange,SciChart.Charting.ClipMode)"> + <summary> + Performs clipping of passed <paramref name="rangeToClip" /> using <paramref name="clipMode" /></summary> + <param name="rangeToClip"></param> + <param name="maximumRange"></param> + <param name="clipMode"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.IAxisParams"> + <summary> + Defines the interface used to pass the set of parameters to <see cref="T:SciChart.Charting.Numerics.TickProviders.ITickProvider" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange"> + <summary> + Gets or sets the VisibleRange of the Axis. In the case of XAxis, this will cause an align to X-Axis operation to take place + </summary> + <remarks>Setting the VisibleRange will cause the axis to redraw</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisParams.GrowBy"> + <summary> + Gets or sets the GrowBy Factor. e.g. GrowBy(0.1, 0.2) will increase the axis extents by 10% (min) and 20% (max) outside of the data range + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisParams.MinorDelta"> + <summary> + Gets or sets the Minor Delta + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IAxisParams.MajorDelta"> + <summary> + Gets or sets the Major Delta + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IAxisParams.GetMaximumRange"> + <summary> + Gets the maximum range of the axis, based on the data-range of all series + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.ICategoryAxis"> + <summary> + Defines the interface to a category axis, which treats X-data as linearly increasing regardless of value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ICategoryAxis.CurrentDatapointWidth"> + <summary> + Gets the current data-point width in pixels + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.IGridLinesPanel"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" />, a canvas control which displays grid lines behind the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IGridLinesPanel.Clear(SciChart.Charting.XyDirection)"> + <summary> + Clears the grid lines in a specific direction + </summary> + <param name="xyDirection">The <see cref="T:SciChart.Charting.XyDirection" /> to clear in, e.g. <see cref="F:SciChart.Charting.XyDirection.XDirection" /> clears the X-Axis gridlines</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IGridLinesPanel.AddLine(SciChart.Charting.XyDirection,System.Windows.Shapes.Line)"> + <summary> + Adds a line to the panel in the specific <see cref="T:SciChart.Charting.XyDirection" /></summary> + <param name="xyDirection">The <see cref="T:SciChart.Charting.XyDirection" /> to clear in, e.g. <see cref="F:SciChart.Charting.XyDirection.XDirection" /> adds an X-Axis gridline</param> + <param name="line">The line to add</param> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IGridLinesPanel.Width"> + <summary> + Gets the width of the panel in pixels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IGridLinesPanel.Height"> + <summary> + Gets the height of the panel in pixels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.IGridLinesPanel.BorderThickness"> + <summary> + Gets the thickness of any border applied to the panel + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IGridLinesPanel.GenerateElement(System.Int32,SciChart.Charting.XyDirection,System.Windows.Style)"> + <summary> + Generates and adds a <see cref="T:System.Windows.Shapes.Line" /> element to the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" />. Applies the direction and style to the line as + well as Id so they may be re-used (pooled) + </summary> + <param name="lineId">The line Id</param> + <param name="xyDirection">The direction, X or Y</param> + <param name="lineStyle">The style to apply to the line</param> + <returns>The <see cref="T:System.Windows.Shapes.Line" /> instance, which has been added to the <see cref="T:SciChart.Charting.Visuals.Axes.GridLinesPanel" /></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.IGridLinesPanel.RemoveElementsAfter(SciChart.Charting.XyDirection,System.Int32)"> + <summary> + Removes all <see cref="T:System.Windows.Shapes.Line" /> instances after the specified index. This method is used when re-drawing the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + when the number of lines has reduced from one redraw to the next. + </summary> + <param name="xyDirection">The direction to clear, X or Y</param> + <param name="index">The index to remove after (inclusive)</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.ITernaryAxis"> + <summary> + Defines the base interface to a Ternary Chart Axis used throughout Scichart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.DataRange"> + <summary> + Gets the DataRange (full extents of the data) of the Axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Axis is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.LabelProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> instance, which may be used to programmatically override the formatting of text and cursor labels. + For examples, see the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider" /> and <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.IsYAxis"> + <summary> + Gets whether this axis is Y or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.IsZAxis"> + <summary> + Gets whether this axis is Z or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.TickTextBrush"> + <summary> + Gets or sets the tick text brush applied to text labels + </summary> + <value>The tick text brush</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.AxisAlignment"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.AxisAlignment" /> for this Axis. Default is Right. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.ModifierAxisCanvas"> + <summary> + Gets the modifier axis canvas, which is used by the CursorModifier to overlay cursor labels and by AxisMarkerAnnotations + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.Visibility"> + <summary> + Gets or sets the visibility of the Axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryAxis.Angle"> + <summary> + Gets or sets angle for axis roation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.CaptureMouse"> + <summary> + Captures the mouse for this Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.ReleaseMouseCapture"> + <summary> + Releases the mouse for this Axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.Clear"> + <summary> + Clears the axis of tick-marks and labels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.SetMouseCursor(System.Windows.Input.Cursor)"> + <summary> + Sets the cursor for this Axis + </summary> + <param name="cursor">The Cursor instance</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.GetModifersAxisLabel(System.Func{SciChart.Charting.Visuals.Axes.TernaryAxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl})"> + <summary> + Returns the axis label for corresponding modifier to place it on axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.FormatText(System.IComparable)"> + <summary> + String formats the text, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.FormatCursorText(System.IComparable)"> + <summary> + String formats text for the cursor, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.CacheModifersAxisLabel(System.Action{SciChart.Charting.Visuals.Axes.TernaryAxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl},SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresopngin axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.GetModifersAxisLabelTempalte(System.Func{SciChart.Charting.Visuals.Axes.TernaryAxisBase,System.Windows.DataTemplate})"> + <summary> + Returns the axis label template for corresponding modifier + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.ITernaryAxis.GetModifersAxisLabelStyle(System.Func{SciChart.Charting.Visuals.Axes.TernaryAxisBase,System.Windows.Style})"> + <summary> + Returns the axis label style for corresponding modifier + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.ITernaryHitTestable"> + <summary> + Defines the base interface for a type which can be hit-tested + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryHitTestable.ActualWidth"> + <summary> + Gets the width of the <see cref="T:SciChart.Charting.Visuals.Axes.ITernaryHitTestable" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.ITernaryHitTestable.ActualHeight"> + <summary> + Gets the height of the <see cref="T:SciChart.Charting.Visuals.Axes.ITernaryHitTestable" /></summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.AxisTitle"> + <summary> + A Templateable Control to display axis titles + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.AxisTitle.OrientationProperty"> + <summary> + Using a DependencyProperty as the backing store for Orientation. This enables animation, styling, binding, etc... + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.AxisTitle.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.AxisTitle" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.AxisTitle.Orientation"> + <summary> + Gets or sets the orientation. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.DateTimeLabelProvider"> + <summary> + The DateTimeLabelFormatter is a pass-through which uses the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> properties + to format axis and cursor label texts. It also uses the <see cref="P:SciChart.Charting.Visuals.Axes.DateTimeAxis.SubDayTextFormatting" /> property to alter text-formatting when the date-range + switches to intra-day + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DateTimeLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DateTimeLabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + <exception cref="T:System.InvalidOperationException">The DateTimeLabelFormatter is only valid on instances of DateTimeAxis</exception> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel"> + <summary> + Provides a class for tick axis labels rendering. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.HorizontalAnchorPointProperty"> + <summary> + Defines the HorizontalAnchorPoint DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.VerticalAnchorPointProperty"> + <summary> + Defines the VerticalAnchorPoint DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.PositionProperty"> + <summary> + Defines the Position DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.DefaultForegroundProperty"> + <summary> + Defines the DefaultForeground DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.DefaultVerticalAnchorPointProperty"> + <summary> + Defines the DefaultVerticalAnchorPoint DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.DefaultHorizontalAnchorPointProperty"> + <summary> + Defines the DefaultHorizontalAnchorPoint DependencyProperty + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.HorizontalAnchorPoint"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.HorizontalAnchorPoint" />. + The value of Left means the X1,Y1 coordinate of the annotation is on the Left horizontally. + The value of Center means the X1,Y1 coordinate of the annotation is at the center horizontally. + The value of Right means the X1,Y1 coordinate of the annotation is at the right horizontally. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.VerticalAnchorPoint"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.VerticalAnchorPoint" />. + The value of Top means the X1,Y1 coordinate of the annotation is on the Top vertically. + The value of Center means the X1,Y1 coordinate of the annotation is at the center vertically. + The value of Bottom means the X1,Y1 coordinate of the annotation is at the Bottom vertically. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DefaultTickLabel.OnPropertyChanged(System.String)"> + <summary> + Implementation of <see cref="T:System.ComponentModel.INotifyPropertyChanged" /></summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.DiscontinuousDateTimeLabelProvider"> + <summary> + The DiscontinuousDateTimeLabelProvider is a pass-through which uses the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> properties + to format axis and cursor label texts. It also uses the <see cref="P:SciChart.Charting.Visuals.Axes.DateTimeAxis.SubDayTextFormatting" /> property to alter text-formatting when the date-range + switches to intra-day + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DiscontinuousDateTimeLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DiscontinuousDateTimeLabelProvider.CheckAxisType"> + <summary> + Performs a type check of <see cref="P:SciChart.Charting.Numerics.ProviderBase.ParentAxis" />. + Throws <see cref="T:System.InvalidOperationException" /> if the type is not derived from <see cref="T:SciChart.Charting.Visuals.Axes.DiscontinuousAxis.DiscontinuousDateTimeAxis" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.DiscontinuousDateTimeLabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + <exception cref="T:System.InvalidOperationException">The DiscontinuousDateTimeLabelProvider is only valid on instances of DiscontinuousDateTimeAxis</exception> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider"> + <summary> + Interface to define a LabelProvider. The LabelFormatter may be set or data-bound to the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property, allowing + programmatic overriding of axis labels. + + Create a class which implements <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> and return string values from the <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatLabel(System.IComparable)" /> and <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatCursorLabel(System.IComparable)" /> methods + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the label formatted is initialized as it is attached to the parent axis, with the parent axis instance + </summary> + <param name="parentAxis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxisCore" /> instance</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.OnBeginAxisDraw"> + <summary> + Called at the start of an axis render pass, before any labels are formatted for the current draw operation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.CreateDataContext(System.IComparable)"> + <summary> + Creates a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel" /> instance, based on the data-value passed in. + Invokes <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatLabel(System.IComparable)" /> to format the specified data-value passed in. + </summary> + <param name="dataValue">The data-value to format</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.UpdateDataContext(SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel,System.IComparable)"> + <summary> + Updates existing <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel" />, based on the data-value passed in. + Invokes <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatLabel(System.IComparable)" /> to format the specified data-value passed in. + </summary> + <param name="labelDataContext">The instance to update</param> + <param name="dataValue">The data-value to format</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns>The formatted label string</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns>The formatted cursor label string</returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel"> + <summary> + Defines the base interface to a Tick Label Viewmodel - a viewmodel which each Axis Tick Label will bind to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel.HasExponent"> + <summary> + Gets or sets if the Tick Label has an exponent. NOTE Only valid for Numeric Axis. Ignored by DateTime or TimeSpan axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel.Separator"> + <summary> + Gets or sets the Separator, for example the E symbol in Engineering notifation, or x10^ for Scientific Notation. NOTE Only valid for Numeric Axis. Ignored by DateTime or TimeSpan axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel.Exponent"> + <summary> + Gets or sets the exponent. This is the power of 10 exponent in string format. NOTE Only valid for Numeric Axis. Ignored by DateTime or TimeSpan axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel.Text"> + <summary> + Gets or sets the Text for the tick label + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase"> + <summary> + Base class to define a LabelProvider. The LabelProvider may be set or data-bound to the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property, allowing + programmatic overriding of axis labels. + + Create a class which implements <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> and return string values from the <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatLabel(System.IComparable)" /> and <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider.FormatCursorLabel(System.IComparable)" /> methods + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.OnBeginAxisDraw"> + <summary> + Called at the start of an axis render pass, before any labels are formatted for the current draw operation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.CreateDataContext(System.IComparable)"> + <summary> + Creates a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel" /> instance, based on the data-value passed in. + Invokes <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.FormatLabel(System.IComparable)" /> to format the specified data-value passed in. + </summary> + <param name="dataValue">The data-value to format</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.UpdateDataContext(SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel,System.IComparable)"> + <summary> + Updates existing <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel" />, based on the data-value passed in. + Invokes <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.FormatLabel(System.IComparable)" /> to format the specified data-value passed in. + </summary> + <param name="labelDataContext">The instance to update</param> + <param name="dataValue">The data-value to format</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.LabelProviderBase.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider"> + <summary> + The NumericLabelFormatter is a pass-through which uses the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> properties + to format axis and cursor label texts + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider.CreateDataContext(System.IComparable)"> + <summary> + Creates a + <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel" /> instance, based on the data-value passed in. + Invokes + <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider.FormatLabel(System.IComparable)" /> to format the specified data-value passed in. + </summary> + <param name="dataValue">The data-value to format</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider.UpdateDataContext(SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel,System.IComparable)"> + <summary> + Updates existing + <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ITickLabelViewModel" />, based on the data-value passed in. + Invokes + <see cref="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider.FormatLabel(System.IComparable)" /> to format the specified data-value passed in. + </summary> + <param name="labelDataContext">The instance to update</param> + <param name="dataValue">The data-value to format</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericLabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.NumericTickLabel"> + <summary> + Provides a class for tick axis labels rendering. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.NumericTickLabel.#ctor"> + <summary> + a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.NumericTickLabel" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.RadarAxisTitle"> + <summary></summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.RadarAxisTitle.#ctor"> + <summary></summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisTitle"> + <summary> + A Templateable Control to display axis titles + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisTitle.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisTitle" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisVertexLabel"> + <summary> + A Templateable Control to display axis titles + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisVertexLabel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.TernaryAxisVertexLabel" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.TimeSpanLabelProvider"> + <summary> + The DateTimeLabelFormatter is a pass-through which uses the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> properties + to format axis and cursor label texts. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TimeSpanLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TimeSpanLabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + <exception cref="T:System.InvalidOperationException">The DateTimeLabelFormatter is only valid on instances of DateTimeAxis</exception> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider"> + <summary> + A LabelFormatter instance to use on stock charts. Designed to be used with the <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> and applied by default on the <see cref="!:SciStockChart" /> control + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider.Init(SciChart.Charting.Visuals.Axes.IAxisCore)"> + <summary> + Called when the label formatted is initialized, with the parent axis instance + </summary> + <param name="parentAxis">The parent <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instance</param> + <exception cref="T:System.InvalidOperationException">The TradeChartAxisLabelFormatter is only valid on instances of CategoryDateTimeAxis</exception> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider.OnBeginAxisDraw"> + <summary> + Called at the start of an axis render pass, before any labels are formatted for the current draw operation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LabelProviders.TradeChartAxisLabelProvider.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.ILogarithmicAxis"> + <summary> + Defines the interface to a logarithmic axis, the value axis which uses a logarithmic scale. + The <see cref="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.ILogarithmicAxis.LogarithmicBase" /> property determines which base is used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.ILogarithmicAxis.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.ILogarithmicAxis.ScientificNotation"> + <summary> + Gets or sets used number format. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicBaseConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)"> + <summary> + Returns whether the type converter can convert an object from the specified type to the type of this converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="sourceType">The type you want to convert from.</param> + <returns> + true if this converter can perform the conversion; otherwise, false. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicBaseConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)"> + <summary> + Converts from the specified value to the intended conversion type of the converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use as the current culture.</param> + <param name="value">The value to convert to the type of this converter.</param> + <returns> + The converted value. + </returns> + <exception cref="T:System.FormatException">Unable to convert the object type {0} into a double. Please use a string with format '2, 5.6' or 'E, e'</exception> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis"> + <summary> + Provides a Logarithmic, Value Numeric Axis, capable of rendering double, int, short, byte, long ticks on the X or Y-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + The <see cref="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.LogarithmicBase" /> property determines which base is used for the logarithm. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.LogarithmicBaseProperty"> + <summary> + Defines the LogarithmicBase DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.EnableHighPrecisionTicksProperty"> + <summary> + Defines the EnableHighPrecisionTicks DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.ShowAxisOffsetsProperty"> + <summary> + Defines the ShowAxisOffsets DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.ShowAxisOffsets"> + <summary> + Defines the ShowAxisOffsets property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.IsLogarithmicAxis"> + <summary> + Gets a value indicating whether this instance is a logarithmic axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.EnableHighPrecisionTicks"> + <summary> + Gets or sets a value which enables high-precision ticks generation. + </summary> + <remarks>When enabled, allows smaller difference between neighboring major ticks. It should be enabled to show axis ticks at deep zoom levels or when data values are small.</remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.IsVisibleRangeConstrained(SciChart.Data.Model.IRange)"> + <summary> + Checks whether the current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> meets <see cref="P:SciChart.Charting.Visuals.Axes.NumericAxis.MinimalZoomConstrain" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is valid visible range for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of Axis Gridlines, Ticks and Labels. + When overridden in a derived class (e.g. <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" />, the implementation of GetTickCalculator() changes to + allow calculations specific to that axis type + </summary> + <returns> + An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.CalculateTicks"> + <summary> + Called internal to calculate MinorTicks, MajorTicks before Axis drawing + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis"> + <summary> + Provides a Logarithmic, Value Numeric Axis, capable of rendering negative double, int, short, byte, long ticks on the X or Y-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + The <see cref="P:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis.LogarithmicBase" /> property determines which base is used for the logarithmic scale. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis.IsVisibleRangeConstrained(SciChart.Data.Model.IRange)"> + <summary> + Checks whether the current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> meets <see cref="P:SciChart.Charting.Visuals.Axes.NumericAxis.MinimalZoomConstrain" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.LogarithmicAxis.NegativeLogarithmicAxis.GetDefaultNonZeroRange"> + <summary> + Returns a default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.NumericAxis"> + <summary> + Provides a Linear, Value Numeric Axis, capable of rendering double, int, short, byte, long ticks on the X or Y-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.NumericAxis.ScientificNotationProperty"> + <summary> + Defines the ScientificNotation DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.NumericAxis.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.NumericAxis.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.NumericAxis.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.NumericAxis.ScientificNotation"> + <summary> + Gets or sets used number format + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of Axis Gridlines, Ticks and Labels. + When overridden in a derived class (e.g. <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" />, the implementation of GetTickCalculator() changes to + allow calculations specific to that axis type + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.CalculateDelta"> + <summary> + Calcuates the delta's for use in this render pass + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Gets the aligned VisibleRange of the axis, with optional ZoomToFit flag. + If ZoomToFit is true, it will return the DataRange plus any GrowBy applied to the axis + </summary> + <param name="renderPassInfo">Struct containing data for the current render pass</param> + <returns> + The VisibleRange of the axis + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.NumericAxis.GetSupportedTypes"> + <summary> + Returns a list of types which current axis is designed to work with + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.PolarXAxis"> + <summary> + Provides a Polar, Value Numeric Axis, capable of rendering double, int, short, byte, long ticks on the XAxis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisCore" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.PolarXAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.PolarYAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.PolarXAxis.RotationAngleProperty"> + <summary> + Defines the RotationAngle dependency property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.PolarXAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.PolarXAxis.RotationAngle"> + <summary> + Gets or sets initial position of the current axis in degrees + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.PolarXAxis.IsPolarAxis"> + <summary> + Gets a value indicating whether this instance is a polar axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.PolarXAxis.IsHorizontalAxis"> + <summary> + Gets whether the current axis is horizontal or not + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.OnApplyTemplate" />. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Single})"> + <summary> + Draws grid lines on chart at specified coordinates + </summary> + <param name="renderContext"></param> + <param name="gridLineStyle"></param> + <param name="coordsToDraw"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.GetAxisOffset"> + <summary> + Returns the offset of the Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.GetLabelPosition(System.Single,System.Single)"> + <summary> + Get coordinates to place tick label + </summary> + <param name="offset"></param> + <param name="coords"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.HitTest(System.IComparable)"> + <summary> + Performs a HitTest operation on the <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />. The supplied <paramref name="dataValue" /> is used to convert to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> struct, which contains information about the axis, as well as formatted values + </summary> + <param name="dataValue">The data value.</param> + <returns>The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> result</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarXAxis.HitTest(System.Windows.Point)"> + <summary> + Performs a hit test on the Axis, returning the Data Value at the specific x or y pixel coordinate. This operation is the opposite of <see cref="M:SciChart.Charting.Visuals.Axes.AxisCore.GetCoordinate(System.IComparable)" /></summary> + <remarks>If the Axis is an XAxis, the coordinate passed in is an X-pixel. If the axis is a Y Axis, the coordinate is a Y-pixel</remarks> + <param name="atPoint">The pixel coordinate on this Axis corresponding to the input DataValue</param> + <returns>An <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo" /> struct containing the datavalue and formatted data value at this coordinate</returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.PolarYAxis"> + <summary> + Provides a Polar, Value Numeric Axis, capable of rendering double, int, short, byte, long ticks on the YAxis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.PolarXAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.PolarYAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.PolarYAxis.AngleProperty"> + <summary> + Defines the Angle DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarYAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.PolarYAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.PolarYAxis.Angle"> + <summary> + Gets or set rotation angle for this axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.PolarYAxis.IsPolarAxis"> + <summary> + Gets a value indicating whether this instance is a polar axis. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarYAxis.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Single})"> + <summary> + Draws grid lines on chart at specified coordinates + </summary> + <param name="renderContext"></param> + <param name="gridLineStyle"></param> + <param name="coordsToDraw"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarYAxis.GetAxisOffset"> + <summary> + Returns the offset of the Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.PolarYAxis.GetAxisParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.GridLinesType"> + <summary> + Specifies how grid lines appears on a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.GridLinesType.SpiderWeb"> + <summary> + Grid consists of straight radial lines connected by segments, thus resembling spider's web. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.GridLinesType.Circular"> + <summary> + Grid consists of straight radial lines with concentric circles. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.GridLinesType.None"> + <summary> + Grid doesn't appear. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.RadarAxis"> + <summary> + Provides a Value Numeric Axis, capable of rendering double, int, short, byte, long ticks on an Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngleProperty"> + <summary> + Defines the AxisAngle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.AxisLengthProperty"> + <summary> + Defines the AxisLength DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.GridLinesTypeProperty"> + <summary> + Defines the GridLinesType DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.AxisBorderStyleProperty"> + <summary> + Defines the AxisBorderStyle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.DrawAxisLineProperty"> + <summary> + Defines the DrawAxisLine DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.SkippedFirstTicksProperty"> + <summary> + Defines the SkippedFirstTicks DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.RadarAxis.SkippedLastTicksProperty"> + <summary> + Defines the SkippedLastTicks DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.SkippedLastTicks"> + <summary> + Gets or sets the number of starting ticks to skip. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.SkippedFirstTicks"> + <summary> + Gets or sets the number of ticks to skip from the end of axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.DrawAxisLine"> + <summary> + Specifies wether to draw the axis line or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisBorderStyle"> + <summary> + Gets or sets a style for the axis line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisLength"> + <summary> + Gets or sets the length of an axis. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.GridLinesType"> + <summary> + Specifies how grid lines should appear on a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle"> + <summary> + Gets or set the rotation angle for an axis, which specifies its position within a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.OnBeginRenderPass"> + <summary> + Called internally immediately before a render pass begins. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.GetAxisTitle"> + <summary> + Returns a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.RadarAxisTitle" /> control which hosts the axis title. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.DrawTickLabels(SciChart.Charting.Themes.AxisCanvas,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates,System.Single)"> + <summary> + Draws textual labels on an axis. + </summary> + <param name="canvas">The canvas to draw labels on.</param> + <param name="tickCoords">The tick coords containing all coordinates for ticks and gridlines.</param> + <param name="offset">The offset of an axis.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.OnDrawAxis(SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + Called when the axis should redraw itself. + </summary> + <param name="tickCoords"></param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Numerics.CoordinateProviders.TickCoordinates)"> + <summary> + Draws the axis line. See <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.DrawAxisLine" />. + If this is the Primary Axis, draws grid lines on a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> at the specified coordinates. + See <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.IsPrimaryAxis" />. + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance used for drawing.</param> + <param name="tickCoords">The collection of coordinates to draw grid lines at.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.InvalidateParentSurface"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.DrawGridLines(SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Single})"> + <summary> + If this is the Primary Axis, draws grid lines on a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> at the specified coordinates. + See <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.IsPrimaryAxis" />. + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance used for drawing.</param> + <param name="gridLineStyle">The style of grid lines.</param> + <param name="coordsToDraw">The collection of coordinates to draw grid lines at.</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.GetCoordinate(System.Double)"> + <summary> + Transforms the data value into pixel coordinates. + </summary> + <param name="dataValue">Data value</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.RadarAxis.GetDataValue(System.Windows.Point)"> + <summary> + Transforms a point in pixels into data value. + </summary> + <param name="point">Data value</param> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TernaryAxisAlignment"> + <summary> + Enumeration constants to define the alignment of a ternary axis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisAlignment.Default"> + <summary> + TernaryAxis is on the Bottom-edge of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisAlignment.XAxisAlignment"> + <summary> + TernaryAxis is on the Bottom-edge of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisAlignment.YAxisAlignment"> + <summary> + TernaryAxis is on the Right-side of the chart surface + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisAlignment.ZAxisAlignment"> + <summary> + TernaryAxis is on the Left-side of the chart surface + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TernaryAxisBase"> + <summary> + Provides base functionality for Ternary Axes throughout SciChart. Derived types include <see cref="T:SciChart.Charting.Visuals.Axes.TernaryNumericAxis" />, which supports any + numeric value. Axes may be styled, see the <see href="http://www.scichart.com/tutorials">tutorials</see> for more details + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisBase.TitleFontWeightProperty"> + <summary> + Defines the TitleFontWeight DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisBase.TitleFontSizeProperty"> + <summary> + Defines the TitleFontWeight DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisBase.AxisAlignmentProperty"> + <summary> + Defines the AxisAlignment DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisBase.VertexLabelStyleProperty"> + <summary> + Defines the VertexLabelStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisBase.VertexTitleProperty"> + <summary> + Defines the VertexLabelStyle DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.TernaryAxisBase" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.IsXAxis"> + <summary> + Gets whether this axis is an X-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.IsYAxis"> + <summary> + Gets whether this axis is an Y-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.IsZAxis"> + <summary> + Gets whether this axis is an Z-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.Angle"> + <summary> + Gets or set rotation angle for this axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.TernaryTickLabelAxisCanvas"> + <summary> + Gets or sets the TernaryTickLabelAxisCanvas, which may be used to place label ticks on the canvas + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.ModifierAxisCanvas"> + <summary> + Gets the ModifierAxisCanvas, which may be used to overlay markers on the canvas + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.TernaryAxisContainer"> + <summary> + Gets the parent container of current axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.DataRange"> + <summary> + Gets the DataRange (full extents of the data) of the Axis. + </summary> + <value>The data range</value> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Axis is associated with + </summary> + <value>The parent surface.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.TitleFontWeight"> + <summary> + Gets or sets the Axis Title Font Weight + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.VertexTitle"> + <summary> + Gets or sets the Vertex Label Title + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.TitleFontSize"> + <summary> + Gets or sets the Axis Title Font Size + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.VertexLabelStyle"> + <summary> + Gets or sets the Style of the Axis Title + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.AxisAlignment"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.Axes.TernaryAxisBase.AxisAlignment" /> for this TernaryAxis. Default is XAxisAlignment. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.DrawLabelTicks(SciChart.Charting.Themes.TernaryAxisCanvas,System.Double)"> + <summary> + Called internal to draw label ticks + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetCurrentCoordinateCalculator"> + <summary> + Gets the current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> for this Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetAxisOffset"> + <summary> + Returns the offset of the axis relative to the <see cref="!:RenderSurface" />. + Is used for cases where axes are vertically or horizontally stacked. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.Clear"> + <summary> + Clears axis labels, ticks off this axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called when the instance is drawn + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> used for drawing</param> + <param name="renderPassData">Contains arguments and parameters for this render pass</param> + <seealso cref="T:SciChart.Charting.Visuals.IDrawable" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.DrawGridLine(SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,System.Windows.Point,System.Windows.Point)"> + <summary> + Draws a single grid line on the <see cref="!:RenderSurface" />, using the specified Style (TargetType <see cref="T:System.Windows.Shapes.Line" />) + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance to draw to</param> + <param name="linePen">The pen (TargetType <see cref="T:SciChart.Drawing.Common.IPen2D" />) to apply to the grid line</param> + <param name="atPoint">The integer coordinate to draw at</param> + <param name="toPoint">The integer coordinate to draw to</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetAxisSize"> + <summary> + Gets the size of the axis in the Viewport + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.OnDependencyPropertyChanged"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.SetMouseCursor(System.Windows.Input.Cursor)"> + <summary> + Sets the cursor for this Axis + </summary> + <param name="cursor">The Cursor instance</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.FormatText(System.IComparable)"> + <summary> + String formats the text, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.FormatCursorText(System.IComparable)"> + <summary> + String formats text for the cursor, using the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> property as a formatting string + </summary> + <param name="value">The data value to format</param> + <returns>The string formatted data value</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetModifersAxisLabel(System.Func{SciChart.Charting.Visuals.Axes.TernaryAxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl})"> + <summary> + Returns the axis label for corresponding modifier to place it on axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.CacheModifersAxisLabel(System.Action{SciChart.Charting.Visuals.Axes.TernaryAxisBase,SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl},SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl)"> + <summary> + Caches axis label in corresopngin axis + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetModifersAxisLabelTempalte(System.Func{SciChart.Charting.Visuals.Axes.TernaryAxisBase,System.Windows.DataTemplate})"> + <summary> + Returns the axis label template for corresponding modifier + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.GetModifersAxisLabelStyle(System.Func{SciChart.Charting.Visuals.Axes.TernaryAxisBase,System.Windows.Style})"> + <summary> + Returns the axis label style for corresponding modifier + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisBase.OnIdChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick"> + <summary> + Provides a class for ticks and axis labels rendering. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.DefaultForegroundProperty"> + <summary> + Defines the DefaultForeground DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.LabelNameProperty"> + <summary> + Defines the LabelName DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.TickLineStyleProperty"> + <summary> + Defines the TickLineStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.TickDirectionProperty"> + <summary> + Defines the TickDirection DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick" /> class. + </summary> + <remarks></remarks> + </member> + <member name="E:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.TickLineStyle"> + <summary> + Gets or sets tick line style + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.LabelName"> + <summary> + Gets or sets label name + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryAxisLabelTick.TickDirection"> + <summary> + Gets or sets tick dirtection + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TickDirection"> + <summary> + Provides ability to set tick on the right or on the left side of the label + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TickDirection.Right"> + <summary> + Sets tick on the right side of the label + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Axes.TickDirection.Left"> + <summary> + Sets tick on the left side of the label + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TernaryNumericAxis"> + <summary> + Provides a Linear, Value Numeric Axis, capable of rendering double, int, short, byte, long ticks on the X, Y or Z-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" />. + </summary> + <remarks> + <param>All <see cref="T:SciChart.Charting.Visuals.Axes.TernaryAxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="!:ILabelProvider" /> derived type. </param> + <param>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="!:ILabelProvider" />. </param> + <param>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </param> + <param>Finally, all axis components can be styled.</param> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TernaryAxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.ITernaryAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TernaryNumericAxis" /> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is not Null and is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.CalculateDelta"> + <summary> + Calcuates the delta's for use in this render pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TernaryNumericAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis"> + <summary> + Provides a Linear, Value TimeSpan Axis, capable of rendering TimeSpan ticks on the X-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.CoerceZeroRange(SciChart.Data.Model.IRange)"> + <summary> + Coerce <seealso cref="T:SciChart.Data.Model.IRange" /> if current range is zero range + </summary> + <param name="maximumRange">Current maximum range</param> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.ToVisibleRange(System.IComparable,System.IComparable)"> + <summary> + When overriden in a derived class, converts a Min Max <see cref="T:System.IComparable" /> value into an <see cref="T:SciChart.Data.Model.IRange" /> of the correct type for this axis + </summary> + <param name="min">The min value</param> + <param name="max">The max value</param> + <returns> + The <see cref="T:SciChart.Data.Model.IRange" /> instance + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.GetDeltaCalculator"> + <summary> + Returns an instance of an + <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns> + An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.ConvertTickToDataValue(System.IComparable)"> + <summary> + When overridden in a derived class, converts a tick value to a data value. For instance, this may be overridden in the + <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> to convert between indices and DateTimes + </summary> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is not Null and is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxis.GetSupportedTypes"> + <summary> + Returns a list of types which current axis is designed to work with + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase"> + <summary> + A common base class for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.SciChart#Charting#Visuals#Axes#IAxisParams#MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.SciChart#Charting#Visuals#Axes#IAxisParams#MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.CalculateYRange(SciChart.Charting.Services.RenderPassInfo)"> + <summary> + Calculates the zoom-to-fit Y-Range of the axis, accounting for the data that + is in the viewport and applying any GrowBy margin + </summary> + <param name="renderPassInfo">Struct containing data for the current render pass</param> + <returns> + The VisibleRange of the axis + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.ToVisibleRange(System.IComparable,System.IComparable)"> + <summary> + When overriden in a derived class, converts a Min Max <see cref="T:System.IComparable" /> value into an <see cref="T:SciChart.Data.Model.IRange" /> of the correct type for this axis + </summary> + <param name="min">The min value</param> + <param name="max">The max value</param> + <returns>The <see cref="T:SciChart.Data.Model.IRange" /> instance</returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.CalculateDataRange"> + <summary> + Calculates data range of current axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.CalculateDelta"> + <summary> + Calcuates the delta's for use in this render pass + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.GetDataValue(System.Double)"> + <summary> + Transforms a pixel coordinate into a data value for this axis. + </summary> + <param name="pixelCoordinate"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.Axes.TimeSpanAxisBase.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.ChartModifierSurface"> + <summary> + Defines the ChartModifierSurface, which acts as an overlay <see cref="T:System.Windows.Controls.Canvas" /> on top of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> for drawing annotations, + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.ChartModifierSurface.ClipToBoundsProperty"> + <summary> + Defines the ClipToBounds DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.ChartModifierSurface.IsPolarChartProperty"> + <summary> + Defines the ClipToEllipseBounds DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ChartModifierSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.ChartModifierSurface" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ChartModifierSurface.ClipToBounds"> + <summary> + Gets or sets whether UIElements added to the ModifierSurface should clip to bounds or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ChartModifierSurface.IsPolarChart"> + <summary> + Gets whether this <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is a polar chart or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ChartModifierSurface.Children"> + <summary> + Gets the collection of UIElement children drawn on the canvas over the top of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ChartModifierSurface.Clear"> + <summary> + Clears all children off the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /></summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ChartModifierSurface.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The input point relative to this <see cref="T:SciChart.Core.Framework.IHitTestable" /></param> + <param name="relativeTo">The other <see cref="T:SciChart.Core.Framework.IHitTestable" /> to use when transforming the point</param> + <returns>The transformed Point</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ChartModifierSurface.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test, translated relative to RootGrid</param> + <returns>true if the Point is within the bounds</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ChartModifierSurface.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element relative to another <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Visuals.DefaultRasterizer"> + <summary> + Default render surface for use in SciChart + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Events.AnnotationDragDeltaEventArgs"> + <summary> + Event Args used by the <see cref="E:SciChart.Charting.Visuals.Annotations.AnnotationBase.DragDelta" /> event + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Events.AnnotationDragDeltaEventArgs.#ctor(System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Events.AnnotationDragDeltaEventArgs" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.AnnotationDragDeltaEventArgs.HorizontalOffset"> + <summary> + Gets / Sets HorizontalOffset property + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.AnnotationDragDeltaEventArgs.VerticalOffset"> + <summary> + Gets / Sets VerticalOffset property + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Events.AxisAlignmentChangedEventArgs"> + <summary> + Event Args used by the <see cref="E:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRangeChanged" /> event + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.AxisAlignmentChangedEventArgs.OldAlignment"> + <summary> + Gets the old <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.AxisAlignmentChangedEventArgs.NewAlignment"> + <summary> + Gets the new <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.AxisAlignmentChangedEventArgs.AxisId"> + <summary> + Gets the Id of <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />, which alignment has been changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Events.AxisAlignmentChangedEventArgs.#ctor(System.String,SciChart.Charting.Visuals.Axes.AxisAlignment,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Events.AxisAlignmentChangedEventArgs" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Events.SelectedRangeEventType"> + <summary> + Enumeration constants to define the possible event type during scrolling of <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Events.SelectedRangeEventType.ExternalSource"> + <summary> + <see cref="P:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRange" /> was changed externally + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Events.SelectedRangeEventType.Drag"> + <summary> + <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport was dragged without resizing + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Events.SelectedRangeEventType.Resize"> + <summary> + <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport was resized with one of resizing grips + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Events.SelectedRangeEventType.Moved"> + <summary> + <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport was moved after click on non selected area + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Events.SelectedRangeChangedEventArgs"> + <summary> + Event arguments for the <see cref="E:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRangeChanged" /> event + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.SelectedRangeChangedEventArgs.SelectedRange"> + <summary> + Gets the range for the event args + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.SelectedRangeChangedEventArgs.EventType"> + <summary> + Gets the <see cref="P:SciChart.Charting.Visuals.Events.SelectedRangeChangedEventArgs.EventType" /> value which describes current event type + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Events.SelectedRangeChangedEventArgs.#ctor(System.IComparable,System.IComparable,SciChart.Charting.Visuals.Events.SelectedRangeEventType)"> + <summary> + sets the range start and range stop for the event args + </summary> + <param name="newRangeStart">The new range start set</param> + <param name="newRangeStop">The new range stop set</param> + </member> + <member name="M:SciChart.Charting.Visuals.Events.SelectedRangeChangedEventArgs.#ctor(SciChart.Data.Model.IRange,SciChart.Charting.Visuals.Events.SelectedRangeEventType)"> + <summary> + sets the range start and range stop for the event args + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs"> + <summary> + Event Args used by the <see cref="E:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRangeChanged" /> event + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs.OldVisibleRange"> + <summary> + Gets the old <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> before the operation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs.NewVisibleRange"> + <summary> + Gets the new <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> before the operation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs.IsAnimating"> + <summary> + Gets the value, indicating whether the current notification was caused by animation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs.#ctor(SciChart.Data.Model.IRange,SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Events.VisibleRangeChangedEventArgs" /> class. + </summary> + <param name="oldRange">The old range.</param> + <param name="newRange">The new range.</param> + <param name="isAnimationChange">The value, indicating whether the notification is fired during animation</param> + </member> + <member name="T:SciChart.Charting.Visuals.HeatmapZAxisType"> + <summary> + Defines constants for different axis types in <see cref="T:SciChart.Charting.Visuals.HeatmapColorMap" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapZAxisType.NumericAxis"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.HeatmapColorMap" /> uses numeric axis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapZAxisType.LogarithmicNumeriAxis"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.HeatmapColorMap" /> uses logarithmic numeric axis + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.HeatmapColorMap"> + <summary> + A Legend Control for the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" />, which gives a visual representation of double-to-color mapping in the heatmap + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.ColorMapProperty"> + <summary> + Defines the ColorMap DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.AxisTypeProperty"> + <summary> + Defines the AxisType DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.MinimumProperty"> + <summary> + Defines the Minimum DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.MaximumProperty"> + <summary> + Defines the Maximum DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.TextFormattingProperty"> + <summary> + Defines the TextFormatting DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.AxisStyleProperty"> + <summary> + Defines the AxisStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.OrientationProperty"> + <summary> + Defines the Orientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.EnableAxisDragProperty"> + <summary> + Defines the EnableAxisDrag DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.HeatmapColorMap.MinimumMaximumProperty"> + <summary> + Defines the MinimumMaximum DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.HeatmapColorMap.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.HeatmapColorMap" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.MinimumMaximum"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.MinimumMaximum" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.Orientation"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.Orientation" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.AxisType"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.AxisType" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.ColorMap"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.ColorMap" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.Minimum"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.Minimum" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.Maximum"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.Maximum" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.TextFormatting"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.TextFormatting" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.AxisStyle"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.AxisStyle" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.HeatmapColorMap.EnableAxisDrag"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.HeatmapColorMap.EnableAxisDrag" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.HeatmapColorMap.OnApplyTemplate"> + <summary> + Initializes the default template elements + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.HeatmapColorMap.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="T:SciChart.Charting.Visuals.IChartModifierSurface"> + <summary> + Defines the base interface to the Canvas that <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances interact with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IChartModifierSurface.ToolTip"> + <summary> + Gets or sets the Tooltip shown on this element + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IChartModifierSurface.ClipToBounds"> + <summary> + Gets or sets whether UIElements added to the ModifierSurface should clip to bounds or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IChartModifierSurface.Children"> + <summary> + Gets the collection of UIElement children drawn on the canvas + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.IChartModifierSurface.Clear"> + <summary> + Clears all children off the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.IChartModifierSurface.CaptureMouse"> + <summary> + Captures the mouse on the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> canvas + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.IChartModifierSurface.ReleaseMouseCapture"> + <summary> + Releases the mouse capture on the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> canvas + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.IDrawable"> + <summary> + Defines the base interface for an object that can be drawn + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IDrawable.Width"> + <summary> + Gets or sets the width of the <see cref="T:SciChart.Charting.Visuals.IDrawable" /> in pixels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IDrawable.Height"> + <summary> + Gets or sets the height of the <see cref="T:SciChart.Charting.Visuals.IDrawable" /> in pixels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.IDrawable.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called when the instance is drawn + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> used for drawing</param> + <param name="renderPassData">Contains arguments and parameters for this render pass</param> + </member> + <member name="T:SciChart.Charting.Visuals.ISciChartController"> + <summary> + An interface to a subset of methods on the SciChartSurface. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartController.ZoomExtents"> + <summary> + Zooms the chart to the extents of the data, plus any X or Y Grow By fraction set on the X and Y Axes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartController.AnimateZoomExtents(System.TimeSpan)"> + <summary> + Zooms to extents with the specified animation duration + </summary> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartController.ZoomExtentsY"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartController.AnimateZoomExtentsY(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartController.ZoomExtentsX"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartController.AnimateZoomExtentsX(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.ZoomStates"> + <summary> + Defines ZoomStates for the <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.ZoomStates.AtExtents"> + <summary> + ZoomStates is at extents. This is if the user has called <see cref="M:SciChart.Charting.Visuals.SciChartSurface.ZoomExtents" />, or, the user has double clicked on the <see cref="T:SciChart.Charting.ChartModifiers.ZoomExtentsModifier" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.ZoomStates.UserZooming"> + <summary> + ZoomStates: User has initiated a Zoom operation + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.ISciChartSurface"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, which contains a single <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> viewport + for rendering multiple <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />, X and Y <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instances, and where each <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> may have a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data source. + + The <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have zero to many <see cref="T:System.Windows.UIElement" /><see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase">annotations</see> and may have a <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> to enable interaction with the chart. + Where many <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase">ChartModifiers</see> are used, you may use a <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> to group them. + </summary> + <seealso cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> + </member> + <member name="E:SciChart.Charting.Visuals.ISciChartSurface.AxisAlignmentChanged"> + <summary> + Event raised when alignment of any axis changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.ISciChartSurface.AnnotationsCollectionNewCollectionAssigned"> + <summary> + Event raised when Annotations DependencyProperty is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.ISciChartSurface.YAxesCollectionNewCollectionAssigned"> + <summary> + Event raised when YAxes DependnecyProperty is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.ISciChartSurface.XAxesCollectionNewCollectionAssigned"> + <summary> + Event raised when XAxes DependnecyProperty is changed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.ChartModifier"> + <summary> + Gets or sets the current ChartModifier, which alters the behaviour of the chart + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.Annotations"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> which provides renderable annotations over the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.XAxis"> + <summary> + Gets or sets the XAxis control on the SciChartSurface + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.YAxis"> + <summary> + Gets or sets the primary YAxis control on the SciChartSurface (default side=Right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.YAxes"> + <summary> + Gets the collection of Y-Axis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> that this SciChartSurface measures against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.XAxes"> + <summary> + Gets the collection of X-Axis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> that this SciChartSurface measures against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.GridLinesPanel"> + <summary> + Gets the GridLinesPanel where gridlines are drawn + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.RenderableSeries"> + <summary> + Gets the collection of RenderableSeries that this SciChartSurface draws. + </summary> + <remarks>A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is bound to an <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> derived type. + If a RenderableSeries.IsEnabled=false, then this series is skipped when evaluating the series to draw</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.SelectedRenderableSeries"> + <summary> + Gets the collection of RenderableSeries that are selected. + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.RootGrid"> + <summary> + Gets the Root Grid that hosts the SciChart RenderSurface, GridLinesPanel, X-Axis and Y-Axes (Left and right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.ViewportManager"> + <summary> + Gets or sets the current ViewportManager, which alters the behaviour of the viewport (X,Y range) when the chart is rendered + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.ZoomHistoryManager"> + <summary> + Gets or sets the current ZoomHistoryManager, which is responsible for VisibleRange history for all axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.AnnotationOverlaySurface"> + <summary> + Gets the Annotation Canvas over the chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.AnnotationUnderlaySurface"> + <summary> + Gets the Annotation Canvas under the chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.AdornerLayerCanvas"> + <summary> + Gets the Adorner Layer over the chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.LicenseDaysRemaining"> + <summary> + Gets the number of license days remaining + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.SeriesSource"> + <summary> + The SeriesSource property allows data-binding to a collection of <see cref="T:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel" /> instances, + for pairing of <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> with <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurface.ZoomState"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.ISciChartSurface.ZoomState" /> of the SciChartSurface, e.g. if user is zooming, or not + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.OnArrangeSciChart"> + <summary> + Preparations for a render pass, called internally, returns the viewport size + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current HitTestable element + </summary> + <param name="point">The point to test</param> + <returns>true if the Point is within the bounds</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current HitTestable element relative to another HitTestable element + </summary> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other hittestable element + </summary> + <param name="point">The point.</param> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.GetWindowedYRange(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Data.Model.IRange)"> + <summary> + Equivalent of calling YAxis.GetMaximumRange() however returns the max range only for that axis (by the data-series on it) + </summary> + <param name="yAxis"></param> + <param name="xRange"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.OnAxisAlignmentChanged(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Called internally by SciChart when <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment" /> changes. Allows the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to reposition the axis, e.g. at the top, left, bottom, right + </summary> + <param name="axis"></param> + <param name="oldValue"></param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.OnIsCenterAxisChanged(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally by SciChart when <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.IsCenterAxis" /> changes. Allows the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to place the axis in the center of chart + </summary> + <param name="axis"></param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.DetachDataSeries(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Detaches listeners for DataSeries.DataSeriesChanged + </summary> + <param name="dataSeries"></param> + <param name="renderableSeries"></param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.AttachDataSeries(SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Attaches listeners for DataSeries.DataSeriesChanged + </summary> + <param name="dataSeries"></param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurface.ExportToBitmapSource"> + <summary> + Export snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to <see cref="T:System.Windows.Media.Imaging.BitmapSource" /></summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderPriority"> + <summary> + Enumeration constants to define the render priority for series rendering on the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderPriority.Immediate"> + <summary> + Renders immediately on data update, as opposed to waiting for the CompositionTarget.Rendering event + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderPriority.Normal"> + <summary> + SciChart renders whenever there is new data and the CompositionTarget.Rendering event has fired. + This is the default option + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderPriority.Low"> + <summary> + SciChart renders whenever there is new data and the CompositionTarget.Rendering event has fired, + but with a lower priority than input (mouse) events + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderPriority.Manual"> + <summary> + Never redraws automatically. You must manually call InvalidateElement() or ZoomExtents() on the SciChartSurface in order to get it to redraw + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.ISciChartSurfaceBase"> + <summary> + Common base interface for <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> derived classes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.DebugWhyDoesntSciChartRender"> + <summary> + Gets or sets a flag whether SciChart should output rendering exceptions and 'Why Scichart Doesn't Render' reasons to the Debug Console. + Default is True. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.IsVisible"> + <summary> + Gets the a value indicating whether this <see cref="T:SciChart.Charting.Visuals.ISciChartSurfaceBase" /> is visible + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.SyncRoot"> + <summary> + A synchronization object which is locked during a render pass. If you lock this SciChart will not render and will be blocked on the UI thread until the lock is released. + + This is used internally by DataSeries to lock the SciChartSurface when bulk updates are done. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.ChartTitle"> + <summary> + Gets or sets an optional Chart Title, displayed above the chart surface + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.ClipModifierSurface"> + <summary> + Gets or sets a value whether to clip the ChartModifierSurface property to bounds. Fefault false + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.ModifierSurface"> + <summary> + Gets the ModifierSurface, which is used to draw primitives for the Chart Modifiers + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.RenderPriority"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.RenderPriority" />. The default is <see cref="F:SciChart.Charting.Visuals.RenderPriority.Normal" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.RenderSurface"> + <summary> + Gets or sets the RenderSurface implementation that this <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> uses. Default implementation for a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + is a <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" />, however SciChart supports + additional render surfaces, providing high quality software and high speed hardware accelerated or 3D renderers. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.IsDisposed"> + <summary> + True if the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> has been disposed. If so do not draw! + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.ISciChartSurfaceBase.Rendered"> + <summary> + Event raised at the end of a single render pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.OnSciChartRendered"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.SciChartSurfaceBase.Rendered" /> event, fired at the end of a render pass immediately before presentation to the screen + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartSurfaceBase.EnableMultiThreadedRendering"> + <summary> + Gets or sets a value indicating if SciChart can use Multi-Threaded rendering (where available). This will seek to use multiple cores to speed up the drawing process but will result in higher CPU usage. This is recommended if the bottleneck is drawing, but not recommended if the bottleneck is some other process e.g. simulation or computation + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.SetMouseCursor(System.Windows.Input.Cursor)"> + <summary> + Sets a Cursor on the SciChartSurface + </summary> + <param name="cursor">The new Cursor</param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.ExportToBitmapSource"> + <summary> + Export snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to <see cref="T:System.Windows.Media.Imaging.BitmapSource" /></summary> + <returns>The bitmap of the current SciChartSurface</returns> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.ExportToBitmapSource(System.Boolean,System.Nullable{System.Windows.Size})"> + <summary> + Exports to bitmap source. + </summary> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output. When null, outputs at the current size. When a size is specified, the chart is cloned in memory and exported at the new size</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.ExportToFile(System.String,SciChart.Core.ExportType,System.Boolean)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.ExportToFile(System.String,SciChart.Core.ExportType,System.Boolean,System.Windows.Size)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.ExportToStream(SciChart.Core.ExportType,System.Boolean)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to Stream + </summary> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + <returns>The <see cref="T:System.IO.Stream" /> which contains the image of the chart</returns> + </member> + <member name="M:SciChart.Charting.Visuals.ISciChartSurfaceBase.ExportToStream(SciChart.Core.ExportType,System.Boolean,System.Windows.Size)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to Stream + </summary> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + <param name="size">Defines size for export output</param> + <returns>The <see cref="T:System.IO.Stream" /> which contains the image of the chart</returns> + </member> + <member name="T:SciChart.Charting.Visuals.IMainGrid"> + <summary> + Defines the interface to the Maingrid, a root grid which hosts the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="T:SciChart.Charting.Visuals.MainGrid"> + <summary> + Defines the Maingrid, a root grid which hosts the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.MainGrid.RegisterTouchEvents"> + <summary> + When true, registers touch events (default TRUE). Set to false if you do not wish to subscribe to touch events + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.MainGrid.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting.Visuals.MainGrid" /> class. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.MainGrid.MouseMiddleButtonDown"> + <summary> + Occurs when the middle mouse button is pressed while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.MainGrid.MouseMiddleButtonUp"> + <summary> + Occurs when the middle mouse button is released while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. However, this event will only be raised if a caller marks the preceding <see cref="E:System.Windows.UIElement.MouseRightButtonDown" /> event as handled; see Remarks. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.MainGrid.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.MainGrid" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.MainGrid.SciChart#Core#Utility#Mouse#IPublishTouchEvents#RegisterTouchEvents"> + <summary> + When true, touch events are enabled, else disabled + + To set this property, set the application wide <see cref="P:SciChart.Charting.Visuals.MainGrid.RegisterTouchEvents" /> static property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.MainGrid.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the othfer hittestable element + </summary> + <param name="point">The point.</param> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.MainGrid.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current HitTestable element + </summary> + <param name="point">The point to test</param> + <returns>true if the Point is within the bounds</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.MainGrid.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current HitTestable element relative to another HitTestable element + </summary> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting.Visuals.ManipulationMargins"> + <summary> + Contains properties related to mouse and touch manipulation precision. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ManipulationMargins.AnnotationResizingThumbSize"> + <summary> + Defines size of thumbs on the corners of annotations, which serve for annotation resizing. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ManipulationMargins.AnnotationResizingMaxSize"> + <summary> + Defines size of thumbs on the corners of annotations, which serve for annotation resizing. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ManipulationMargins.AnnotationLineWidth"> + <summary> + Defines width of ghost line around annotation line that can be dragged to move the annotation line. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.PaletteProviders.IFillPaletteProvider"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override the fill brush on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + by setting or binding to the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PaletteProviders.IFillPaletteProvider.OverrideFillBrush(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Int32,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Overrides the fill brush of the attached <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. + Return null to keep the default series fill. + Return a value to override the series fill. + </summary> + <param name="rSeries">The source <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="index">The index of the data-point. To get X,Y values use rSeries.DataSeries.XValues[index] etc...</param> + <param name="metadata">The PointMetadata associated with this X,Y data-point.</param> + </member> + <member name="T:SciChart.Charting.Visuals.PaletteProviders.IHeatmapPaletteProvider"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override a cell color on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries" /> + by setting or binding to the <see cref="!:BaseHeatmapRenderableSeries.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PaletteProviders.IHeatmapPaletteProvider.OverrideCellColor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Int32,System.Int32,System.IComparable,System.Windows.Media.Color,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Overrides the color of the cell at X,Y index in a heatmap. The return value is ARGB color. + </summary> + <param name="rSeries">The heatmap renderable series.</param> + <param name="xIndex">X Index to the heatmap data.</param> + <param name="yIndex">Y Index to the heatmap data.</param> + <param name="zValue">Z value at X index, Y index.</param> + <param name="cellColor">Current color of the cell.</param> + <param name="metadata">Metadata of the cell.</param> + <returns>Returns the ARGB Color for the cell.</returns> + </member> + <member name="T:SciChart.Charting.Visuals.PaletteProviders.PointPaletteInfo"> + <summary> + Defines the interface to represent color overrides for PointMarkers by <see cref="M:SciChart.Charting.Visuals.PaletteProviders.IPointMarkerPaletteProvider.OverridePointMarker(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Int32,SciChart.Charting.Model.DataSeries.IPointMetadata)" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PaletteProviders.PointPaletteInfo.Stroke"> + <summary> + Used to override <see cref="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Stroke" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PaletteProviders.PointPaletteInfo.Fill"> + <summary> + Used to override <see cref="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Fill" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider"> + <summary> + Defines the most common interface to a PaletteProvider. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider.OnBeginSeriesDraw(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Called at the start of an renderable series rendering, before the current draw operation. + </summary> + <param name="rSeries">The source <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. You can access, cast and cache the DataSeries via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries" /> property</param> + </member> + <member name="T:SciChart.Charting.Visuals.PaletteProviders.IPointMarkerPaletteProvider"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override the Fill and Stroke color of <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" /> + by setting or binding to the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PaletteProviders.IPointMarkerPaletteProvider.OverridePointMarker(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Int32,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Overrides the color of the PointMarkers on the attached <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + Return <value>Null</value> to keep the default <see cref="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Stroke" /> and <see cref="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Fill" />. + Set either <see cref="P:SciChart.Charting.Visuals.PaletteProviders.PointPaletteInfo.Stroke" /> or <see cref="P:SciChart.Charting.Visuals.PaletteProviders.PointPaletteInfo.Fill" /> + to override <see cref="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Stroke" /> or <see cref="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Fill" /> correspondingly. + </summary> + <param name="rSeries">The source <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="index">The index of the data-point. To get X,Y values use rSeries.DataSeries.XValues[index] etc...</param> + <param name="metadata">The PointMetadata associated with this X,Y data-point.</param> + </member> + <member name="T:SciChart.Charting.Visuals.PaletteProviders.IStrokePaletteProvider"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override the stroke color on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + by setting or binding to the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PaletteProviders.IStrokePaletteProvider.OverrideStrokeColor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Int32,SciChart.Charting.Model.DataSeries.IPointMetadata)"> + <summary> + Overrides the color of the outline on the attached <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + Return null to keep the default series color. + Return a value to override the series color. + </summary> + <param name="rSeries">The source <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="index">The index of the data-point. To get X,Y values use rSeries.DataSeries.XValues[index] etc...</param> + <param name="metadata">The PointMetadata associated with this X,Y data-point.</param> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"> + <summary>A base class for Bitmap-rendered Point-Markers, which are small markers drawn once per data-point on a BaseRenderableSeries</summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <example> + <code title="BasePointMarker usage" description="Shows how to create a derived class of BasePointMarker to render a custom pointmarker" lang="cs"> + public class CustomPointMarker : BasePointMarker<br /> + {<br /> + protected override void DrawInternal(IRenderContext2D context, IEnumerable<Point> centers, IPen2D pen, IBrush2D brush)<br /> + {<br /> + // TODO: Render a single point marker using IRenderContext2D<br /> + }<br /> + } + </code> + </example> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerTemplateProperty"> + <summary> + Defines the PointMarkerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.StrokeProperty"> + <summary> + Defines the Stroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.FillProperty"> + <summary> + Defines the Fill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.AntiAliasingProperty"> + <summary> + Defines the AntiAliasing DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerBatchStrategyProperty"> + <summary> + Defines the PointMarkerBatchStrategy DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker._xOffset"> + <summary> + The offset for the X coordinate of PointMarker + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.PointMarkers.BasePointMarker._yOffset"> + <summary> + The offset for the Y coordinate of PointMarker + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerBatchStrategy"> + <summary> + Defines the batching strategy for this <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerTemplate"> + <summary> + Gets or sets the PointMarker ControlTemplate, which defines the point-marker Visual to be rendered on each datapoint of the series + </summary> + <remarks>The ControlTemplate is used to template the visuals only for a blank control, creating a new instance per <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. + the resulting FrameworkElement is cached to bitmap and drawn on each redraw of the series, so any triggers, mouse interactions on the ControlTemplate will be lost</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.Stroke"> + <summary> + Gets or sets the Stroke (the outline) of the PointMarker. May be Transparent to ignore + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.Fill"> + <summary> + Gets or sets the solid color Fill of the PointMarker. May be Transparent to ignore + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the PointMarker stroke. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which this <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is associated with. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.AntiAliasing"> + <summary> + Gets or sets the AntiAliasing property, which is used when drawing the stroke. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.Attach(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Called when a <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is attached to an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + <param name="series">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which this <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is associated with.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.Detach"> + <summary> + Called when a <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is detached from an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.BeginBatch(SciChart.Drawing.Common.IRenderContext2D,System.Nullable{System.Windows.Media.Color},System.Nullable{System.Windows.Media.Color})"> + <summary> + Called when a batched draw operation is about to begin. All subsequent draw operations will have the same width, height, render context and stroke, fill. + </summary> + <param name="context">The render context.</param> + <param name="strokeColor">Color of the stroke.</param> + <param name="fillColor">Color of the fill.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.MoveTo(SciChart.Drawing.Common.IRenderContext2D,System.Double,System.Double,System.Int32)"> + <summary> + Called when a batched draw operation is being updated to this x,y position. + </summary> + <param name="context">The render context.</param> + <param name="x">The x-position (pixels).</param> + <param name="y">The y-position (pixels).</param> + <param name="index">The index to the original data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.IsInBounds(System.Double,System.Double)"> + <summary> + Determines whether the X,Y point is within bounds of the Viewport for drawing + </summary> + <param name="x">The x position (pixels).</param> + <param name="y">The y position (pixels).</param> + <returns>True, if in bounds, else false</returns> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.EndBatch(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Ends a batch draw operation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.Draw(SciChart.Drawing.Common.IRenderContext2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Renders the PointMarker on each <see cref="T:System.Windows.Point" /> passed in with Fill and Stroke values. Each point is a coordinate in the centre of the PointMarker. + </summary> + <param name="context">The RenderContext to draw too</param> + <param name="centers">The collection of Points to render the Point Markers at</param> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.OnPropertyChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Should be called when any DependencyProperty value changes on the <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived class + </summary> + <param name="d">The sender</param> + <param name="e">The arguments</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.OnBatchingStrategyChanged(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the PointMarkerBatchStrategyProperty changes + </summary> + <param name="d">The dependency object.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.Dispose"> + <summary> + Disposes any cached resources, e.g. when the Fill or Stroke is changed, any cached pens or brushes are also disposed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.XOffset"> + <summary> + Gets offset for the X coordinate of PointMarker + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.YOffset"> + <summary> + Gets offset for the Y coordinate of PointMarker + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"> + <summary> + Allows any custom drawing to be rendered as a Sprite (bitmap) at each each data-point location using the following XAML syntax. + Derived classes should override <see cref="M:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.RenderToCache(SciChart.Drawing.Common.IRenderContext2D,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D)" /> to specify the desired drawing. + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <example> + <code title="BitmapSpriteBase usage" description="Shows how to create a derived class of BitmapSpriteBase to render a custom pointmarker" lang="cs"> + public class StarPointMarker : BitmapSpriteBase + { + // RenderToCache draws once, and the resultant cached bitmap is repeated using SciChart's fast drawing engine + protected override void RenderToCache(IRenderContext2D context, IPen2D strokePen, IBrush2D fillBrush) + { + var offset = 2d; + var polygon = new Point[] + { + new Point(Width/2, 0), + new Point(Width/2 + offset, Height/2 - offset), + new Point(Width, Height/2), + new Point(Width/2 + offset, Height/2 + offset), + new Point(Width/2, Height), + new Point(Width/2-offset, Height/2+offset), + new Point(0, Height/2), + new Point(Width/2-offset, Height/2-offset), + new Point(Width/2, 0) + }; + + context.FillPolygon(fillBrush, polygon); + context.DrawLines(strokePen, polygon); + } + } + </code> + </example> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.SciChart#Charting#Visuals#PointMarkers#IPointMarker#Width"> + <summary> + Gets or sets the width of the element. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.SciChart#Charting#Visuals#PointMarkers#IPointMarker#Height"> + <summary> + Gets or sets the suggested height of the element. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.RenderSize"> + <summary> + Gets the Size NxM of the bitmap sprite in pixels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.Draw(SciChart.Drawing.Common.IRenderContext2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + When overridden in a derived class, draws the point markers at specified collection of <see cref="T:System.Windows.Point" /> centers + </summary> + <param name="context">The RenderContext to draw with</param> + <param name="centers">The Centres of the point markers</param> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Drawing.Common.IPen2D" /> + <seealso cref="T:SciChart.Drawing.Common.IBrush2D" /> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.Dispose"> + <summary> + Disposes any cached resources, e.g. when the Fill or Stroke is changed, any cached pens or brushes are also disposed. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase.GetSprite"> + <summary> + Used to obtain a cached sprite of this PointMarker. + </summary> + <remarks>Gets disposed internally when PointMarker properties change. + Cannot be used after being disposed.</remarks> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy"> + <summary> + <para>The <see cref="T:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy" /> is the default <see cref="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerBatchStrategy" />, which clusters points and + does not draw points to the same X,Y index. </para> + <para>This greatly improves performance in the case where many markers are drawn to the same location, but can introduce visual anomalies e.g. when changing color of the PointMarker frequently, or drawing markers of different size at each point</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.AttachToMarker(SciChart.Charting.Visuals.PointMarkers.BasePointMarker)"> + <summary> + Attaches the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy" /> to the parent <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /></summary> + <param name="marker">The marker.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.DetachMarker(SciChart.Charting.Visuals.PointMarkers.BasePointMarker)"> + <summary> + Detaches the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy" /> from the parent <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /></summary> + <param name="marker">The marker.</param> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.ClusteredPoints"> + <summary> + Gets the clustered points array (Treat as Read-ONLY) + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.BeginBatch(SciChart.Drawing.Common.IRenderContext2D,System.Nullable{System.Windows.Media.Color},System.Nullable{System.Windows.Media.Color})"> + <summary> + Called when a batched draw operation is about to begin. All subsequent draw operations will have the same width, height, render context and stroke, fill. + </summary> + <param name="context">The render context.</param> + <param name="strokeColor">Color of the stroke.</param> + <param name="fillColor">Color of the fill.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.MoveTo(SciChart.Drawing.Common.IRenderContext2D,System.Double,System.Double,System.Int32)"> + <summary> + Called when a batched draw operation is being updated to this x,y position. + </summary> + <param name="context">The render context.</param> + <param name="x">The x-position (pixels).</param> + <param name="y">The y-position (pixels).</param> + <param name="index">The index to the original data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.EndBatch(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Ends a batch draw operation. + </summary> + <param name="context"></param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy.IsInBounds(System.Double,System.Double)"> + <summary> + Determines whether the X,Y point is within bounds of the Viewport for drawing + </summary> + <param name="x">The x position (pixels).</param> + <param name="y">The y position (pixels).</param> + <returns> + True, if in bounds, else false + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"> + <summary> + Allows a Cross to be rendered at each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="CrossPointMarker usage" description="Shows how to instantiate a CrossPointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:CrossPointMarker Width="7" Height="7" Fill="Yellow" Stroke="White" StrokeThickness="1"/> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy"> + <summary> + <para>The <see cref="T:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy" /> is a <see cref="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerBatchStrategy" />, which draws every point (does not perform clustering or resampling) + </para> + <para>This results in lower performance where many markers are drawn to the same location, but can solve problems that occur when <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPointMarkerPaletteProvider" /> is used and certain markers are being excluded because of clustering</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy.BeginBatch(SciChart.Drawing.Common.IRenderContext2D,System.Nullable{System.Windows.Media.Color},System.Nullable{System.Windows.Media.Color})"> + <summary> + Called when a batched draw operation is about to begin. All subsequent draw operations will have the same width, height, render context and stroke, fill. + </summary> + <param name="context">The render context.</param> + <param name="strokeColor">Color of the stroke.</param> + <param name="fillColor">Color of the fill.</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy.MoveTo(SciChart.Drawing.Common.IRenderContext2D,System.Double,System.Double,System.Int32)"> + <summary> + Called when a batched draw operation is being updated to this x,y position. + </summary> + <param name="context">The render context.</param> + <param name="x">The x-position (pixels).</param> + <param name="y">The y-position (pixels).</param> + <param name="index">The index to the original data.</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy.EndBatch(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Ends a batch draw operation. + </summary> + <param name="context"></param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy.IsInBounds(System.Double,System.Double)"> + <summary> + Determines whether the X,Y point is within bounds of the Viewport for drawing + </summary> + <param name="x">The x position (pixels).</param> + <param name="y">The y position (pixels).</param> + <returns> + True, if in bounds, else false + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy.AttachToMarker(SciChart.Charting.Visuals.PointMarkers.BasePointMarker)"> + <summary> + Attaches the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy" /> to the parent <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /></summary> + <param name="marker">The marker.</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.DefaultPointMarkerBatchStrategy.DetachMarker(SciChart.Charting.Visuals.PointMarkers.BasePointMarker)"> + <summary> + Detaches the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy" /> from the parent <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /></summary> + <param name="marker">The marker.</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"> + <summary> + Allows a Ellipse to be rendered at each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="EllipsePointmarker usage" description="Shows how to instantiate a EllipsePointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:EllipsePointMarker Width="7" Height="7" Fill="Yellow" Stroke="White" StrokeThickness="1"/> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"> + <summary> + Allows an inverted Triangle to be rendered at each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="InvertedTrianglePointMarker usage" description="Shows how to instantiate an InvertedTrianglePointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:InvertedTrianglePointMarker Width="7" Height="7" Fill="Yellow" Stroke="White" StrokeThickness="1"/> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker"> + <summary> + Specifies interface for rendering point markers. a point marker is something which is displayed at data points. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Stroke"> + <summary> + Gets or sets the Stroke Color (outline) of the PointMarker. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Fill"> + <summary> + Gets or sets the Fill Color (fill) of the PointMarker. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Width"> + <summary> + Gets or sets the Width of the PointMarker in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Height"> + <summary> + Gets or sets the Height of the PointMarker in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the PointMarker outline in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PointMarkers.IPointMarker.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which this <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is associated with. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Attach(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Called when a <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is attached to an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + <param name="series">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which this <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is associated with.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Detach"> + <summary> + Called when a <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarker" /> instance is detached from an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarker.Draw(SciChart.Drawing.Common.IRenderContext2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Renders the PointMarker on each <see cref="T:System.Windows.Point" /> passed in with Fill and Stroke values. Each point is a coordinate in the centre of the PointMarker. + </summary> + <param name="context">The RenderContext to draw too.</param> + <param name="centers">The collection of Points to render the Point Markers at.</param> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Drawing.Common.IPen2D" /> + <seealso cref="T:SciChart.Drawing.Common.IBrush2D" /> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarker.BeginBatch(SciChart.Drawing.Common.IRenderContext2D,System.Nullable{System.Windows.Media.Color},System.Nullable{System.Windows.Media.Color})"> + <summary> + Called when a batched draw operation is about to begin. All subsequent draw operations will have the same width, height, rendercontext and pen, brush. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarker.MoveTo(SciChart.Drawing.Common.IRenderContext2D,System.Double,System.Double,System.Int32)"> + <summary> + Called when a batched draw operation is being updated to this x,y position. + </summary> + <param name="context">The render context.</param> + <param name="x">The x-position (pixels).</param> + <param name="y">The y-position (pixels).</param> + <param name="index">The index to the original data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarker.EndBatch(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Ends a batch draw operation. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy"> + <summary> + Defines the interface to a PointMarker Batching Strategy, typically set on <see cref="P:SciChart.Charting.Visuals.PointMarkers.BasePointMarker.PointMarkerBatchStrategy" /> property + </summary> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.ClusteredPointMarkerBatchStrategy" /> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy.BeginBatch(SciChart.Drawing.Common.IRenderContext2D,System.Nullable{System.Windows.Media.Color},System.Nullable{System.Windows.Media.Color})"> + <summary> + Called when a batched draw operation is about to begin. All subsequent draw operations will have the same width, height, rendercontext and stroke, fill. + </summary> + <param name="context">The render context.</param> + <param name="strokeColor">Color of the stroke.</param> + <param name="fillColor">Color of the fill.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy.MoveTo(SciChart.Drawing.Common.IRenderContext2D,System.Double,System.Double,System.Int32)"> + <summary> + Called when a batched draw operation is being updated to this x,y position. + </summary> + <param name="context">The render context.</param> + <param name="x">The x-position (pixels).</param> + <param name="y">The y-position (pixels).</param> + <param name="index">The index to the original data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy.EndBatch(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Ends a batch draw operation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy.IsInBounds(System.Double,System.Double)"> + <summary> + Determines whether the X,Y point is within bounds of the Viewport for drawing + </summary> + <param name="x">The x position (pixels).</param> + <param name="y">The y position (pixels).</param> + <returns>True, if in bounds, else false</returns> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy.AttachToMarker(SciChart.Charting.Visuals.PointMarkers.BasePointMarker)"> + <summary> + Attaches the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy" /> to the parent <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /></summary> + <param name="marker">The marker.</param> + </member> + <member name="M:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy.DetachMarker(SciChart.Charting.Visuals.PointMarkers.BasePointMarker)"> + <summary> + Detaches the <see cref="T:SciChart.Charting.Visuals.PointMarkers.IPointMarkerBatchStrategy" /> from the parent <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /></summary> + <param name="marker">The marker.</param> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"> + <summary> + Allows any WPF UIElement to be rendered as a Sprite (bitmap) at each each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="SpritePointMarker usage" description="Shows how to instantiate a SpritePointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:SpritePointMarker> + <s:SpritePointMarker.PointMarkerTemplate> + <ControlTemplate> + <!-- This can be any WPF UIElement, rendered as bitmnap and repeated per point --> + <Ellipse Width="7" Height="7" Fill="Magenta" Stroke="White"> + </ControlTemplate> + </s:SpritePointMarker.PointMarkerTemplate> + </s:SpritePointMarker> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"> + <summary> + Allows a Square to be rendered at each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="SquarePointMarker usage" description="Shows how to instantiate a SquarePointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:SquarePointMarker Width="7" Height="7" Fill="Yellow" Stroke="White" StrokeThickness="1"/> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"> + <summary> + Allows a Triangle to be rendered at each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="TrianglePointMarker usage" description="Shows how to instantiate a TrianglePointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:TrianglePointMarker Width="7" Height="7" Fill="Yellow" Stroke="White" StrokeThickness="1"/> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"> + <summary> + Allows am X to be rendered at each data-point location using the following XAML syntax + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> derived types use fast bitmap rendering to draw data-points to the screen. This means that + traditional WPF style tooltips won't work. For that we need to use the HitTest API. Please see the HitTest sections of the user manual + for more information</remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BitmapSpriteBase"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.CrossPointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.EllipsePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.InvertedTrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SpritePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.SquarePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.TrianglePointMarker"></seealso> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.XPointMarker"></seealso> + <example> + <code title="XPointMarker usage" description="Shows how to instantiate a XPointMarker inline in XAML. Note when templating or styling a series, you will need to use the BaseRenderableSeries.PointMarkerTemplate property instead" lang="xaml"> + <s:FastLineRenderableSeries> + <s:FastLineRenderableSeries.PointMarker> + <s:XPointMarker Width="7" Height="7" Fill="Yellow" Stroke="White" StrokeThickness="1"/> + </s:FastLineRenderableSeries.PointMarker> + </s:FastLineRenderableSeries> + </code> + </example> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.AnimationConverters.AnimationDurationConverter"> + <summary> + Value converter which converts <see cref="T:System.TimeSpan" /> to <see cref="T:System.Windows.Duration" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.AnimationConverters.AnimationDurationConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts the source timespan value to the target duration for animation. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The type of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.AnimationConverters.AnimationDurationConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts the target duration value to the source timespan. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The type of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.FadeAnimation"> + <summary> + Provides a fade animation for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.FadeAnimation.Animate(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation"> + <summary> + Provides an interface for series animations. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.CurrentProgressChanged"> + <summary> + Raised on every animation update when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.CurrentProgress" /> property changes. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.AnimationStarted"> + <summary> + Raised when an animation starts. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.AnimationEnded"> + <summary> + Raised when an animation ends. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.IsRunning"> + <summary> + Returns a value indicating whether an animation is running. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.Attach(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Called by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> to attach an animation. + </summary> + <param name="renderSeries"> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which is to be animated.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.Detach"> + <summary> + Called by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> to detach an animation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.OnRender(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> on every render pass to animate <paramref name="rpd" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.StartAnimation"> + <summary> + Starts an animation on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation.StopAnimation"> + <summary> + Stops an animation on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase"> + <summary> + Helper type that is used to change <see cref="T:SciChart.Data.Model.IPointSeries" /> during animation. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase.ZeroLineProperty"> + <summary> + Defines the ZeroLine DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase.Transformation"> + <summary> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation" /> used to transform a <see cref="T:SciChart.Data.Model.IPointSeries" /> + during animation. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase.ZeroLine"> + <summary> + Gets or sets a value that specifies a starting Y value of this animation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase.Animate(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase.CreateTransformation(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation" /> which is + used to transform a <see cref="T:SciChart.Data.Model.IPointSeries" /> during animation. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.PointSeriesAnimationBase.Transformation" />. + </summary> + <param name="renderPassData"> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> to transform.</param> + <param name="renderSeries"> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> that is to be animated.</param> + <returns>Modified <see cref="T:SciChart.Data.Model.IPointSeries" />.</returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.ScaleAnimation"> + <summary> + Provides a scale animation for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.ScaleAnimation.Animate(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase"> + <summary> + Defines the base class for all <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.ISeriesAnimation" /> types. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.CurrentProgressProperty"> + <summary> + Defines the CurrentProgress DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.DurationProperty"> + <summary> + Defines the Duration DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.AnimationDelayProperty"> + <summary> + Defines the AnimationDelay DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.EasingFunctionProperty"> + <summary> + Defines the EasingFunction DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.StoryboardProperty"> + <summary> + Defines the Storyboard DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.GlobalEnableAnimations"> + <summary> + When true, series animations are globally enabled, else globally disabled + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.CurrentProgressChanged"> + <inheritdoc /> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.AnimationStarted"> + <inheritdoc /> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.AnimationEnded"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.#ctor"> + <summary> + Initializes an animation type. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.EasingFunction"> + <summary> + <see cref="T:System.Windows.Media.Animation.IEasingFunction" /> used by this animation. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Storyboard" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.AnimationDelay"> + <summary> + Initial delay of this animation. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Storyboard" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Duration"> + <summary> + Duration of this animation. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Storyboard" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Storyboard"> + <summary> + <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Storyboard" /> which performs animation. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.CurrentProgress"> + <summary> + Current progress of this animation. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.RenderableSeries"> + <summary> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> which this animation is attached to. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.IsRunning"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.InitValue"> + <summary> + The initial value of this animation. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.LastValue"> + <summary> + The final value of this animation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Attach(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Detach"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.OnRender(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.Animate(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double)"> + <summary> + When overridden in derived types, animates <paramref name="rpd" /> + considering <paramref name="currentProgress" /> of current animation. + </summary> + <param name="rpd"> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> to animate.</param> + <param name="currentProgress">Current progress of current animation.</param> + <returns>Modified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" />.</returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.StopAnimation"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.StartAnimation"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.OnCurrentProgressChanged(System.Double)"> + <summary> + Called on every animation update when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.CurrentProgress" /> property changes. + </summary> + <param name="currentProgress">Current progress of current animation.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.OnAnimationStarted"> + <summary> + Called when an animation starts. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.OnAnimationEnded"> + <summary> + Called when an animation ends. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.GetSchema"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.ReadXml(System.Xml.XmlReader)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SeriesAnimationBase.WriteXml(System.Xml.XmlWriter)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.SweepAnimation"> + <summary> + Provides a sweep animation for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.SweepAnimation.Animate(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.BoxPlotPointSeriesTransformation"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.BoxPlotPointSeriesTransformation.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.BoxPlotPointSeriesTransformation" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.BoxPlotPointSeriesTransformation.TransformInternal(SciChart.Charting.Model.DataSeries.BoxPointSeries,System.Double,System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.HlcPointSeriesTransformation`1"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.HlcPointSeriesTransformation`1.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.HlcPointSeriesTransformation`1" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.HlcPointSeriesTransformation`1.TransformInternal(`0,System.Double,System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation"> + <summary> + Provides an interface for types that change <see cref="T:SciChart.Data.Model.IPointSeries" /> during animation. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.ZeroLine"> + <summary> + Gets or sets a value that specifies a starting Y value of this animation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.WaveTransform(SciChart.Data.Model.IPointSeries,System.Double,System.Double)"> + <summary> + Performs wave transformation on <paramref name="pointSeries" /> + according to <paramref name="currentProgress" /> of animation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.ScaleTransform(SciChart.Data.Model.IPointSeries,System.Double)"> + <summary> + Performs scale transformation on <paramref name="pointSeries" /> + according to <paramref name="currentProgress" /> of animation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.SweepTransform(SciChart.Data.Model.IPointSeries,System.Double)"> + <summary> + Performs sweep transformation on <paramref name="pointSeries" /> + according to <paramref name="currentProgress" /> of animation. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.OhlcPointSeriesTransformation"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.OhlcPointSeriesTransformation.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.OhlcPointSeriesTransformation" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.OhlcPointSeriesTransformation.TransformInternal(SciChart.Charting.Model.DataSeries.OhlcPointSeries,System.Double,System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1"> + <summary> + Provides a base class for types that change <see cref="T:SciChart.Data.Model.IPointSeries" /> during animation. + </summary> + <typeparam name="T">A type, derived from <see cref="T:SciChart.Data.Model.IPointSeries" />.</typeparam> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates a new instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.RenderableSeries"> + <summary> + Gets the renderable series to which the transformation is attached. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.ZeroLine"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.OriginalYValues"> + <summary> + Collection of original Y values from <see cref="P:SciChart.Charting.Model.DataSeries.DataSeries`2.YValues" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.WaveTransform(`0,System.Double,System.Double)"> + <inheritdoc cref="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.WaveTransform(SciChart.Data.Model.IPointSeries,System.Double,System.Double)" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.ChangeValue(System.Double,System.Double,System.Boolean,System.Double)"> + <summary> + Calculation which is applied to every value in <see cref="T:SciChart.Data.Model.IPointSeries" /> during transformation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.TransformInternal(`0,System.Double,System.Int32,System.Int32)"> + <summary> + Called during <see cref="T:SciChart.Data.Model.IPointSeries" /> transformation + to transform additional values like ZValues, OHLC Values, etc. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.ScaleTransform(`0,System.Double)"> + <inheritdoc cref="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.ScaleTransform(SciChart.Data.Model.IPointSeries,System.Double)" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.Point2DSeriesTransformation`1.SweepTransform(`0,System.Double)"> + <inheritdoc cref="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.IPointSeriesTransformation.SweepTransform(SciChart.Data.Model.IPointSeries,System.Double)" /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyyPointSeriesTransformation"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyyPointSeriesTransformation.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyyPointSeriesTransformation" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyyPointSeriesTransformation.TransformInternal(SciChart.Data.Model.XyyPoint2DSeries,System.Double,System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyzPointSeriesTransformation"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyzPointSeriesTransformation.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyzPointSeriesTransformation" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.Transformations.XyzPointSeriesTransformation.TransformInternal(SciChart.Charting.Model.DataSeries.XyzPointSeries,System.Double,System.Int32,System.Int32)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Animations.WaveAnimation"> + <summary> + Provides a wave animation for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.Animations.WaveAnimation.PointDurationFractionProperty"> + <summary> + Defines the PointDurationFraction DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.Animations.WaveAnimation.PointDurationFraction"> + <summary> + Gets or sets a value that specifies a relative duration of a point animation + as a fraction of an overall animation <see cref="T:System.Windows.Duration" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Animations.WaveAnimation.Animate(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.AxisInfo"> + <summary> + Provides information on an axis hit test operation, see <see cref="M:SciChart.Charting.Visuals.Axes.AxisBase.HitTest(System.Windows.Point)" /> for more information + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.AxisId"> + <summary> + Gets or sets the current Axis Id + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.AxisTitle"> + <summary> + Gets or sets the current Axis Title + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.AxisAlignment"> + <summary> + Gets or sets the current Axis alignment + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.DataValue"> + <summary> + Gets or sets the DataValue at the axis hit test point + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.AxisFormattedDataValue"> + <summary> + Gets or sets a Formatted data value using the Axis.FormatText method + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.IsHorizontal"> + <summary> + Gets or sets the current orientation, indicating whether <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> is horizontal or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.IsXAxis"> + <summary> + Gets or sets whether the current axis is an X-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.CursorFormattedDataValue"> + <summary> + Gets or sets a Cursor Formatted data value, using the Axis.FormatCursorText method + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.AxisInfo.IsMasterChartAxis"> + <summary> + Gets or sets the value, indicating that the associated axis belongs to the surface, + where a mouse event occured originally. See <see cref="P:SciChart.Charting.ChartModifiers.ModifierEventArgsBase.IsMaster" /></summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries"> + <summary> + An abstract base class which factors out many properties from the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + and <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> types. + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.FillProperty"> + <summary> + Defines the Fill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.FillBrushMappingModeProperty"> + <summary> + Defines the FillBrushMappingMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.UseUniformWidthProperty"> + <summary> + Defines the UniformWidth DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.MinColumnWidth"> + <summary> + Minimum column width, used when UseUniformWidth is set + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.Fill"> + <summary> + Gets or sets the Fill Brush for columns. The column outline is specified by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.FillBrushMappingMode"> + <summary> + Gets or sets a <see cref="T:SciChart.Drawing.Common.TextureMappingMode" /> which defines how columns are filled when a gradient <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.Fill" /> is used. + + If <see cref="F:SciChart.Drawing.Common.TextureMappingMode.PerScreen" />, then a single texture is shared across multiple columns + If <see cref="F:SciChart.Drawing.Common.TextureMappingMode.PerPrimitive" />, then a texture is created and scaled per-column fill area + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.UseUniformWidth"> + <summary> + Gets or sets the UseUniformWidth, which specifies that all columns are the to be of the same width + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.GetColumnWidth(SciChart.Data.Model.IPointSeries,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + When overriden in a derived class, computes the width of the columns, which depends on the input data, + any spacing and the current viewport dimensions + </summary> + <param name="points">The <see cref="T:SciChart.Data.Model.IPointSeries" /> containing resampled data to render</param> + <param name="xCoordinateCalculator">The current X coordinate calculator.</param> + <returns>The width of the column</returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.GetNonUniformColumnWidth(SciChart.Data.Model.IPointSeries,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Double,System.Double,System.Int32)"> + <summary> + When overriden in a derived class, computes the width of the non-uniform columns, which depends on the input data, + any spacing and the current viewport dimensions + </summary> + <param name="points">The <see cref="T:SciChart.Data.Model.IPointSeries" /> containing resampled data to render</param> + <param name="renderPassData">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> containing information about the current render pass</param> + <param name="prevCoord">The previous data point coordinate</param> + <param name="xCenter">The center coordinate of the previous data point</param> + <param name="pointsIndex">The current point index</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseColumnRenderableSeries.GetColumnCenterTopAndBottom(System.Int32,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,System.Int32,System.Double@,System.Double@,System.Double@)"> + <summary> + When overridden in a derived class, returns the extents of a column as pixel coordinates + </summary> + <param name="dataPointIndex">The index to the <see cref="T:SciChart.Data.Model.IPointSeries" /> for this column</param> + <param name="renderPassData">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> valid for the current render pass</param> + <param name="zeroY">The pixel coordinate of zero in the Y-direction</param> + <param name="xCenter">[out] The X-Axis pixel coordinate</param> + <param name="yTop">[out] The Left-edge Y-Axis pixel coordinate</param> + <param name="yBottom">[out] The Right-edge Y-Axis pixel coordinate</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries"> + <summary> + An abstract base class which factors out many properties from the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + and <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> types. + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries.FillProperty"> + <summary> + Defines the Fill DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseMountainRenderableSeries.Fill"> + <summary> + Gets or sets the Area Brush for the mountain series. The mountain chart outline is specified by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" /></summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries"> + <summary> + Defines the Base class for all RenderableSeries within SciChart. + </summary> + <remarks> + <para> + A RenderableSeries has a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + </para> + <para> + A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></para> + <para> + Drawing is provided by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawingProviders" /> instance and Hit-Test by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.HitTestProvider" /> instance. + </para> + </remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsDigitalLineProperty"> + <summary> + Defines the IsDigitalLine DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.StrokeDashArrayProperty"> + <summary> + Defines the StrokeDashArray DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsSelectedProperty"> + <summary> + Defines the IsSelected DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeriesProperty"> + <summary> + Defines the DataSeries DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsVisibleProperty"> + <summary> + Defines the IsVisible DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.StrokeProperty"> + <summary> + Defines the Stroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SelectedSeriesStyleProperty"> + <summary> + Defines the SelectedSelectedSeriesStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingModeProperty"> + <summary> + Defines the ResamplingMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingPrecisionProperty"> + <summary> + Defines the ResamplingPrecision DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.AntiAliasingProperty"> + <summary> + Defines the AntiAliasing DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarkerTemplateProperty"> + <summary> + Defines the PointMarkerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarkerProperty"> + <summary> + Defines the PointMarker DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SelectedPointMarkerProperty"> + <summary> + Defines the SelectedPointMarker DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.RolloverMarkerTemplateProperty"> + <summary> + Defines the RolloverMarkerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.LegendMarkerTemplateProperty"> + <summary> + Defines the LegendMarkerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.YAxisIdProperty"> + <summary> + Defines the AxisAlignment DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.XAxisIdProperty"> + <summary> + Defines the AxisAlignment DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PaletteProviderProperty"> + <summary> + Defines the PaletteProvider DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ZeroLineYProperty"> + <summary> + Defines the ZeroLineY DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawNaNAsProperty"> + <summary> + Defines the DrawNaNAs DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SeriesAnimationProperty"> + <summary> + Defines the SeriesAnimation DependencyProperty + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SelectionChanged"> + <summary> + Event raised whenever IsSelected property changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsVisibleChanged"> + <summary> + Event raised whenever IsVisible property changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.HitTestProvider"> + <summary> + <para>Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series.</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series.</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsDigitalLine"> + <summary> + If this series draws a line, this property is used to define a value indicating whether this line is a digital (step) line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.StrokeDashArray"> + <summary> + If this series draws a line, this property gets or sets a StrokeDashArray property, used to define a dashed line. See the MSDN Documentation for + <see cref="P:System.Windows.Shapes.Shape.StrokeDashArray" /> as this property attempts to mimic the same behaviour + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SeriesAnimation"> + <inheritdoc /> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ZeroLineY"> + <summary> + Gets or sets the value which determines the zero line in Y direction. + Used to set the bottom of a column, or the zero line in a mountain + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the line. + </summary> + <remarks> + Note that increasing stroke thickness from 1 will have a detrimental effect on performance + </remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingResolution"> + <summary> + Gets or sets the resampling resolution. The default is 2, which results in Nyquist resampling. Lower values are not permitted. Higher values result in potentially more visually accurate rendering, but at the expense of performance + </summary> + <value>The resampling resolution.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PaletteProvider"> + <summary> + Gets or Sets an optional <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> instance, which may be used to override specific data-point colors during rendering. + For more details, see the <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> documentation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.RolloverMarker"> + <summary> + Gets a cached Framework Element which is used as a Rollover Marker. + This is generated from a ControlTemplate in xaml via the <see cref="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.RolloverMarkerTemplateProperty" /> DependencyProperty + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarkerTemplate"> + <summary> + Gets or sets the PointMarker ControlTemplate, which defines the point-marker Visual to be rendered on each datapoint of the series + </summary> + <remarks>The ControlTemplate is used to template the visuals only for a blank control, creating a new instance per <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. + the resulting FrameworkElement is cached to bitmap and drawn on each redraw of the series, so any triggers, mouse interactions on the ControlTemplate will be lost</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance directly on the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. When a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + is present, then the markers will be drawn at each data-point in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SelectedPointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance directly on the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />. When a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + is present, then the markers will be drawn at each selected data-point in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.RolloverMarkerTemplate"> + <summary> + Gets or sets the RolloverMarker ControlTemplate, which defines the Visual to be rendered on the series when the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> is enabled and the user moves the mouse. + </summary> + <remarks>The ControlTemplate is used to template the visuals only for a blank control, creating a new instance per <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.LegendMarkerTemplate"> + <summary> + Gets or sets the DataTemplate, which defines the Visual to be rendered on the <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> as a series marker + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this RenderableSeries is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this RenderableSeries is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.AntiAliasing"> + <summary> + Gets or sets whether this series uses AntiAliasing when drawn + </summary> + <value> + <c>true</c> if anti aliasing is enabled; otherwise, <c>false</c>.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Data.Numerics.ResamplingMode" /> used when drawing this series + </summary> + <value>The resampling mode.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingPrecision"> + <summary> + Gets or sets the resampling precision for this series. Zero is the default precision, 1 indicates double precision, 2 indicates quad + and so on. Higher precision results in more points after the resampling step and will increase visual accuracy at the expense + of performance + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <value>The color of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SelectedSeriesStyle"> + <summary> + Gets or sets a style for selected series. + </summary> + <value>The style of the selected series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsSelected"> + <summary> + Gets or sets the IsSelectedProperty. + </summary> + <value>The color of the selected series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series + </summary> + <value>The data series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawNaNAs"> + <summary> + Gets or sets a value indicating how this RenderableSeries will treat double.NaN. See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.LineDrawMode" /> for available options + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.CurrentRenderPassData"> + <summary> + Gets or sets the RenderPassData instance used for this render pass + </summary> + <value>The render data.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.XAxis"> + <summary> + Gets or sets the XAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is associated with + </summary> + <value>The X axis.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.YAxis"> + <summary> + Gets or sets the YAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is associated with + </summary> + <value>The Y axis.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.IsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetPointMarker"> + <summary> + For internal use: Returns the cached PointMarker instance used by this series + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnInvalidateParentSurface(System.String)"> + <summary> + Raises the <see cref="T:SciChart.Charting.Utility.InvalidateSciChartMessage" /> which causes the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to invalidate + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnSeriesColorChanged"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" /> dependency property changes. Allows derived types to do caching + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnDataSeriesDependencyPropertyChanged"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> dependency property changes. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnAttached"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnDetached"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.AssertPointSeriesType``1(System.String)"> + <summary> + Used internally by the renderer. Asserts that the input data-type is of the correct format for the current <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /></summary> + <typeparam name="TPointSeries">The type of the series point.</typeparam> + <param name="dataSeriesType">Type of the data series.</param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.SciChart#Charting#Visuals#IDrawable#OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called when the instance is drawn + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> used for drawing</param> + <param name="renderPassData">The current render pass data</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.InternalDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + <para>Draws the series using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> and the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> passed in</para> + <para>From version 6 onward, this defers to the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawingProviders" /> class. If you wish to have custom drawing, you must implement a drawing provider</para> + </summary> + <param name="renderContext">The render context. This is a graphics object which has methods to draw lines, quads and polygons to the screen</param> + <param name="renderPassData">The render pass data. Contains a resampled <see cref="T:SciChart.Data.Model.IPointSeries" />, the <see cref="T:SciChart.Data.Model.IndexRange" /> of points on the screen + and the current YAxis and XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> to convert data-points to screen points</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetDatapointWidth(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Data.Model.IPointSeries,System.Double)"> + <summary> + Gets the width of data-points, used to compute column and OHLC bar widths + </summary> + <param name="xCoordinateCalculator">The current x coordinate calculator.</param> + <param name="pointSeries">The current <see cref="T:SciChart.Data.Model.IPointSeries" /> being rendered.</param> + <param name="widthFraction">The width fraction from 0.0 to 1.0, where 0.0 is infinitely small, 0.5 takes up half the available width and 1.0 means a data-point is the full width between points</param> + <returns></returns> + <exception cref="T:System.ArgumentException">widthFraction should be between 0.0 and 1.0 inclusive;widthFraction</exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetDatapointWidth(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Data.Model.IPointSeries,System.Double,System.Double)"> + <summary> + Gets the width of data-points, used to compute column and OHLC bar widths + </summary> + <param name="xCoordinateCalculator">The current X coordinate calculator.</param> + <param name="pointSeries">The current <see cref="T:SciChart.Data.Model.IPointSeries" /> being rendered.</param> + <param name="barsAmount">Amount of bars within viewport</param> + <param name="widthFraction">The width fraction from 0.0 to 1.0, where 0.0 is infinitely small, 0.5 takes up half the available width and 1.0 means a data-point is the full width between points</param> + <returns></returns> + <exception cref="T:System.ArgumentException">widthFraction should be between 0.0 and 1.0 inclusive;widthFraction</exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetYZeroCoord"> + <summary> + Returns a value that determines the position of Y zero line on a chart. + Significant for the series types that render negative data points differently, + such as the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" />. + </summary> + <returns>The value in pixels indicating the position of zero line</returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetYZeroCoord(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Boolean)"> + <summary> + Returns a value that determines the position of Y zero line on a chart. + Significant for the series types that render negative data points differently, + such as the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" />. + </summary> + <param name="yCoordinateCalculator">The current Y coordinate calculator.</param> + <param name="isVerticalChart">The value indicating whether current chart is vertical.</param> + <returns>The value in pixels indicating the position of zero line</returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.CheckIsInBounds(System.Double,System.Double,System.Double)"> + <summary> + Returns True if the coordinate is between the lower and upper bounds supplied + </summary> + <param name="coord"></param> + <param name="lowerBound"></param> + <param name="upperBound"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetSeriesInfo(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" />) to a <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> is used by the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" />, <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + and <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> classes + </summary> + <param name="hitTestInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetXRange"> + <inheritdoc cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetYRange(SciChart.Data.Model.IRange)"> + <inheritdoc cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetIndicesRange(SciChart.Data.Model.IRange)"> + <inheritdoc cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnResamplingModeChanged"> + <summary> + Called when resampling mode changes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnResamplingPrecisionChanged"> + <summary> + Called when resampling precision changes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnParentSurfaceViewportSizeChanged"> + <summary> + Called when the parent surface viewport size changes, immediately before a draw pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetChartRotationAngle(SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Used Internally: Gets the rotation angle of the chart, which is 0 degrees or 90 degrees depending on whether the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + has swapped X and Y Axes or not. + </summary> + <param name="renderPassData">The current <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnInvalidateParentSurface(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + When called, invalidates the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="d">The DependencyObject that raised the event.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.OnDataSeriesDependencyPropertyChanged(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> property changes - i.e. a new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> has been set + </summary> + <param name="oldDataSeries">The old <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <param name="newDataSeries">The new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetParentSurface"> + <summary> + Gets the parent <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> for this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /></summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.CreateRolloverMarker"> + <summary> + Creates a RolloverMarker from the RolloverMarkerTemplate property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries"> + <summary> + Defines the interface to all SciChartTernarySurface RenderableSeries. A RenderableSeries is a Line series, or Scatter series or Polygons series and provides the visual element in pair of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> and <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries.YAxis"> + <summary> + Gets or sets the YAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> is associated with. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries.XAxis"> + <summary> + Gets or sets the XAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> is associated with. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries.ZAxis"> + <summary> + Gets or sets the ZAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> is associated with. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries.IsValidCoord(System.Windows.Point)"> + <summary> + Gets a value indicating whether this coordinates is valid. + </summary> + <param name="coord">Coordinates for check.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries.GetPolygonPoints(SciChart.Charting.Model.DataSeries.IXyzDataSeries{System.Double,System.Double,System.Double},SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData,System.Boolean)"> + <summary> + Gets a collection of the <see cref="T:System.Windows.Point" /> items which are associated with the polygon. + </summary> + <param name="dataSeries">The current data series.</param> + <param name="renderPassData">The renderPassData contains additional helper classes and parameters.</param> + <param name="useForDrawing">The value indicating whether these points is used for drawing.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries"> + <summary> + Defines the Base class for all RenderableSeries within SciChart. + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data-source, + and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.YAxis"> + <summary> + Gets or sets the YAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.XAxis"> + <summary> + Gets or sets the XAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.ZAxis"> + <summary> + Gets or sets the ZAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" /> is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.CurrentRenderPassData"> + <summary> + Gets or sets the RenderPassData instance used for this render pass + </summary> + <value>The render data.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series + </summary> + <value>The data series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.IsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries" /> is valid for drawing. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.GetSeriesInfo(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Converts a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> hit-test result into a <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> viewmodel for use in the + <see cref="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifier" />, <see cref="T:SciChart.Charting.ChartModifiers.TernaryLegendModifier" />, <see cref="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier" />. + </summary> + <remarks>All the legend and tooltip + types bind to <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" />, so this is a useful API function to convert hit-test results into this useful type.</remarks> + <param name="hitTestInfo">The hit-test result to convert</param> + <returns></returns> + <seealso cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> + <seealso cref="T:SciChart.Charting.Model.ChartData.TernarySeriesInfo" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryTooltipModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryLegendModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.TernaryCursorModifier" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.OnInvalidateParentSurface(System.String)"> + <summary> + Raises the <see cref="T:SciChart.Charting.Utility.InvalidateSciChartMessage" /> which causes the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> to invalidate + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.GetParentSurface"> + <summary> + Gets the parent <see cref="T:SciChart.Charting.Visuals.ISciChartTernarySurface" /> for this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries" /></summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.IsValidCoord(System.Windows.Point)"> + <summary> + Gets a value indicating whether this coordinates is valid. + </summary> + <param name="coord">Coordinates for check</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries.GetPolygonPoints(SciChart.Charting.Model.DataSeries.IXyzDataSeries{System.Double,System.Double,System.Double},SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData,System.Boolean)"> + <summary> + Gets a collection of the <see cref="T:System.Windows.Point" /> items which are associated with the polygon. + </summary> + <param name="dataSeries">The current data series.</param> + <param name="renderPassData">The renderPassData contains additional helper classes and parameters.</param> + <param name="useForDrawing">The value indicating whether these points is used for drawing.</param> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ColorPaletteMode.AlternateColors"> + <summary> + Applies the Gradient Colors from <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries" /> ColorMap individually, ignoring offsets, e.g. with Gradient Stops Red, Green, Blue then contour lines will appear Red Green or Blue + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ColorPaletteMode.GradientColors"> + <summary> + Applies the Gradient Colors from <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries" /> ColorMap according to the data on the chart + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ContourLine"> + <summary> + Defines a class that represents a single contour line of a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ContourLine.StrokeDashArrayProperty"> + <summary> + Defines the StrokeDashArray Dependency Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ContourLine.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness Dependency Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ContourLine.DrawLabelsProperty"> + <summary> + Defines the DrawLabels Dependency Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ContourLine.TextFormattingProperty"> + <summary> + Defines the TextFormatting Dependency Property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ContourLine.StrokeProperty"> + <summary> + Defines the TextFormatting Dependency Property + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ContourLine.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ContourLine" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ContourLine.StrokeDashArray"> + <summary> + Gets or sets a stroke dash array for a contour line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ContourLine.StrokeThickness"> + <summary> + Gets or sets a stroke thickness for a contour line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ContourLine.DrawLabels"> + <summary> + Gets or sets whether labels should appear for a contour line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ContourLine.TextFormatting"> + <summary> + Gets or sets text formatting for labels of a contour line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ContourLine.Stroke"> + <summary> + Gets or sets a stroke color for a contour line. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingMode"> + <summary></summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.DrawingMode.Fast"> + <summary> + Uses a Shader based algorithm (DirectX only) to compute extremely fast contours + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.DrawingMode.Accurate"> + <summary> + Uses a software based algorithm to compute accurate contours + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.ColorMap"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette" /> which is used to calculate a color from a data value. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.ZStep"> + <summary> + Defines the Stepping in data-value between Major contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.MajorLineStyle"> + <summary> + Defines a style which we apply to Major contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.MinorLineStyle"> + <summary> + Defines a style which we apply to Minor contour lines + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.MinorsPerMajor"> + <summary> + Defines the number of Minor lines between each Major contour line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.DrawingMode"> + <summary> + When <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.DrawingMode" />, Fast, and the DirectX Renderer is enabled, uses a fast GPU-based shader calculation to perform extremely fast rendering of contours. + + When <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries.DrawingMode" />, Accurate, a more accurate (but slower) software calculation is performed for contours, regardless of whether DirectX is enabled or not. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.CustomRenderableSeries"> + <summary> + Defines a Custom Renderable Series - override Draw() to define what is drawn to the screen at render time + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.CustomRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.CustomRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.CustomRenderableSeries.Draw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Draws the series using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> and the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> passed in + </summary> + <param name="renderContext">The render context. This is a graphics object which has methods to draw lines, quads and polygons to the screen</param> + <param name="renderPassData">The render pass data. Contains a resampled <see cref="T:SciChart.Data.Model.IPointSeries" />, the <see cref="T:SciChart.Data.Model.IndexRange" /> of points on the screen + and the current YAxis and XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> to convert data-points to screen points</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider"> + <summary> + <para>The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider" /> provides drawing of bands and digital bands from a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" />, + using the <see cref="T:SciChart.Data.Model.XyyPoint2DSeries" /> YValues, Y1Values as input.</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries)"> + <summary>Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> class.</summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary>Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread</summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.CreateBandPolygons(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData,SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Double},SciChart.Drawing.Common.IBrush2D,SciChart.Drawing.Common.IBrush2D)"> + <summary> + Creates the band polygons given two <see cref="T:SciChart.Data.Model.IPointSeries" /> inputs + </summary> + <param name="renderContext">The render context.</param> + <param name="renderPassData">The render pass data.</param> + <param name="xValues">The X values.</param> + <param name="yValues">The Y values.</param> + <param name="y1Values">The Y1 values.</param> + <param name="yBrush">The y brush.</param> + <param name="y1Brush">The y1 brush.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.Polygon"> + <summary> + A struct to hold information about a Polygon drawn on a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.Polygon.#ctor(System.Windows.Point[],SciChart.Drawing.Common.IBrush2D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.Polygon" /> struct. + </summary> + <param name="points">The points.</param> + <param name="brush2D">The brush 2D.</param> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.Polygon.Brush"> + <summary> + Gets the brush for filling the polygon + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BandSeriesDrawingProvider.Polygon.Points"> + <summary> + Gets the points that form the outline of the polygon + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProviderHelper"> + <summary> + Provides methods to dispose all vertex arrays. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProviderHelper.DisposeVertexArrays"> + <summary> + A function to dispose all vertex arrays + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1" /> provides base methods for drawing from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1.#ctor(`0)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1" /> class. + </summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1.RenderableSeries"> + <summary> + Gets the renderable series instance associated with this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1" /></summary> + <value>The renderable series.</value> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called when immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1.OnNotifySeriesPropertyChanged(System.String)"> + <summary> + Called when a property changes on the associated <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> which requires caches to be cleared or drawing to be invalidated in some way. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseDrawingProvider`1.GetVertexArray``1(``0[],System.Int32)"> + <summary> + Creates a new array if expected count does not equal current array count, or current array is null. + </summary> + <typeparam name="TVertex">The type of the vertex.</typeparam> + <param name="currentArray">The current array.</param> + <param name="expectedCount">The expected count.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseHeatmapDrawingProvider`1.GetTexture(SciChart.Drawing.Common.IRenderContext2D,System.Int32,System.Int32,SciChart.Drawing.Common.TextureFormats)"> + <summary> + Creates a texture with given width and height. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseTernarySeriesDrawingProvider`1"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseTernarySeriesDrawingProvider`1" /> provides base methods for drawing from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseTernarySeriesDrawingProvider`1.#ctor(`0)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseTernarySeriesDrawingProvider`1" /> class. + </summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BaseTernarySeriesDrawingProvider`1.UsePointMarkerPaletteProvider(SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider,SciChart.Charting.Visuals.PointMarkers.IPointMarker,System.Int32)"> + <summary> + Called for use point marker palette provider + </summary> + <param name="provider">Palette provider</param> + <param name="pointMarker">Point marker</param> + <param name="index">Data index</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BrushKey.Equals(System.Object)"> + <summary>Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.</summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BrushKey.Equals(SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BrushKey)"> + <summary>Determines whether the specified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" />, is equal to this instance.</summary> + <param name="other">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider" /> provides drawing of bubbles from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type, using the default X, Y and Y1 values as input. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> that we are drawing bubbles for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider.RecreateCachedBubbleSprite(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called when the internally cached sprite of a bubble requires recreation. + </summary> + <param name="renderContext2D">Current <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.BubbleSeriesDrawingProvider.OnNotifySeriesPropertyChanged(System.String)"> + <summary> + Invalidates the cached instance of the bubble sprite + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider" /> provides drawing of candles from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type, using the default <see cref="P:SciChart.Data.Model.IPointSeries.YValues" /> and <see cref="P:SciChart.Data.Model.IPointSeries.XValues" /> as input. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider.DrawHistograms"> + <summary> + Gets a value, indicating whether the <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider.DrawHistogram(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Model.DataSeries.OhlcSeriesPoint,System.Int32@,System.Int32@)" /> method will be called during a render pass. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> that we are drawing candles for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.CandlestickSeriesDrawingProvider.DrawHistogram(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Model.DataSeries.OhlcSeriesPoint,System.Int32@,System.Int32@)"> + <summary> + Draws a histogram for the current candle. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="ohlcPoint">The PointSeries contains resampled and viewport-truncated data for drawing.</param> + <param name="xRight">The X coordinate for the right side of the current candle.</param> + <param name="xLeft">The X coordinate for the left side of the current candle.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ColumnSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ColumnSeriesDrawingProvider" /> provides drawing of columns from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ColumnSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ColumnSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> that we are drawing bubbles for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ColumnSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ColumnSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary>Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread</summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider" /> provides drawing of scatter series, which requires a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PointMarker" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries" /> that we are drawing point markers for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider.OnNotifySeriesPropertyChanged(System.String)"> + <summary> + Called when a property changes on the associated series which requires caches to be cleared or drawing to be invalidated in some way. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ExtremeScatterSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.HistoBarSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.HistoBarSeriesDrawingProvider" /> provides drawing of candles from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type, using the default <see cref="P:SciChart.Data.Model.IPointSeries.YValues" /> and <see cref="P:SciChart.Data.Model.IPointSeries.XValues" /> as input. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.HistoBarSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries,SciChart.Charting.Visuals.RenderableSeries.HistogramBar,SciChart.Charting.Visuals.RenderableSeries.HistogramBar,SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper,SciChart.Charting.Visuals.RenderableSeries.DrawHistoBarStrategy)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.HistoBarSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" /> that we are drawing candles for.</param> + <param name="askBar"> The ask histogram bar in the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" /></param> + <param name="bidBar"> The bid histogram bar in the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" /></param> + <param name="marketHelper"> The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper" /> to accumulate candle volumes.</param> + <param name="drawHistoBarStrategy"> The strategy which defines a rendering method for histogram bars.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.HistoBarSeriesDrawingProvider.DrawHistogram(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Model.DataSeries.OhlcSeriesPoint,System.Int32@,System.Int32@)"> + <summary> + Draws a histogram for the current candle. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="ohlcPoint">The PointSeries contains resampled and viewport-truncated data for drawing.</param> + <param name="xRight">The X coordinate for the right side of the current candle.</param> + <param name="xLeft">The X coordinate for the left side of the current candle.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ImpulseSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ImpulseSeriesDrawingProvider" /> provides drawing of vertical stems with point-marker from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type, using the default <see cref="P:SciChart.Data.Model.IPointSeries.YValues" /> and <see cref="P:SciChart.Data.Model.IPointSeries.XValues" /> as input. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ImpulseSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries)"> + <summary>Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ImpulseSeriesDrawingProvider" /> class.</summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" /> that we are drawing impulse or stems for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ImpulseSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ImpulseSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary>Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread</summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider"> + <summary> + Defines the base interface to a Series Drawing provider. This set of classes are responsible for drawing a specific series to the viewport. + Drawing providers are accessed via <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DrawingProviders" /> property, and <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> is invoked during the drawing pass. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. + </summary> + <param name="renderContext">The renderContext for drawing to the viewport.</param> + <param name="renderPassData">The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnNotifySeriesPropertyChanged(System.String)"> + <summary> + Called when a property changes on the associated <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> which requires caches to be cleared or drawing to be invalidated in some way. + </summary> + <param name="propertyName">The property name that has been changed.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer" /> type is used to draw lines. Uses legacy methods including iterating through points one by one and calculation of paths. + This type has been superseded by the new Twister/DirectX direct memory access methods + </summary> + <remarks> + <para>This class is marked as a legacy point-marker renderer as it uses the old path for drawing which is sub-optimal</para> + <para>This path is not the default. Where DirectX9 or greater is available, we will be rendering using the new DirectX / TSR classes</para> + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Boolean,System.Double[])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer" /> class. + </summary> + <param name="renderSeries">The render series.</param> + <param name="isDigitalLine">if set to <c>true</c> [is digital line].</param> + <param name="strokeDashArray">The stroke dash array.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer.WithStroke(System.Windows.Media.Color)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer" /> class. + </summary> + <param name="stroke">The stroke color</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyLineRenderer.Draw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Data.Model.IPointSeries,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> Executes drawing of lines using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> and <see cref="T:SciChart.Data.Model.IPointSeries" /> passed in</summary> + <param name="renderContext">The render context.</param> + <param name="pointSeries">The point series.</param> + <param name="renderPassData">The render pass data.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyPointMarkerRenderer"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyPointMarkerRenderer" /> type is used to draw lines. Uses legacy methods including iterating through points one by one and calculation of paths. + This type has been superseded by the new Twister/DirectX direct memory access methods + </summary> + <remarks> + <para>This class is marked as a legacy point-marker renderer as it uses the old path for drawing which is sub-optimal</para> + <para>This path is not the default. Where DirectX9 or greater is available, we will be rendering using the new DirectX / TSR classes</para> + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyPointMarkerRenderer.#ctor(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,SciChart.Charting.Visuals.PointMarkers.IPointMarker,SciChart.Charting.Visuals.PointMarkers.IPointMarker)"> + <summary>Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyPointMarkerRenderer" /> class.</summary> + <param name="renderSeries">The render series.</param> + <param name="pointMarker">The point marker to draw at each point.</param> + <param name="selectedPointMarker">The point marker to draw at each selected point.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LegacyPointMarkerRenderer.Draw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Data.Model.IPointSeries,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> Executes drawing of point-markers using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> and <see cref="T:SciChart.Data.Model.IPointSeries" /> passed in</summary> + <param name="renderContext">The render context.</param> + <param name="pointSeries">The point series.</param> + <param name="renderPassData">The render pass data.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider"> + <summary> + <para>The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider" /> provides drawing of lines from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type, using the default <see cref="P:SciChart.Data.Model.IPointSeries.YValues" /> and <see cref="P:SciChart.Data.Model.IPointSeries.XValues" /> as input.</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary>Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider" /> class.</summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> that we are drawing lines for.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider`1"> + <summary> + <para>The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider`1" /> provides drawing of lines from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type.</para> + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Data.Model.IPointSeries" /> to collect data from</typeparam> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider`1.#ctor(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries,System.Linq.Expressions.Expression{System.Func{`0,SciChart.Data.Model.Values{System.Double}}})"> + <summary>Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider" /> class.</summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> that we are drawing lines for.</param> + <param name="yValuesSelector">Allows selection of which property on <see cref="T:SciChart.Data.Model.IPointSeries" /> derived types to collect Y-Values from.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider`1.OnNotifySeriesPropertyChanged(System.String)"> + <summary> + Called when a property changes on the associated series which requires caches to be cleared or drawing to be invalidated in some way. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider`1.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.LineSeriesDrawingProvider`1.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary>Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread</summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MarketProfileSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MarketProfileSeriesDrawingProvider" /> provides drawing of OHLC data as stacked columns of Bid and Ask volumes at prices. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MarketProfileSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MarketProfileSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries" /> that we are drawing volume candles for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MarketProfileSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MountainSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MountainSeriesDrawingProvider" /> provides drawing of mountain chart from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MountainSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MountainSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> that we are drawing mountain chart for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MountainSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.MountainSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.OhlcSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.OhlcSeriesDrawingProvider" /> provides drawing of bars from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type, using the default <see cref="P:SciChart.Data.Model.IPointSeries.YValues" /> and <see cref="P:SciChart.Data.Model.IPointSeries.XValues" /> as input. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.OhlcSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.OhlcSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> that we are drawing bars for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.OhlcSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.OhlcSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey.Equals(System.Object)"> + <summary>Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.</summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey.Equals(SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey)"> + <summary>Determines whether the specified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" />, is equal to this instance.</summary> + <param name="other">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" /> is equal to this instance; otherwise, <c>false</c>.</returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider" /> provides drawing of point markers from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> derived type that we are drawing point markers for.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1" /> provides drawing of point markers from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Data.Model.IPointSeries" /> to collect data from</typeparam> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1.#ctor(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries,System.Linq.Expressions.Expression{System.Func{`0,SciChart.Data.Model.Values{System.Double}}})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> derived type that we are drawing point markers for.</param> + <param name="yValuesSelector">The expression that returns an array to collect Y values from.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1.#ctor(SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries,System.Linq.Expressions.Expression{System.Func{`0,SciChart.Data.Model.IPointSeries}})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> derived type that we are drawing point markers for.</param> + <param name="xyValuesConverter">The expression that returns a transformed point series to collect X,Y values from.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1.OnNotifySeriesPropertyChanged(System.String)"> + <summary> + Called when a property changes on the associated series which requires caches to be cleared or drawing to be invalidated in some way. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PointMarkerDrawingProvider`1.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.SolidColorBrushKey.Equals(System.Object)"> + <summary>Determines whether the specified <see cref="T:System.Object" />, is equal to this instance.</summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.SolidColorBrushKey.Equals(SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.SolidColorBrushKey)"> + <summary>Determines whether the specified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" />, is equal to this instance.</summary> + <param name="other">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.PenCacheKey" /> is equal to this instance; otherwise, <c>false</c>.</returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedColumnSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedColumnSeriesDrawingProvider" /> provides drawing of stacked columns from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedColumnSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedColumnSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> that we are drawing stacked columns for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedColumnSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedColumnSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary>Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread</summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedMountainSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedMountainSeriesDrawingProvider" /> provides drawing of stacked mountain charts from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedMountainSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedMountainSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> that we are drawing stacked mountain charts for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedMountainSeriesDrawingProvider.OnBeginRenderPass(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called immediately before a render pass begins. This is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.StackedMountainSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryErrorSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryErrorSeriesDrawingProvider" /> provides drawing of ternary error bar series. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryErrorSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryErrorSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> that we are drawing error bars for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryErrorSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData">The renderPassData contains additional helper classes and parameters.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryPolygonSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryPolygonSeriesDrawingProvider" /> provides drawing of ternary polygon series. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryPolygonSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryPolygonSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" /> that we are drawing polygons for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryPolygonSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData">The renderPassData contains additional helper classes and parameters.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryScatterSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryScatterSeriesDrawingProvider" /> provides drawing of ternary scatter series, which requires a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PointMarker" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryScatterSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryScatterSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> that we are drawing point markers for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.TernaryScatterSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData">The renderPassData contains additional helper classes and parameters.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.VolumeCandlestickSeriesDrawingProvider"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.VolumeCandlestickSeriesDrawingProvider" /> provides drawing of volume candles from an <see cref="T:SciChart.Data.Model.IPointSeries" /> derived type. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.VolumeCandlestickSeriesDrawingProvider.#ctor(SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.VolumeCandlestickSeriesDrawingProvider" /> class. + </summary> + <param name="renderableSeries">The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries" /> that we are drawing volume candles for.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.VolumeCandlestickSeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Called during the Draw pass of this series onto the viewport. This method is guaranteed to be called on the UI Thread. + </summary> + <param name="renderContext">The RenderContext for drawing to the viewport.</param> + <param name="renderPassData"> + The renderPassData contains additional helper classes and parameters such as <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator" />. + </param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries"> + <summary> + Provides Scatter series rendering via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" /> property which supports <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IExtremePointMarkerPaletteProvider" />. + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries" /> does not support resampling and so ignores the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingMode" /> property</remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries.HitTestProvider"> + <summary> + <para>Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries"> + <summary> + A raster RenderableSeries type which displays two lines and shaded bands between them, where band-colors depend on whether one line is greater than the other + For usage, bind to an <see cref="T:SciChart.Charting.Model.DataSeries.XyyDataSeries`2" /> and set the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />, <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeY1" />, + <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.FillY1" /> and <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.Fill" /> properties + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeY1Property"> + <summary> + Defines the StrokeY1 DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.FillY1Property"> + <summary> + Defines the FillY1 DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.FillProperty"> + <summary> + Defines the Fill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeDashArrayY1Property"> + <summary> + Defines the StrokeDashArray DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeDashArrayY1"> + <summary> + Gets or sets a StrokeDashArray property, used to define a dashed line. See the MSDN Documentation for + <see cref="P:System.Windows.Shapes.Shape.StrokeDashArray" /> as this property attempts to mimic the same behaviour + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.StrokeY1"> + <summary> + Gets or sets the Stroke of the Y1 line. For the Y0 line, use Stroke + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.Fill"> + <summary> + Gets or sets the Color of the shaded area when Y1 is less than Y0 + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.FillY1"> + <summary> + Gets or sets the Color of the shaded area when Y1 is greater than Y0 + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.RolloverMarkerY1"> + <summary> + Gets or sets the RolloverMarker for one of the series + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.CreateRolloverMarker"> + <summary> + Creates a RolloverMarker from the RolloverMarkerTemplate property + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.HitTestProvider"> + <summary> + <para></para> + <para>Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries.OnDataSeriesDependencyPropertyChanged(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> property changes - i.e. a new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> has been set + </summary> + <param name="oldDataSeries">The old <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <param name="newDataSeries">The new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries"> + <summary> + Defines a Box Plot renderable series, supporting rendering of Lowest, Lower Quartile, Median, Upper Quartile, Maximum + statistical data onto a wicked (stroked-outline) box with solid color or gradient filled body. + </summary> + <remarks> + <para> + The FastBoxPlotRenderableSeries requires a <see cref="T:SciChart.Charting.Model.DataSeries.BoxPlotDataSeries`2" /> data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. </para> + <para>A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></para> + <para>Drawing is provided by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawingProviders" /> instance and Hit-Test by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.HitTestProvider" /> instance.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="!:FastHeatMapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.FillProperty"> + <summary> + Defines the FillUp DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.LastBarWidth"> + <summary> + Gets the width of the Box Plot bars in pixels on the last drawing pass + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.Fill"> + <summary> + Gets or sets the Brush used for box-plot body + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.GetSeriesInfo(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" />) to a <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> struct, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> is used by the <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" />, <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + and <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> classes + </summary> + <param name="hitTestInfo"></param> + <returns></returns> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries"> + <summary> + Defines a Bubble-chart renderable series, supporting rendering of bubbles using Z data, positioned using X-Y data. + Bubbles are defined using the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.BubbleColor" /> property, but rendered as a soft-edged circle + which fades to transparent in the centre. + </summary> + <remarks> + <para> + The FastBubbleRenderableSeries requires a <see cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + </para> + <para> + A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></para> + <para> + Drawing is provided by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawingProviders" /> instance and Hit-Test by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.HitTestProvider" /> instance. + </para> + </remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.BubbleColorProperty"> + <summary> + Defines the BubbleColor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.AutoZRangeProperty"> + <summary> + Defines the AutoZRange DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.ZScaleFactorProperty"> + <summary> + Defines the ZScaleFactor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.MaxBubbleSizeInPixelsProperty"> + <summary> + Defines the MaxBubbleSizeInPixels DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.ApplyAreaSizingInsteadOfRadiusProperty"> + <summary> + Defines the ApplyAreaSizingInsteadOfRadius DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.BubbleColor"> + <summary> + Gets or sets the BubbleColor, a base color used when rendering the bubbles as a soft-edged circle, centered on the X-Y point + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.AutoZRange"> + <summary> + Gets or sets whether Z-range should be automatically scaled. If True, then depending on the XYZ points in the + viewport, the size of bubbles will be scaled to fit. Else, the size of bubbles will be absolute + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.ZScaleFactor"> + <summary> + Gets or sets a Z-scaling factor, equal to Pixels divided by Z-Unit + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.MaxBubbleSizeInPixels"> + <summary> + Gets or sets a Max bubble size in pixels, when AutoZRange is set to true + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.ApplyAreaSizingInsteadOfRadius"> + <summary> + Gets or sets a Square Area Sizing behavior among bubbles Instead Of Radius, when AutoZRange is set to true + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.MaxZValue"> + <summary> + Used internally: Gets or sets the maximum z value in the last drawing pass + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.GetBubbleDiameter(System.Double)"> + <summary> + Returns the render size of the bubble sprite with the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries.ZScaleFactor" /> applied. + </summary> + <param name="zValue">The current size of the sprite from the data series.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries"> + <summary> + Provides Fast Candlestick series rendering, however makes the assumption that all X-Data is evenly spaced. Gaps in the data are collapsed + </summary> + <remarks>In order to render data as a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" />, the input <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + must have OHLC data appended via the <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> Append method</remarks> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeUpProperty"> + <summary> + Defines the StrokeUp DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeDownProperty"> + <summary> + Defines the StrokeDown DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillUpProperty"> + <summary> + Defines the FillUp DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillDownProperty"> + <summary> + Defines the FillDown DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.LastCandleWidth"> + <summary> + Gets the width of the candles in pixels on the last drawing pass + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeUp"> + <summary> + Gets or sets the Color used for wicks and outlines on up-candles (close > open) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.StrokeDown"> + <summary> + Gets or sets the Color used for wicks and outlines on down-candles (close < open) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillUp"> + <summary> + Gets or sets the Brush used for candle body on up-candles (close > open). If null, UpBodyColor property is used + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.FillDown"> + <summary> + Gets or sets the Brush used for candle body on up-candles (close > open). If null, UpBodyColor property is used + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.OnDataSeriesDependencyPropertyChanged(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> property changes - i.e. a new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> has been set + </summary> + <param name="oldDataSeries">The old <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <param name="newDataSeries">The new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries.GetIndicesRange(SciChart.Data.Model.IRange)"> + <inheritdoc /> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries"> + <summary> + Provides Fast Column (Bar) series rendering + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries.GetXRange"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries"> + <summary> + Defines an Error Bars renderable series, supporting solid, stroked error bars and + optional Point-markers <seealso cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" />. + </summary> + <remarks> + <para>A RenderableSeries has a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data-source, may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. </para> + <para>A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></para> + <para>Drawing is provided by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DrawingProviders" /> instance and Hit-Test by the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.HitTestProvider" /> instance.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.LastErrorBarWidth"> + <summary> + Gets the width of the error bars in pixels on the last drawing pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawHistoBarStrategy"> + <summary> + Defines histogram rendering strategy for a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.DrawHistoBarStrategy.DrawHistoBar"> + <summary> + Delegate to draw histogram bars depending on the selected rendering mode. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.DrawHistoBarSignature"> + <summary> + Delegate to draw histogram bars depending on the selected rendering mode. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.HistogramMode"> + <summary> + Defines histogram rendering modes for a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramMode.CumulativeVolume"> + <summary> + Draws equisized boxes to the left of every candle with volume difference per price level. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramMode.MarketProfile"> + <summary> + Draws a histogram to the left of every candle, visualizing difference between ask and bid volume per price level. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramMode.VolumeLadder"> + <summary> + Draws two histograms at both sides of every candle, showing bid and ask volume values for every price level. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.HistogramBar"> + <summary> + Allows to specify styling for a histogram bar in a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.FillProperty"> + <summary> + Defines the Fill DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.StrokeProperty"> + <summary> + Defines the Stroke DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.FontSizeProperty"> + <summary> + Defines the FontSize DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.ForegroundProperty"> + <summary> + Defines the Foreground DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.TextFormattingProperty"> + <summary> + Defines the TextFormatting DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.#ctor"> + <summary> + Creates a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HistogramBar" /> type. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.Foreground"> + <summary> + Gets or sets a color used for the bar label. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.FontSize"> + <summary> + Gets or sets a font size for the bar label. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.StrokeThickness"> + <summary> + Gets or sets a stroke thickness for a bar. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.Stroke"> + <summary> + Gets or sets a stroke brush for the outline. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.Fill"> + <summary> + Gets or sets a fill brush for a bar. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.TextFormatting"> + <summary> + Gets or sets a text formatting string for the bar label. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HistogramBar.OnInvalidateParentSurface(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Makes the parent <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> to call invalidate on its parent <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" />. + </summary> + <param name="d"></param> + <param name="e"></param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries"> + <summary> + Provides rendering of OHLC data as candlesticks. Requires <see cref="T:SciChart.Charting.Model.DataSeries.CandlestickMetaData" /> metadata to render a volume histogram to the side of every candle. + </summary> + <remarks>Assumes that all X-Data is evenly spaced.</remarks> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.MarketProfileSeriesHelperProperty"> + <summary> + Defines the MarketProfileSeriesHelper DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.TickSizeProperty"> + <summary> + Defines the TickSize DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.HorizontalBarSpacingProperty"> + <summary> + Defines the HorizontalBarSpacing DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.VerticalBarSpacingProperty"> + <summary> + Defines the VerticalBarSpacing DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.MaxHistoBarCandlesProperty"> + <summary> + Defines the MaxHistoBarCandles DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.AskBarStyleProperty"> + <summary> + Defines the AskBarStyle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.BidBarStyleProperty"> + <summary> + Defines the BidBarStyle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.HistogramModeProperty"> + <summary> + Defines the HistogramMode DependencyProperty. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.MarketProfileSeriesHelper"> + <summary> + Gets or sets a helper class that can be used to get series data in a ViewModel. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.TickSize"> + <summary> + Gets or sets the price delta value which is used to aggregate candle ticks. + This is also the tick size of the associated Y axis (price axis). + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.HistogramMode"> + <summary> + Gets or sets a value that specifies how histogram will appear. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.HistogramMode" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.BidBarStyle"> + <summary> + Gets or sets a style for bid bars. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.AskBarStyle"> + <summary> + Gets or sets a style for ask bars. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.MaxHistoBarCandles"> + <summary> + Gets of sets a value that defines maximal amount of candles in viewport which will appear with histogram. + If there are more, histograms will not be drawn. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.VerticalBarSpacing"> + <summary> + Gets or sets a value that defines vertical spacing between bars in a histogram. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.HorizontalBarSpacing"> + <summary> + Gets or sets a value that defines horizontal spacing between a candle and the histogram. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.MaxBarHeight"> + <summary> + Gets or sets a value that defines how much space occupies the histogram. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.GetIsValidForDrawing"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.DrawHistogramBar(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.HistogramBar,System.Double,System.Windows.Point,System.Windows.Point,System.Double,System.Boolean)"> + <summary> + Draws a histogram bar in a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />. + </summary> + <param name="renderContext"></param> + <param name="barStyling"></param> + <param name="volume"></param> + <param name="barBottomRightCoord"></param> + <param name="barTopLeftCoord"></param> + <param name="volumeXCoord"></param> + <param name="drawLabel"></param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the assosiated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries.OnDataSeriesDependencyPropertyChanged(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> property changes - i.e. a new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> has been set + </summary> + <param name="oldDataSeries">The old <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <param name="newDataSeries">The new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IHistoBarPaletteProvider"> + <summary> + Defines an interface to a PaletteProvider for volume bars (histogram bars) of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IHistoBarPaletteProvider.OverrideBarStyle(SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries,System.Double,SciChart.Charting.Model.BidOrAsk,SciChart.Charting.Visuals.RenderableSeries.HistogramMode)"> + <summary> + Allows to override properties of a single bar in a histogram. + </summary> + <param name="rSeries">The source <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />.</param> + <param name="value">The value of a bar.</param> + <param name="barType">The bar type, e.g. Bid or Ask.</param> + <param name="histogramMode">Current rendering mode of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" />.</param> + <returns>A new <see cref="T:System.Windows.Style" /> for the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HistogramBar" /> type or <value>Null</value> if should not override.</returns> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries"> + <summary> + Provides Impulse series rendering, which draws a vertical line from zero to with an optional point-marker at the end of the line + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.LineDrawMode"> + <summary> + Enumeration Constants to define how double.NaN is treated in the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.LineDrawMode.ClosedLines"> + <summary> + double.NaN gaps are treated as closed lines + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.LineDrawMode.Gaps"> + <summary> + double.NaN gaps are rendered as gaps + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries"> + <summary> + Defines a Line renderable series, supporting solid, stroked (thickness 1+) lines, dashed lines <seealso cref="!:FastLineRenderableSeries.StrokeDashArray" /> and + optional Point-markers <seealso cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" /></summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries.HitTestProvider"> + <summary> + <para>Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series.</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series.</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries"> + <summary> + Provides rendering of OHLC data as stacked columns of Bid and Ask volumes at prices. Requires <see cref="T:SciChart.Charting.Model.DataSeries.CandlestickMetaData" /> metadata to render the histogram. + </summary> + <remarks>Assumes that all X-Data is evenly spaced.</remarks> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.MarketProfileSeriesHelperProperty"> + <summary> + Defines the MarketProfileSeriesHelper DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.TickSizeProperty"> + <summary> + Defines the TickSize DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.MarketProfileWidthProperty"> + <summary> + Defines the MarketProfileWidth DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.StrokeAskProperty"> + <summary> + Defines the StrokeAsk DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.StrokeBidProperty"> + <summary> + Defines the StrokeBid DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.FillAskProperty"> + <summary> + Defines the FillAsk DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.FillBidProperty"> + <summary> + Defines the FillBid DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.VerticalBarOffsetProperty"> + <summary> + Defines the VerticalBarOffset DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.#ctor"> + <summary> + Initializes a new instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries" /> type. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.MarketProfileSeriesHelper"> + <summary> + Gets or sets a helper class that can be used to get series data in a ViewModel. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.AskLine"> + <summary> + Gets the instance of the Ask line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.BidLine"> + <summary> + Gets the instance of the Bid line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.TickSize"> + <summary> + Gets or sets the price delta value which is used to aggregate candle ticks. + This is also the tick size of the associated Y axis (price axis). + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.MarketProfileWidth"> + <summary> + Gets or sets the maximal possible length of bars in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.VerticalBarOffset"> + <summary> + Gets or sets the distance between bars in pixels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.FillBid"> + <summary> + Gets or sets a brush that is used to fill Bid bars. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.FillAsk"> + <summary> + Gets or sets a brush that is used to fill Ask bars. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.StrokeBid"> + <summary> + Gets or sets a brush that is used to draw the outline for Bid bars. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.StrokeAsk"> + <summary> + Gets or sets a brush that is used to draw the outline for Ask bars. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries.GetIsValidForDrawing"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries"> + <summary> + Provides Fast Mountain (Area) series rendering, however makes the assumption that all X-Data is evenly spaced. Gaps in the data are collapsed + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries"> + <summary> + Provides Fast Candlestick series rendering, however makes the assumption that all X-Data is evenly spaced. Gaps in the data are collapsed + </summary> + <remarks>In order to render data as a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" />, the input <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> + must have OHLC data appended via the <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries`2" /> Append method</remarks> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.StrokeUpProperty"> + <summary> + Defines the StrokeUp DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.StrokeDownProperty"> + <summary> + Defines the StrokeDown DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.LastOhlcWidth"> + <summary> + Gets the width of the OHLC bars on the last drawing pass + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.StrokeUp"> + <summary> + Gets or sets the Color used for wicks and outlines on up-candles (close > open) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.StrokeDown"> + <summary> + Gets or sets the Color used for wicks and outlines on down-candles (close < open) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries.OnDataSeriesDependencyPropertyChanged(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> property changes - i.e. a new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> has been set + </summary> + <param name="oldDataSeries">The old <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <param name="newDataSeries">The new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries"> + <summary> + Provides rendering of OHLC data as candlesticks, showing differences between OHLC values relative to the maximal one. Bars are always pinned to the zero line. + </summary> + <remarks>Assumes that all X-Data is evenly spaced.</remarks> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.StrokeUpProperty"> + <summary> + Defines the StrokeUp DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.StrokeDownProperty"> + <summary> + Defines the StrokeDown DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.FillUpProperty"> + <summary> + Defines the FillUp DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.FillDownProperty"> + <summary> + Defines the FillDown DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.ForegroundProperty"> + <summary> + Defines the Foreground DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.FontSizeProperty"> + <summary> + Defines the FontSize DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.VerticalBarSpacingProperty"> + <summary> + Defines the VerticalBarSpacing DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.TextFormattingProperty"> + <summary> + Defines the TextFormatting DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.ZeroLineStyleProperty"> + <summary> + Defines the ZeroLineStyle DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.LastCandleWidth"> + <summary> + Gets the width of the candles in pixels on the last drawing pass. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.ZeroLine"> + <summary> + Gets the instance of the horizontal line at zero (bars are pinned to it). + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.ZeroLineStyle"> + <summary> + Gets or sets a style for the horizontal line at zero (bars are pinned to it). + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.VerticalBarSpacing"> + <summary> + Gets or sets a value that specifies vertical space between a bar and a label. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.TextFormatting"> + <summary> + Gets or sets a formatting string for labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.FontSize"> + <summary> + Gets or sets font size for labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.Foreground"> + <summary> + Gets or sets font color for labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.StrokeUp"> + <summary> + Gets or sets the Color used for wicks and outlines on up-candles (close > open). + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.StrokeDown"> + <summary> + Gets or sets the Color used for wicks and outlines on down-candles (close < open). + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.FillUp"> + <summary> + Gets or sets the Brush used for candle body on up-candles (close > open). If null, UpBodyColor property is used. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.FillDown"> + <summary> + Gets or sets the Brush used for candle body on up-candles (close > open). If null, UpBodyColor property is used. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries.OnDataSeriesDependencyPropertyChanged(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.DataSeries" /> property changes - i.e. a new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> has been set. + </summary> + <param name="oldDataSeries">The old <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <param name="newDataSeries">The new <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.FontSize"> + <summary> + Gets or sets the FontSize for the heatmap labels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.FontStyle"> + <summary> + Gets or sets the FontStyle for the heatmap labels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.FontWeight"> + <summary> + Gets or sets the FontWeight for the heatmap labels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.FontFamily"> + <summary> + Gets or sets the FontFamily for the heatmap labels + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.TextFormatting"> + <summary> + Gets or sets a format string for heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.TextColor"> + <summary> + Gets or sets text color for heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.AlternateTextColor"> + <summary> + Gets or sets alternate text color for heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.UseAlternateTextColor"> + <summary> + Gets or sets a value indicating whether to use alternate text color for heatmap labels. + The choice is based on greyscale calculations. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.ColorMap"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette" /> which is used to calculate a color from a data value. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.DrawTextInCell"> + <summary> + Gets or sets a flag that specifies whether to draw heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.UseLinearTextureFiltering"> + <summary> + When True, linear texture filtering is used. For more information see <see cref="T:SciChart.Drawing.Common.TextureFiltering" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IHeatmapRenderableSeries.FormatDataValue(System.Double,System.Int32,System.Int32)"> + <summary> + When overridden in derived types, allows to format a data value for a corresponding heatmap label. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.TextFormattingProperty"> + <summary> + Defines the TextFormatting DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.TextColorProperty"> + <summary> + Defines the TextColor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.AlternateTextColorProperty"> + <summary> + Defines the AlternateTextColor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.UseAlternateTextColorProperty"> + <summary> + Defines the UseAlternateTextColor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.DrawTextInCellProperty"> + <summary> + Defines the DrawTextInCell DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.ColorMapProperty"> + <summary> + Defines the ColorMap DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.UseLinearTextureFilteringProperty"> + <summary> + Defines the UseLinearTextureFiltering DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.#ctor"> + <summary> + Creates an instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.TextFormatting"> + <summary> + Gets or sets a format string for heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.TextColor"> + <summary> + Gets or sets text color for heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.AlternateTextColor"> + <summary> + Gets or sets alternate text color for heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.UseAlternateTextColor"> + <summary> + Gets or sets a value indicating whether to use alternate text color for heatmap labels. + The choice is based on greyscale calculations. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.ColorMap"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette" /> which is used to calculate a color from a data value. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.DrawTextInCell"> + <summary> + Gets or sets a flag that specifies whether to draw heatmap labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.UseLinearTextureFiltering"> + <summary> + When True, linear texture filtering is used. For more information see <see cref="T:SciChart.Drawing.Common.TextureFiltering" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.OnColorMapModified(SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette)"> + <summary> + When overridden in derived classes, this method is called in response to property changes in current <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.ColorMap" />. + </summary> + <param name="colorMap">The modified <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette" />.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.GetHeatmapColor(System.IComparable)"> + <summary> + Gets the color that corresponds to the given data value on a heatmap. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.FormatDataValue(System.Double,System.Int32,System.Int32)"> + <summary> + When overridden in derived types, allows to format a data value for a corresponding heatmap label. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette"> + <summary> + A class that defines a color map which can be used for <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseHeatmapRenderableSeries.ColorMap" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.PrecisionProperty"> + <summary> + Defines the Precision DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.MinimumProperty"> + <summary> + Defines the Minimum DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.MaximumProperty"> + <summary> + Defines the Maximum DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.GradientStopsProperty"> + <summary>m + Defines the GradientStops DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.Precision"> + <summary> + Gets or sets a value that determines the size of cached color palette. + </summary> + <remarks>Default size is 1000 colors.</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.Minimum"> + <summary> + Gets or sets a value that corresponds to the first color in <see cref="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.GradientStops" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.Maximum"> + <summary> + Gets or sets a value that corresponds to the last color in <see cref="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.GradientStops" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.GradientStops"> + <summary> + Gets or sets a collection of <see cref="T:System.Windows.Media.GradientStop" />, which specifies colors and their offsets. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.AllowsHighPrecision"> + <summary> + Gets or sets whether interpolation between colors is allowed. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HeatmapColorPalette.GetColor(System.Double)"> + <summary> + Returns a color that corresponds to the given value using this color palette. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo"> + <summary> + Provides information on a series hit test operation, see <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> HitTest method for more information. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Empty"> + <summary> + Gets special value which represents a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> instance without data. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Metadata"> + <summary> + Gets or sets <see cref="T:SciChart.Charting.Model.DataSeries.IPointMetadata" /> for the data point at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.DataSeriesName"> + <summary> + Gets or sets the Name of the <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> which was hit. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.DataSeriesType"> + <summary> + Provides information about the type of <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> that was hit tested. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HitTestPoint"> + <summary> + Gets or sets a point snapped to the X-Y value of the series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Y1HitTestPoint"> + <summary> + Gets or sets a point snapped to the X-Y1 series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.XValue"> + <summary> + Gets or sets the X Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.YValue"> + <summary> + Gets or sets the Y-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Y1Value"> + <summary> + Gets or sets the Y1-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.ZValue"> + <summary> + Gets or sets the Z-value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.DataSeriesIndex"> + <summary> + Gets or sets the DataSeriesIndex at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.IsHit"> + <summary> + Gets or sets whether the HitTest operation was a hit or not. + </summary> + <remarks>Defined as the input point being within a small distance of the output hittest point.</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.IsVerticalHit"> + <summary> + Gets or sets whether the HitTest operation was a hit at X or not. + </summary> + <remarks>Defined as the input point being within a small distance of the output hittest point.</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.IsWithinDataBounds"> + <summary> + Gets or sets whether the input point is between first and last series point or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.ErrorHigh"> + <summary> + Gets or sets the Error High value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.ErrorLow"> + <summary> + Gets or sets the Error Low value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.OpenValue"> + <summary> + Gets or sets the Open-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HighValue"> + <summary> + Gets or sets the High-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.LowValue"> + <summary> + Gets or sets the Low-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.CloseValue"> + <summary> + Gets or sets the Close-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HeatmapXIndex"> + <summary> + Gets or sets the XIndex at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HeatmapYIndex"> + <summary> + Gets or sets the YIndex at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HeatmapValue"> + <summary> + Gets or sets the value at the hit-test site, found at [<see cref="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HeatmapXIndex" />, <see cref="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.HeatmapYIndex" />]. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Minimum"> + <summary> + Gets or sets the Minimum-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Maximum"> + <summary> + Gets or sets the Maximum-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Median"> + <summary> + Gets or sets the Median-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.LowerQuartile"> + <summary> + Gets or sets the LowerQuartile-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.UpperQuartile"> + <summary> + Gets or sets the UpperQuartile-Value at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.Percentage"> + <summary> + Returns a value showing which part of the accumulated data in <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> occupies the data point at the hit-test site. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.IsEmpty"> + <summary> + Returns the value, indicating whether current instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> is empty. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.BandSeriesHitTestProvider.NearestHitResult(System.Windows.Point,System.Double,SciChart.Charting.Common.Extensions.SearchMode,System.Boolean)"> + <summary> + Called by <see cref="!:BaseRenderableSeries.HitTest(Point,bool)" /> to get the nearest (non-interpolated) <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> to the mouse point + </summary> + <param name="rawPoint">The mouse point</param> + <param name="hitTestRadius">The radius (in pixels) to use when determining if the <paramref name="rawPoint" /> is over a data-point</param> + <param name="searchMode">The search mode.</param> + <param name="considerYCoordinateForDistanceCalculation">if set to <c>true</c> then perform a true euclidean distance to find the nearest hit result.</param> + <returns> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.ColumnSeriesHitTestProvider.HitTest(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />), + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="hitTestRadius">The radius in pixels to determine whether a mouse is over a data-point</param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.ColumnSeriesHitTestProvider.HitTestInternal(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.ColumnSeriesHitTestProvider.GetSeriesBodyWidth(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.ColumnSeriesHitTestProvider.GetSeriesBodyLowerDataBound(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.ColumnSeriesHitTestProvider.GetSeriesBodyUpperDataBound(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1"> + <summary> + Provides base methods to perform a hit-test at the specific mouse point + </summary> + <typeparam name="TRenderableSeries"></typeparam> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.DefaultHitTestRadius"> + <summary> + A default radius used in the <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.HitTest(System.Windows.Point,System.Boolean)" /> method for interpolation, in RolloverModifier + and instead of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PointMarker" /> size when it is not set + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.#ctor(`0)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1" /> class. + </summary> + <param name="renderSeries">The renderable series.</param> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.RenderableSeries"> + <summary> + Gets the renderable series instance associated to the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.HitTest(System.Windows.Point,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />) with the default HitTestRadius, + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + <example> + <code title="Hit-Test Example" description="Demonstrates how to use the Hit-Test API from a SciChartSurface.MouseLeftButtonUp event" lang="cs"> + // sciChartSurface.MouseLeftButtonUp += SciChartSurfaceMouseLeftButtonUp; + private void SciChartSurfaceMouseLeftButtonUp(object sender, MouseButtonEventArgs e) + { + // Perform the hit test relative to the GridLinesPanel + Point mousePoint = e.GetPosition(sciChartSurface.GridLinesPanel as UIElement); + double datapointRadius = 8; + bool useInterpolation = false; + HitTestInfo result = sciChartSurface.RenderableSeries[0].HitTest(mousePoint, + datapointRadius, useInterpolation); + + // Output results + string formattedString = + string.Format( + "{6}:\tMouse Coord: {0:0}, {1:0}\t\tNearest Datapoint Coord: {2:0.0}, + {3:0.0}\tData Value: {4:0.0}, {5:0.0}", + mousePoint.X, mousePoint.Y, + result.HitTestPoint.X, result.HitTestPoint.Y, + result.XValue, result.YValue, + result.DataSeriesName); + + Console.WriteLine(formattedString); + } + </code> + </example> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.VerticalSliceHitTest(System.Windows.Point,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point with zero hit-test radius. + Method considers only X value and returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct based on the data point with the closest X value + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + <remarks> + Used by <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.HitTest(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />) using passed <paramref name="hitTestRadius" />, + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="hitTestRadius">The radius in pixels to determine whether a mouse is over a data-point</param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + <example> + <code title="Hit-Test Example" description="Demonstrates how to use the Hit-Test API from a SciChartSurface.MouseLeftButtonUp event" lang="cs"> + // sciChartSurface.MouseLeftButtonUp += SciChartSurfaceMouseLeftButtonUp; + private void SciChartSurfaceMouseLeftButtonUp(object sender, MouseButtonEventArgs e) + { + // Perform the hit test relative to the GridLinesPanel + Point mousePoint = e.GetPosition(sciChartSurface.GridLinesPanel as UIElement); + double datapointRadius = 8; + bool useInterpolation = false; + HitTestInfo result = sciChartSurface.RenderableSeries[0].HitTest(mousePoint, + datapointRadius, useInterpolation); + + // Output results + string formattedString = + string.Format( + "{6}:\tMouse Coord: {0:0}, {1:0}\t\tNearest Datapoint Coord: {2:0.0}, + {3:0.0}\tData Value: {4:0.0}, {5:0.0}", + mousePoint.X, mousePoint.Y, + result.HitTestPoint.X, result.HitTestPoint.Y, + result.XValue, result.YValue, + result.DataSeriesName); + + Console.WriteLine(formattedString); + } + </code> + </example> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.NearestHitResult(System.Windows.Point,System.Double,SciChart.Charting.Common.Extensions.SearchMode,System.Boolean)"> + <summary> + Called by <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.HitTest(System.Windows.Point,System.Boolean)" /> to get the nearest (non-interpolated) <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> to the mouse point + </summary> + <param name="mouseRawPoint">The mouse point</param> + <param name="hitTestRadiusInPixels">The radius (in pixels) to use when determining if the <paramref name="mouseRawPoint" /> is over a data-point</param> + <param name="searchMode">The search mode.</param> + <param name="considerYCoordinateForDistanceCalculation">if set to <c>true</c> then perform a true euclidean distance to find the nearest hit result.</param> + <returns> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result + </returns> + <exception cref="T:System.ArgumentException">hitTestRadiusInPixels is NaN</exception> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.GetHitTestInfo(System.Int32,System.Windows.Point,System.Double,System.IComparable)"> + <param name="hitTestRadius">is used to calculate HitTestInfo.IsHit</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.InterpolatePoint(System.Windows.Point,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo,System.Double)"> + <summary> + Interpolation function called by <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.HitTest(System.Windows.Point,System.Boolean)" /> when the interpolate flag is true + </summary> + <param name="rawPoint">Mouse point</param> + <param name="nearestHitResult">Non-interpolated <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /></param> + <param name="hitTestRadius">The value, which indicates distance used to consider whether the series is hit or not</param> + <returns>Interpolated <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.IsHitTest(System.Windows.Point,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo,System.Double,System.Windows.Point,System.Windows.Point)"> + <summary> + When overridden in derived classes, performs hit test on series using interpolated values + </summary> + <param name="rawPoint"></param> + <param name="nearestHitResult"></param> + <param name="hitTestRadius"></param> + <param name="previousDataPoint"></param> + <param name="nextDataPoint"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.GetSeriesBodyWidth(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, returns the width of a single bar, which is + defined by the passed coordinate + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.GetSeriesBodyLowerDataBound(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, returns the lower value of a compound data point, which is + defined by the passed coordinate + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.GetSeriesBodyUpperDataBound(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, returns the upper value of a compound data point, which is + defined by the passed coordinate + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1.IsBodyHit(System.Windows.Point,System.Windows.Rect,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + When overridden in derived classes, performs the hit-test check on the bounding rect of a single series bar + </summary> + <param name="pt"></param> + <param name="boundaries"></param> + <param name="nearestHitPoint"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.ExtremeScatterSeriesHitTestProvider.HitTestInternal(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + <inheritdoc /> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider"> + <summary> + <para>The interface to a Hit-Test provider, has methods such as <see cref="!:HitTest(Windows.Foundation.Point,double,bool)" /> which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with information about the data-point and series at the screen coordinates.</para> + <para>Each <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> must have a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> and the default implementation is <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.DefaultHitTestProvider`1" /></para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />), + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />), + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="hitTestRadius">The radius in pixels to determine whether a mouse is over a data-point</param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.VerticalSliceHitTest(System.Windows.Point,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point with zero hit-test radius. + Method considers only X values and returns a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the closest X value + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />, <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> or <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + <remarks> + Used by <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> and <see cref="T:SciChart.Charting.ChartModifiers.VerticalSliceModifier" /></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.MountainSeriesHitTestProvider.NearestHitResult(System.Windows.Point,System.Double,SciChart.Charting.Common.Extensions.SearchMode,System.Boolean)"> + <summary> + Called by <see cref="!:BaseRenderableSeries.HitTest(Point, bool)" /> to get the nearest (non-interpolated) <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> to the mouse point + </summary> + <param name="mouseRawPoint">The mouse point</param> + <param name="hitTestRadiusInPixels">The radius (in pixels) to use when determining if the <paramref name="mouseRawPoint" /> is over a data-point</param> + <param name="searchMode">The search mode.</param> + <param name="considerYCoordinateForDistanceCalculation">if set to <c>true</c> then perform a true euclidean distance to find the nearest hit result.</param> + <returns> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result + </returns> + <exception cref="T:System.ArgumentException">hitTestRadiusInPixels is NAN</exception> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.MountainSeriesHitTestProvider.IsHitTest(System.Windows.Point,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo,System.Double,System.Windows.Point,System.Windows.Point)"> + <summary> + When overridden in derived classes, performs hit test on series using interpolated values + </summary> + <param name="rawPoint"></param> + <param name="nearestHitResult"></param> + <param name="hitTestRadius"></param> + <param name="previousDataPoint"></param> + <param name="nextDataPoint"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.StackedColumnSeriesHitTestProvider.GetSeriesBodyLowerDataBound(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Returns the series lower bound at nearest hit point + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.StackedColumnSeriesHitTestProvider.GetSeriesBodyUpperDataBound(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Returns the series upper bound at nearest hit point + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.StackedColumnSeriesHitTestProvider.GetSeriesBodyWidth(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Returns the width of a single column at <see cref="P:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo.DataSeriesIndex" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.StackedMountainSeriesHitTestProvider.IsHitTest(System.Windows.Point,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo,System.Double,System.Windows.Point,System.Windows.Point)"> + <summary> + When overridden in derived classes, performs hit test on series using interpolated values + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.TernaryPolygonSeriesHitTestProvider.NearestHitResult(System.Windows.Point,System.Double,SciChart.Charting.Common.Extensions.SearchMode,System.Boolean)"> + <summary> + Called by <see cref="!:BaseRenderableSeries.HitTest(Point, bool)" /> to get the nearest (non-interpolated) <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> to the mouse point + </summary> + <param name="mouseRawPoint">The mouse point</param> + <param name="hitTestRadiusInPixels">The radius (in pixels) to use when determining if the <paramref name="mouseRawPoint" /> is over a data-point</param> + <param name="searchMode">The search mode.</param> + <param name="considerYCoordinateForDistanceCalculation">if set to <c>true</c> then perform a true euclidean distance to find the nearest hit result.</param> + <returns> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result + </returns> + <exception cref="T:System.ArgumentException">hitTestRadiusInPixels is NAN</exception> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.TernarySeriesHitTestProvider.HitTest(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + Performs a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" />), + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></param> + <param name="hitTestRadius">The radius in pixels to determine whether a mouse is over a data-point</param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> or <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.TernarySeriesHitTestProvider.HitTestInternal(System.Windows.Point,System.Double,System.Boolean)"> + <summary> + Performs internaly a hit-test at the specific mouse point (X,Y coordinate on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" />), + returning a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </summary> + <param name="rawPoint">The mouse point on the parent <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /></param> + <param name="hitTestRadius">The radius in pixels to determine whether a mouse is over a data-point</param> + <param name="interpolate">If true, use interpolation to perform a hit-test between data-points, or on the area if a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> or <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /></param> + <returns> + A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct with the results + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.TernarySeriesHitTestProvider.NearestHitResult(System.Windows.Point,System.Double,SciChart.Charting.Common.Extensions.SearchMode,System.Boolean)"> + <summary> + Called by <see cref="!:BaseRenderableSeries.HitTest(Point, bool)" /> to get the nearest (non-interpolated) <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> to the mouse point + </summary> + <param name="mouseRawPoint">The mouse point</param> + <param name="hitTestRadiusInPixels">The radius (in pixels) to use when determining if the <paramref name="mouseRawPoint" /> is over a data-point</param> + <param name="searchMode">The search mode.</param> + <param name="considerYCoordinateForDistanceCalculation">if set to <c>true</c> then perform a true euclidean distance to find the nearest hit result.</param> + <returns> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> result + </returns> + <exception cref="T:System.ArgumentException">hitTestRadiusInPixels is NAN</exception> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IExtremePointMarkerPaletteProvider"> + <summary> + Defines the interface to a PaletteProvider which is used by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries" />. By implementing this interface, you can override the Fill and Stroke color of <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" /> + by setting or binding to the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PaletteProvider" /> property. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IExtremePointMarkerPaletteProvider.Colors"> + <summary> + Gets the colors which is used to render PointMarker + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase"> + <summary> + Defines common properties to 2D and 3D RenderableSeries throughout the SciChart SDK + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase.IsVisibleChanged"> + <summary> + Event raised whenever IsVisible property changed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase.GetXRange"> + <summary> + Returns the data range of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase" /> by querying the associated DataSeries. + + Individual RenderableSeries implementations may override this method to provide custom ranging on a per-series basis + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries"> + <summary> + Defines the interface to all RenderableSeries within SciChart. A RenderableSeries is a Line series, or Scatter series or Candlestick series and provides the visual element in pair of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> and <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.SelectionChanged"> + <summary> + Event raised whenever IsSelected property changed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.AntiAliasing"> + <summary> + Gets or sets whether this series uses AntiAliasing when drawn + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <remarks>This is used by each series type in different ways. For instance: + <list type="bullet"><item><see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> and <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" /> uses the Stroke to draw the line series</item><item><see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> uses the Stroke to draw the line over the filled area</item><item><see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> uses the Stroke to draw the first line of the pair</item><item><see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> uses this property to draw the outline of the columns</item><item><see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> and <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> all ignore this property</item></list></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.IsSelected"> + <summary> + Gets or sets value, indicates whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is selected + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness in pixels for this series + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.StrokeDashArray"> + <summary> + If this series draws a line, this property gets or sets a StrokeDashArray property, used to define a dashed line. See the MSDN Documentation for + <see cref="P:System.Windows.Shapes.Shape.StrokeDashArray" /> as this property attempts to mimic the same behaviour + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.IsDigitalLine"> + <summary> + If this series draws a line, this property is used to define a value indicating whether this line is a digital (step) line + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.ResamplingMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Data.Numerics.ResamplingMode" /> used when drawing this series + </summary> + <remarks> + <list type="bullet"> + <item> + None: Do not use resampling when redrawing a series + </item> + MinMax: Resample by taking the min-max of oversampled data. This results in the most visually accurate resampling, with the most performant rendering + <item> + Mid: Resample by taking the median point of oversampled data + </item><item> + Max: Resample by taking the maximum point of oversampled data + </item><item> + Min: Resample by taking the minimum point of oversampled data + </item></list> + </remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.Opacity"> + <summary> + Gets or sets an override Opacity value from 0.0 - 1.0 for the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.ResamplingPrecision"> + <summary> + Gets or sets the resampling precision for this series + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.ZeroLineY"> + <summary> + Gets or sets the value which determines the zero line in Y direction. + Used to set the bottom of a column, or the zero line in a mountain + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.XAxis"> + <summary> + Gets or sets the XAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.YAxis"> + <summary> + Gets or sets the YAxis that this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.SelectedSeriesStyle"> + <summary> + Gets or sets style for selected series + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.Style"> + <summary> + Gets or sets the style to apply to the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DataContext"> + <summary> + Gets or sets the DataContext to apply to the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.RolloverMarker"> + <summary> + Gets a cached Framework Element which is used as a Rollover Marker. + This is generated from a ControlTemplate in xaml via the <see cref="F:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.RolloverMarkerTemplateProperty" /> DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.YAxisId"> + <summary> + Gets or sets the ID of the Y-Axis which this renderable series is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.XAxisId"> + <summary> + Gets or sets the ID of the X-Axis which this renderable series is measured against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.CurrentRenderPassData"> + <summary> + Gets or sets the RenderPassData instance used for this render pass + </summary> + <value>The render data.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.PaletteProvider"> + <summary> + Gets or Sets an optional <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> instance, which may be used to override specific data-point colors during rendering. + For more details, see the <see cref="T:SciChart.Charting.Visuals.PaletteProviders.IPaletteProvider" /> documentation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.SeriesAnimation"> + <summary> + Gets or sets animation applied to this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DrawNaNAs"> + <summary> + Gets or sets a value indicating how this renderable series will treat double.NaN. See <see cref="T:SciChart.Charting.Visuals.RenderableSeries.LineDrawMode" /> for available options + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.OnAttached"> + <summary> + Called when a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is added to a <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.OnDetached"> + <summary> + Called when a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is removed from a <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.GetSeriesInfo(SciChart.Charting.Visuals.RenderableSeries.HitTestInfo)"> + <summary> + Converts a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> hit-test result into a <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> viewmodel for use in the + <see cref="T:SciChart.Charting.Visuals.SciChartLegend" />, <see cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" />, <see cref="T:SciChart.Charting.ChartModifiers.CursorModifier" />. + </summary> + <remarks>All the legend and tooltip + types bind to <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" />, so this is a useful API function to convert hit-test results into this useful type.</remarks> + <param name="hitTestInfo">The hit-test result to convert</param> + <returns></returns> + <seealso cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.RolloverModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.CursorModifier" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.LegendModifier" /> + <seealso cref="T:SciChart.Charting.Visuals.SciChartLegend" /> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.GetYRange(SciChart.Data.Model.IRange)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction. + <param name="xRange">The X-Axis Range currently in view</param></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction. + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.GetIndicesRange(SciChart.Data.Model.IRange)"> + <summary> + Returns the indices range of data points in <paramref name="xRange" /> of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" />. + <param name="xRange">The X-Axis Range currently in view</param></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.ShowsTooltipForModifier(System.Func{SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries,System.Boolean})"> + <summary> + Reserved for internal usage. Called by modifiers to find out whether a tooltip should appear for this series. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.GetPointMarker"> + <summary> + For internal use: Returns the cached PointMarker instance used by this series + </summary> + <returns></returns> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.HitTestProvider"> + <summary> + <para>Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series.</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series.</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries"> + <summary> + Defines the interface to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.Wrapper"> + <summary> + Gets the instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper" /> used internally for + stacked series composition and rendering. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.Spacing"> + <summary> + Gets or sets the value which specifies the width of the gap between horizontally stacked columns. + Can be set to either a relative or absolute value depending on the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.SpacingMode" /> used. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.SpacingMode"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.SpacingMode" /> to use for the space between columns computations. + E.g. the default of Absolute requires that <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.Spacing" /> is in pixels. The value + of Relative requires that <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.Spacing" /> is a double value from 0.0 to 1.0. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.DataPointWidth"> + <summary> + Gets or sets the value between 0.0 and 1.0 indicating how much of the space available every column occupies. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.ShowLabel"> + <summary> + Gets or sets the value indicating whether to show text labels over the columns. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.LabelColor"> + <summary> + Gets or sets the foreground color for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.LabelFontSize"> + <summary> + Gets or sets the font size for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.LabelTextFormatting"> + <summary> + Gets or sets the formatting string for text labels. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.GetDatapointWidth(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Data.Model.IPointSeries,System.Double,System.Double)"> + <summary> + Calculates the space available per a data-point. + </summary> + <param name="xCoordinateCalculator">The current x coordinate calculator instance</param> + <param name="pointSeries">The current <see cref="T:SciChart.Data.Model.IPointSeries" /> being rendered.</param> + <param name="barsAmount">Amount of bars within the viewport</param> + <param name="widthFraction">The width fraction from 0.0 to 1.0, where 0.0 is infinitely small, 0.5 takes up half the available width and 1.0 means a data-point is the full width between points</param> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries.IsValidForDrawing"> + <summary> + Gets the value which indicates if stacked series is valid for composition and rendering. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.SpacingMode"> + <summary> + Defines the mode of setting spacing between <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> groups + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.SpacingMode.Absolute"> + <summary> + For setting spacing in pixels + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.SpacingMode.Relative"> + <summary> + For setting spacing in fraction of column group width + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper"> + <summary> + Defines interface for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnsWrapper" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper.GetDataPointWidthFraction"> + <summary> + Gets fraction of the data point width + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper.GetSeriesBodyWidth(SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries,System.Int32)"> + <summary> + Returns DataPointWith of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries" /> considering spacing between groups + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper.GetSeriesVerticalBounds(SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries,System.Int32)"> + <summary> + Returns Upper and Lower Bound of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnRenderableSeries" /> column + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper.GetXRange(System.Boolean)"> + <summary> + Returns the data range of all the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on X direction + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IStackedMountainRenderableSeries"> + <summary> + Defines the interface to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedMountainRenderableSeries.Wrapper"> + <summary> + Gets the instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper" /> used internally for + stacked series composition and rendering. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedMountainRenderableSeries.IsDigitalLine"> + <summary> + Gets or sets a value indicating whether this line series is a digital (step) line. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries.StackedGroupId"> + <summary> + Gets or sets a string stacked-group Id, used to ensure series are stacked together + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries.StackedSeriesId"> + <summary> + Gets a string stacked-series Id, used to identify series in the same group + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries.IsOneHundredPercent"> + <summary> + Gets or sets a value whether all series with the same <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries.StackedGroupId" /> will appear 100% stacked + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1"> + <summary> + Defines common properties to stacked series wrappers, such as <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnsWrapper" /> and <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainsWrapper" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.StackedSeriesCount"> + <summary> + Gets amount of the series being stacked. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.IsOneHundredPercentGroup(System.String)"> + <summary> + Gets a value indicating whether all the series within the StackedGroup are 100% stacked. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.AccumulateYValueAtX(`0,System.Int32,System.Boolean)"> + <summary> + Accumulate Y value at <paramref name="index" /> for a stacked series, + where Tuple.Item1 represents the upper series value at the <paramref name="index" /> and Tuple.Item2 - the lower one. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.CalculateYRange(`0,SciChart.Data.Model.IndexRange,System.Boolean)"> + <summary> + Gets the YRange of the data (min, max of the <paramref name="series" />) in the passed <param name="xIndexRange" />, where indices are point-indices on the DataSeries columns. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.GetYRangeAtX(`0,System.Func{`0,System.Double})"> + <summary> + Gets the YRange of the data (min, max of the <paramref name="series" />), using the <param name="getYValue" /> passed in. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.DrawStackedSeries(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Draws all the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries" /> being wrapped, using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> passed in. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.ShiftHitTestInfo(System.Windows.Point,SciChart.Charting.Visuals.RenderableSeries.HitTestInfo,System.Double,`0)"> + <summary> + Called internally to correlate a hit-test result for the <param name="series" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.AddSeries(`0)"> + <summary> + Adds the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries" /> to the internal collection. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.RemoveSeries(`0)"> + <summary> + Removes the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries" /> from the internal collection. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.MoveSeriesToAnotherGroup(`0,System.String,System.String)"> + <summary> + Called internally to move series from one StackedGroup to another. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IStackedSeriesWrapperBase`1.GetStackedSeriesFromSameGroup(System.String)"> + <summary> + Returns all the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedRenderableSeries" /> from the same StackedGroup. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.IMarketProfileRenderableSeries"> + <summary> + Defines an interface for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> types that use <see cref="P:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.IMarketProfileRenderableSeries.MarketProfileSeriesHelper" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.IMarketProfileRenderableSeries.MarketProfileSeriesHelper"> + <summary> + Returns a helper for finding volume values at a given price for <see cref="T:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.IMarketProfileRenderableSeries" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper"> + <summary> + Used by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.IMarketProfileRenderableSeries" /> types to accumulate candle volumes. + Can be created in a ViewModel to get series data there. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.TickSizeProperty"> + <summary> + Defines the TickSize DependencyProperty. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.TickSizeChanged"> + <summary> + Fires every time when the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.TickSize" /> property gets changed. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.#ctor"> + <summary> + Initializes a new <see cref="T:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper" /> instance. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.TickSize"> + <summary> + Gets or sets the price delta value which is used to aggregate candle ticks. + This is also the tick size of the associated Y axis (price axis). + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.GetAskAtPrice(System.Double)"> + <summary> + Gets cumulative Ask volume at the given price. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.MarketProfileSeries.MarketProfileSeriesHelper.GetBidAtPrice(System.Double)"> + <summary> + Gets cumulative Bid volume at the given price. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries"> + <summary> + Defines the interface to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />, which can be rendered on <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.AntiAliasing"> + <summary> + Gets or sets whether lines in this series appear anti-aliased. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.Stroke"> + <summary> + Gets or sets the stroke color for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.Fill"> + <summary> + Gets or sets the fill brush for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.IsSelected"> + <summary> + Gets or sets the value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> is selected. + <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SelectedSeriesStyle" /> is applied when this property is <value>True</value>. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.StrokeThickness"> + <summary> + Gets or sets the stroke thickness for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.DataSeries"> + <summary> + Gets or sets the data source for this series, a collection of data points of the <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> type. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SelectedSeriesStyle"> + <summary> + Gets or sets a style which is applied when this series gets selected. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.IsSelected" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.IsVisible"> + <summary> + Gets or sets whether this series is drawn on a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.IsFilled"> + <summary> + Gets or sets whether this series gets filled with the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.Fill" /> brush or appears not filled. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.PointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance for this series. When a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + is present, then corresponding markers will be drawn at each data-point from <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.DataSeries" /> in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SelectedPointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance for this series. When a data-point from <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.DataSeries" /> + gets selected, the corresponding marker will be drawn at its location. + See <see cref="P:SciChart.Charting.Model.DataSeries.IRadarPointViewModel.IsSelected" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.LegendMarkerTemplate"> + <summary> + Gets or sets a <see cref="T:System.Windows.DataTemplate" /> that defines the Visual to be rendered on the Legend as a series marker for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.ParentSurface"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> that is associated with this series. + </summary> + <value>The parent surface.</value> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SeriesName"> + <summary> + Gets or sets a string name for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.Opacity"> + <summary> + Gets or sets the opacity for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> instance and shared between various scichart components throughout the surface instance. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.IsValidForDrawing"> + <summary> + Gets a value indicating whether this series is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.OnDraw(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called internally to render this series. + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> used for drawing.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.HitTest(System.Windows.Point)"> + <summary> + Performs the hit-test operation on this series. + </summary> + <param name="mousePoint">A hit-test point in screen coordinates.</param> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.SelectionChanged"> + <summary> + Event raised whenever this series gets selected. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries.IsSelected" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries"> + <summary> + Defines a Polygon renderable series, supporting solid or gradient fill, stroked (thickness 1+) lines and + optional point-markers <seealso cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" />. + </summary> + <remarks> + A RenderableSeries accepts a collection of <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> as the data-source, + may render optional <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-markers, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" />. + </remarks> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.AntiAliasingProperty"> + <summary> + Defines the AntiAliasing DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.StrokeProperty"> + <summary> + Defines the Stroke DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsSelectedProperty"> + <summary> + Defines the IsSelected DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeriesProperty"> + <summary> + Defines the DataSeries DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SelectedSeriesStyleProperty"> + <summary> + Defines the SelectedSeriesStyle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsVisibleProperty"> + <summary> + Defines the IsVisible DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.PointMarkerProperty"> + <summary> + Defines the PointMarker DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SelectedPointMarkerProperty"> + <summary> + Defines the SelectedPointMarker DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.LegendMarkerTemplateProperty"> + <summary> + Defines the LegendMarkerTemplate DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.FillProperty"> + <summary> + Defines the Fill DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsFilledProperty"> + <summary> + Defines the IsFilled DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SeriesNameProperty"> + <summary> + Defines the SeriesName DependencyProperty. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SelectionChanged"> + <summary> + Event raised whenever this series gets selected. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsSelected" />. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsVisibleChanged"> + <summary> + Event raised whenever <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsVisible" /> changes for this series. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> instance and shared between various scichart components throughout the surface instance. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SeriesName"> + <summary> + Gets or sets a string name for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsFilled"> + <summary> + Gets or sets whether this series gets filled with the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.Fill" /> brush or appears not filled. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.Fill"> + <summary> + Gets or sets the fill brush for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.LegendMarkerTemplate"> + <summary> + Gets or sets a <see cref="T:System.Windows.DataTemplate" /> that defines the Visual to be rendered on the Legend as a series marker for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SelectedPointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance for this series. When a data-point from <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeries" /> + gets selected, the corresponding marker will be drawn at its location. + See <see cref="P:SciChart.Charting.Model.DataSeries.IRadarPointViewModel.IsSelected" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.PointMarker"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> instance for this series. When a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + is present, then corresponding markers will be drawn at each data-point from <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeries" /> in the series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsVisible"> + <summary> + Gets or sets whether this series is drawn on a <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SelectedSeriesStyle"> + <summary> + Gets or sets a style which is applied when this series gets selected. + See <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsSelected" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeries"> + <summary> + Gets or sets the data source for this series, a collection of data points of the <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> type. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.StrokeThickness"> + <summary> + Gets or sets the stroke thickness for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsSelected"> + <summary> + Gets or sets the value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> is selected. + <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.SelectedSeriesStyle" /> is applied when this property is <value>True</value>. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.Stroke"> + <summary> + Gets or sets the stroke color for this series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.AntiAliasing"> + <summary> + Gets or sets whether lines in this series appear anti-aliased. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.ParentSurface"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> that is associated with this series. + </summary> + <value>The parent surface.</value> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.OnDraw(SciChart.Drawing.Common.IRenderContext2D)"> + <summary> + Called internally to render this series. + </summary> + <param name="renderContext">The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> used for drawing.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.HitTest(System.Windows.Point)"> + <summary> + Performs the hit-test operation on this series. + </summary> + <param name="mousePoint">A hit-test point in screen coordinates.</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.GetIsValidForDrawing"> + <summary> + Returns a value indicating whether this series is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.OnInvalidateParentSurface"> + <summary> + Triggers a redraw of the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.GetPolygonPoints(System.Boolean)"> + <summary> + Returns a collection of coordinates for all data-points from <see cref="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.DataSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.IsValidForDrawing"> + <summary> + Gets a value indicating whether this series is valid for drawing. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used. + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries.OnInvalidateParentSurface(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + When called, invalidates the parent <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" />. + </summary> + <param name="d">The DependencyObject that raised the event.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRadarPolygonRenderableSeriesViewModel" /> in MVVM scenarios. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeriesForMvvm.StyleKeyProperty"> + <summary> + Defines the StyleKey DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RadarPolygonRenderableSeriesForMvvm.StyleKey"> + <summary> + Gets or sets the StyleKey dependency property + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastImpulseRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.ExtremeScatterRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastNonUniformHeatmapRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastHistoBarRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMarketProfileRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastVolumeCandlestickRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeriesForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeries" /> and is created internally + per every <see cref="T:SciChart.Charting.Model.ChartSeries.IRenderableSeriesViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeriesForMvvm.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformContourRenderableSeriesForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData"> + <summary> + Defines the interface to <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RenderPassData" />, the data used in a single render pass by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> derived types + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.SupportsNativeCoordinateCalculators"> + <summary> + Gets a value indicating whether the data and parameters for this render pass support the Tsr (accelerated) drawing method + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointRange"> + <summary> + Gets the integer indices of the X-Data array that are currently in range. + </summary> + <returns>The indices to the X-Data that are currently in range</returns> + <example>If the input X-data is 0...100 in steps of 1, the VisibleRange is 10, 30 then the PointRange will be 10, 30</example> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.PointSeries"> + <summary> + Gets the current point series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.ResamplingHash"> + <summary> + Gets the hash of resampling params which were used to resample point series + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.IsVerticalChart"> + <summary> + Gets a value, indicating whether current chart is vertical + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.YCoordinateCalculator"> + <summary> + Gets the current Y coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.XCoordinateCalculator"> + <summary> + Gets the current X coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData.TransformationStrategy"> + <summary> + Gets the current pixel transformation strategy + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.RenderPassData"> + <summary> + Provides data used in a single render pass by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> derived types + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.#ctor(SciChart.Data.Model.IndexRange,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},SciChart.Data.Model.IPointSeries,System.Int32,SciChart.Charting.StrategyManager.ITransformationStrategy,System.Boolean)"> + <summary>Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RenderPassData" /> class.</summary> + <param name="pointRange">The integer indices to the X-data array that are currently in range.</param> + <param name="xCoordinateCalculator">The current X Coordinate Calculator</param> + <param name="yCoordinateCalculator">The current Y Coordinate Calculator</param> + <param name="pointSeries">The resampled PointSeries to draw</param> + <param name="resamplingHash"></param> + <param name="transformationStrategy"></param> + <param name="supportsNativeCoordinateCalculators"></param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.IsVerticalChart"> + <summary> + Gets a value, indicating whether current chart is vertical + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.YCoordinateCalculator"> + <summary> + Gets the current Y coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.XCoordinateCalculator"> + <summary> + Gets the current X coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.PointSeries"> + <summary> + Gets the current point series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.ResamplingHash"> + <summary> + Gets the hash of resampling params which were used to resample point series + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.SupportsNativeCoordinateCalculators"> + <summary>Gets a value indicating whether the data and parameters for this render pass support the Tsr (accelerated) drawing method</summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.PointRange"> + <summary> + Gets the integer indices of the X-Data array that are currently in range. + </summary> + <returns>The indices to the X-Data that are currently in range</returns> + <example>If the input X-data is 0...100 in steps of 1, the VisibleRange is 10, 30 then the PointRange will be 10, 30</example> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.RenderPassData.TransformationStrategy"> + <summary> + Gets the current pixel transformation strategy + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries"> + <summary> + Defines a Stacked-Column renderable series, supporting rendering of column bars which have accumulated Y-values for multiple series in a group. + </summary> + <remarks> + The StackedColumnRenderableSeries may render data from any a <see cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> derived data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.StackedGroupIdProperty"> + <summary> + Defines the StackedGroupId DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.IsOneHundredPercentProperty"> + <summary> + Defines the IsOneHundredPercent DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.SpacingProperty"> + <summary> + Defines the Spacing DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.SpacingModeProperty"> + <summary> + Defines the SpacingMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.ShowLabelProperty"> + <summary> + Defines the ShowLabel DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.LabelColorProperty"> + <summary> + Defines the LabelColor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.LabelFontSizeProperty"> + <summary> + Defines the LabelFontSize DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.LabelTextFormattingProperty"> + <summary> + Defines the LabelTextFormatting DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.StackedSeriesId"> + <summary> + Gets a string StackedSeriesId. All series within the same group get stacked vertically. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.StackedGroupId"> + <summary> + Gets or sets a string StackedGroupId. All series within the same group get stacked vertically. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.IsOneHundredPercent"> + <summary> + Gets or sets the value which indicates whether the series are 100% stacked + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.Spacing"> + <summary> + Gets or sets the value which specifies the width of the gap between horizontally stacked columns. + Can be set to either a relative or absolute value depending on the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.SpacingMode" /> used. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.SpacingMode"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.SpacingMode" /> to use for the space between columns computations. + E.g. the default of Absolute requires that <see cref="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.Spacing" /> is in pixels. The value + of Relative requires that <see cref="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.Spacing" /> is a double value from 0.0 to 1.0. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.ShowLabel"> + <summary> + Gets or sets the value indicating whether to show text labels over the columns. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.LabelColor"> + <summary> + Gets or sets the foreground color for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.LabelFontSize"> + <summary> + Gets or sets the font size for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.LabelTextFormatting"> + <summary> + Gets or sets the formatting string for text labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.Wrapper"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedColumnsWrapper" /> instance which wraps this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.GetXRange"> + <summary> + Computes the full X data range which current <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> occupies. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.InternalDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Draws the series using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> and the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> passed in. + </summary> + <param name="renderContext">The render context. This is a graphics object which has methods to draw lines, quads and polygons to the screen</param> + <param name="renderPassData">The render pass data. Contains a resampled <see cref="T:SciChart.Data.Model.IPointSeries" />, the <see cref="T:SciChart.Data.Model.IndexRange" /> of points on the screen + and the current YAxis and XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> to convert data-points to screen points</param> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.GetChartRotationAngle"> + <summary> + Used Internally: gets the rotation angle of the chart, which is 0 degrees or 90 degrees depending on whether the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + has swapped X and Y Axes or not. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries.GetIsValidForDrawing"> + <summary> + Gets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> is valid for drawing. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries"> + <summary> + Defines a Stacked-Mountain renderable series, supporting rendering of mountain areas which have accumulated Y-values for multiple series in a group. + </summary> + <remarks> + The StackedMountainRenderableSeries may render data from any a <see cref="T:SciChart.Charting.Model.DataSeries.IXyDataSeries`2" /> derived data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastLineRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastOhlcRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastCandlestickRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBandRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastErrorBarsRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBoxPlotRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastBubbleRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.FastUniformHeatmapRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedColumnRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.StackedGroupIdProperty"> + <summary> + Defines the StackedGroupId DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.IsOneHundredPercentProperty"> + <summary> + Defines the IsOneHundredPercent DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.Wrapper"> + <summary> + The <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IStackedMountainsWrapper" /> instance which wraps this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.StackedSeriesId"> + <summary> + Gets a string StackedSeriesId. All series within the same group get stacked vertically. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.StackedGroupId"> + <summary> + Gets or sets a string stacked-group Id, used to ensure columns are stacked together + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.IsOneHundredPercent"> + <summary> + Gets or sets a value whether all series with the same <see cref="P:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.StackedGroupId" /> will appear 100% stacked + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.GetYRange(SciChart.Data.Model.IRange,System.Boolean)"> + <summary> + Returns the data range of the associated <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> on Y direction + <param name="xRange">The X-Axis Range currently in view</param><param name="getPositiveRange">Indicates whether to return positive YRange only</param></summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.StackedMountainRenderableSeries.InternalDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)"> + <summary> + Draws the series using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> and the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderPassData" /> passed in. + </summary> + <param name="renderContext">The render context. This is a graphics object which has methods to draw lines, quads and polygons to the screen</param> + <param name="renderPassData">The render pass data. Contains a resampled <see cref="T:SciChart.Data.Model.IPointSeries" />, the <see cref="T:SciChart.Data.Model.IndexRange" /> of points on the screen + and the current YAxis and XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> to convert data-points to screen points</param> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.TemplatableControl"> + <summary> + Placeholder class for an empty control. Should be styled via control template + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TemplatableControl.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.PointMarker"> + <summary> + Placeholder class for a PointMarker. Should be styled via control template + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.PointMarker.DeferredContentProperty"> + <summary> + Defines the DeferredContent DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.PointMarker.DeferredContent"> + <summary> + Gets or sets the <see cref="T:System.Windows.DataTemplate" /> which content is going to be used as a Content + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.PointMarker.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.PointMarker.CreateFromTemplate(System.Windows.Controls.ControlTemplate,System.Object)"> + <summary> + Returns new instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PointMarker" />, which was created from the <paramref name="template" /></summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.LegendPlaceholder"> + <summary> + Used as a helper class to place a Legend inside. Used by <see cref="T:SciChart.Charting.ChartModifiers.LegendModifier" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.LegendPlaceholder.#ctor"> + <summary> + Initializes a new <see cref="T:SciChart.Charting.Visuals.RenderableSeries.LegendPlaceholder" /> instance. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.Legend3DPlaceholder"> + <summary> + Used as a helper class to place a Legend inside. Used by <see cref="!:LegendModifier3D" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.Legend3DPlaceholder.#ctor"> + <summary> + Initializes a new <see cref="T:SciChart.Charting.Visuals.RenderableSeries.Legend3DPlaceholder" /> instance. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.RadarLegendPlaceHolder"> + <summary> + Used as a helper class to place a Legend inside. Used by <see cref="T:SciChart.Charting.ChartModifiers.RadarLegendModifier" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarLegendPlaceHolder.#ctor"> + <summary> + Initializes a new <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarLegendPlaceHolder" /> instance. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.TernaryLegendPlaceholder"> + <summary> + Used as a helper class to place a Legend inside. Used by <see cref="T:SciChart.Charting.ChartModifiers.TernaryLegendModifier" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TernaryLegendPlaceholder.#ctor"> + <summary> + Initializes a new <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryLegendPlaceholder" /> instance. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ScrollbarResizeGrip"> + <summary> + Used as a root element for <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> resizing grip. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ScrollbarResizeGrip.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ScrollbarResizeGrip" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ScrollbarViewport"> + <summary> + Used as a root element for <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> viewport which shows currently selected area. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.ScrollbarViewport.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ScrollbarResizeGrip" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TooltipControl.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TooltipControl" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.PieTooltipControl.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PieTooltipControl" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.RadarTooltipControl.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.RadarTooltipControl" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.PieLabelControl.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PieLabelControl" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.AxisLabelControl" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.CursorLabelControl.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.CursorLabelControl" /> class. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ErrorType"> + <summary> + Defines constants for Error type, used by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> to specify error type + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ErrorType.Relative"> + <summary> + Refers to the relative error type + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ErrorType.Absolute"> + <summary> + Refers to the absolute error type + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.ErrorDirection"> + <summary> + Defines constants for X, Y or Z direction, used by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> to specify error direction of X, Y or Z axis + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ErrorDirection.XAxis"> + <summary> + Refers to the X-Axis Direction + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ErrorDirection.YAxis"> + <summary> + Refers to the Y-Axis Direction + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.ErrorDirection.ZAxis"> + <summary> + Refers to the Z-Axis Direction + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries"> + <summary> + Defines an Error Bars renderable series, supporting solid, stroked error bars and + optional Point-markers <seealso cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" />. + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data-source, + may have a <see cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> point-marker, and draws onto a specific <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> using the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" />. + A given <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> may have 0..N <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, each of which may map to, or share a <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /></remarks> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.PointMarkers.BasePointMarker" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.ErrorDirectionProperty"> + <summary> + Defines the ErrorDirection DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.ErrorTypeProperty"> + <summary> + Defines the ErrorType DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.HighErrorProperty"> + <summary> + Defines the HighError DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.LowErrorProperty"> + <summary> + Defines the LowError DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.ErrorBarCupLengthProperty"> + <summary> + Defines the ErrorBarCupLength DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.ErrorDirection"> + <summary> + Get or set error axis direction + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.ErrorBarCupLength"> + <summary> + Get or set length for error bar cups + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.LowError"> + <summary> + Get or set low error data value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.HighError"> + <summary> + Get or set high error data value + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryErrorBarRenderableSeries.ErrorType"> + <summary> + Get or set error type + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries"> + <summary> + Defines an Polygon renderable series. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.LabelStyleProperty"> + <summary> + Defines the LabelStyleProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.FillProperty"> + <summary> + Defines the FillProperty DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.LabelStyle"> + <summary> + Gets or sets a style for the polygon label + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.Fill"> + <summary> + Gets or sets a fill brush for this series. The polygon's outline is specified by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryPolygonRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData"> + <summary> + Provides data used in a single render pass by <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseTernaryRenderableSeries" /> derived types. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.#ctor(SciChart.Charting.Numerics.CoordinateCalculators.TernaryCoordinateCalculator,SciChart.Charting.Model.DataSeries.IXyzDataSeries{System.Double,System.Double,System.Double})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData" /> class. + </summary> + <param name="calculators">The current coordinate calculators</param> + <param name="dataSeries">The current data series</param> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.ZCoordinateCalculator"> + <summary> + Gets the current Z coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.Calculators"> + <summary> + Gets the current coordinate calculators. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.DataSeries"> + <summary> + Gets the current data series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.PointSeries"> + <summary> + Gets the current point series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.PointRange"> + <summary> + Gets the integer indices of the X-Data array that are currently in range. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.ResamplingHash"> + <summary> + Gets the hash of resampling params which were used to resample point series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.IsVerticalChart"> + <summary> + Gets a value, indicating whether current chart is vertical. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.YCoordinateCalculator"> + <summary> + Gets the current Y coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.XCoordinateCalculator"> + <summary> + Gets the current X coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.TransformationStrategy"> + <summary> + Gets the current pixel transformation strategy. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryRenderPassData.PolarAxisRotationAngle"> + <summary> + Gets the current rotation angle for the polar chart axis. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries"> + <summary> + Provides Scatter series rendering via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" /> property. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.TernaryScatterRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries"> + <summary> + Provides Scatter series rendering via the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.PointMarker" /> property. + </summary> + <remarks> + <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> does not support resampling and so ignores the <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.ResamplingMode" /> property</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries.DoClusterResampling"> + <summary> + Gets or sets a value indicating whether this <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> should use Cluster Resampling + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries.HitTestProvider"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider" /> implementation associated with this series. This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.HitTesters.IHitTestProvider.HitTest(System.Windows.Point,System.Boolean)" /> + which return a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> struct containing information about the Hit-Test operation. Use to determine points near the mouse or whether the mouse is over a series. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.RenderableSeries.XyScatterRenderableSeries.DrawingProviders"> + <summary> + <para>Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider" /> implementations associated with this series.</para> + <para>Each series can have 1..N DrawingProviders which provides a specific function of drawing, such as lines, point-markers, candlesticks etc... These must be set in the constructor of the series before it can be drawn</para> + <para>This class provides methods such as <see cref="M:SciChart.Charting.Visuals.RenderableSeries.DrawingProviders.ISeriesDrawingProvider.OnDraw(SciChart.Drawing.Common.IRenderContext2D,SciChart.Charting.Visuals.RenderableSeries.IRenderPassData)" /> which performs the drawing of the series onto the viewport</para> + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.RenderContextExtensions.GetStyledPen(SciChart.Drawing.Common.IRenderContext2D,System.Windows.Shapes.Line,System.Boolean)"> + <summary> + Takes a <see cref="T:System.Windows.Shapes.Line" /> with a <see cref="T:System.Windows.Style" /> applied, and returns a SciChart compatible <see cref="T:SciChart.Drawing.Common.IPen2D" /> which can be used with the <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> for drawing lines + </summary> + <param name="renderContext">The render context.</param> + <param name="styledLine">The styled line.</param> + <param name="isAntiAliased">if set to <c>true</c> [is anti aliased].</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.SciChart2DInitializer"> + <summary> + <para> + Applies a runtime license key and initialize 2D native libraries asynchronously. + Do not create an instance of a SciChartSurface until the Task has returned and completed. + If the task faults, inspect the result and contact tech support. + </para> + <para> + If you want to load libraries and license for both 2D & 3D charts, then use the related class SciChart2D3DInitializer instead + </para> + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChart2DInitializer.Awaiter"> + <summary> + Gets the initialization task so that you can check for completion before instantiating SciChartSurfaces + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChart2DInitializer.LoadLibrariesAndLicenseAsync(System.String,System.String)"> + <summary> + <para> + Applies a runtime license key and initialize 2D native libraries asynchronously. + Do not create an instance of a SciChartSurface until the Task has returned and completed. + If the task faults, inspect the result and contact tech support. + </para> + <para> + If you want to load libraries and license for both 2D & 3D charts, then use the related class SciChart2D3DInitializer instead + </para> + </summary> + <example> + <code> + try + { + // call SciChart2DInitializer.LoadLibrariesAndLicenseAsync once before creating a SciChartSurface + // and await the result. Do not instantiate a SciChartSurface until it returns successfully + + // optionalTempDir allows you to pass in an optional temporary directory for native library loading + await SciChart2DInitializer.LoadLibrariesAndLicenseAsync("your-runtime-license-key", optionalTempDir); + + var sciChartSurface = new SciChartSurface(); + // ... use SciChartSurface + } + catch ( Exception caught ) + { + // TODO: Log the exception or report to tech support + throw; + } + </code> + </example> + <param name="runtimeLicenseKey">The license key string, or null = don't set license (just initialize libraries)</param> + <param name="tempFilesDirectory">A temporary directory used to write native dependencies before loading or null = default. Make sure your application has write permission to this directory and AntiVirus is not blocking access to this directory.</param> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartDonutSurface"> + <summary> + Provides pie chart surface. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartDonutSurface.HoleRadiusPercentProperty"> + <summary> + Defines the HoleRadiusPercentProperty DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartDonutSurface.HoleRadiusPercent"> + <summary> + Gets or sets a value that defines the radius of the hole in the center of a <see cref="T:SciChart.Charting.Visuals.SciChartDonutSurface" />. + It is given as a fraction of full radius of a chart. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartDonutSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartDonutSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartDonutSurface.ShowSelectedSegment(System.Windows.Shapes.Shape)"> + <summary> + Redraws a segment. + </summary> + <param name="segment">Segment</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartDonutSurface.DrawInfosInternal(SciChart.Charting.Visuals.Shapes.PieSegment,SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet)"> + <summary> + Draws labels for a segment. + </summary> + <param name="segment">Chart segment</param> + <param name="segmSet">Segment Set</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartDonutSurface.DrawSegments(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.IPieSegmentViewModel})"> + <summary> + Draws all the segments passed in. + </summary> + <param name="gaugeSegments">Segments models</param> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartExceptionEventArgs"> + <summary> + EventArgs used to convey exceptions from the SciChart Rendere t + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartLegend"> + <summary> + Provides a Legend control to display series color and name + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartLegend.LegendDataProperty"> + <summary> + Defines the LegendData Dependency property + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartLegend.ShowVisibilityCheckboxesProperty"> + <summary> + Defines the ShowVisibilityCheckboxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartLegend.ShowSeriesMarkersProperty"> + <summary> + Defines the ShowPointMarkers DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartLegend.OrientationProperty"> + <summary> + Defines the Orientation DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartLegend.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartLegend.LegendData"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Model.ChartData.ChartDataObject" /> which provides SeriesInfo property + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartLegend.ShowVisibilityCheckboxes"> + <summary> + Gets or sets whether a column of checkboxes bound to the Visibility of series is shown + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartLegend.ShowSeriesMarkers"> + <summary> + Gets or sets the value indicating whether to show series markers defined by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.LegendMarkerTemplate" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartLegend.Orientation"> + <summary> + Gets or sets the value, which determines the orientation of legend items layout + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartOverview"> + <summary> + A slider that provides the a range + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.StrokeProperty"> + <summary> + Provides the Stroke for IRenderableSeries + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.FillProperty"> + <summary> + Provides the Fill for FastMountainRenderableSeries + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.DataSeriesProperty"> + <summary> + Provides the DataSeriesIndex for IRenderableSeries + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.ParentSurfaceProperty"> + <summary> + Provides the ParentSurface which this overview control is associated with + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.XAxisIdProperty"> + <summary> + Defines the XAxisId DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.SelectedRangeProperty"> + <summary> + Selected range of the range slider + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.AxisProperty"> + <summary> + Defines the Axis DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartOverview.ScrollbarStyleProperty"> + <summary> + Defines the ScrollbarStyle + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartOverview.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.BackgroundChartSurface"> + <summary> + Returns the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance that this Overview control hosts. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.RenderableSeriesStyle"> + <summary> + Gets or sets the renderable series style to apply to the RenderableSeries behind the SciChartOverview + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.RenderableSeriesType"> + <summary> + Gets or sets the type of the renderable series to display behind the SciChartOverview + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <value>The color of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.Fill"> + <summary> + Gets or sets the Area Brush for the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.FastMountainRenderableSeries" />. The mountain chart outline is specified by <see cref="P:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries.Stroke" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.DataSeries"> + <summary> + Gets or sets the DataSeries used to draw the background chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.XAxisId"> + <summary> + Gets or sets which XAxis to bind the SciChartOverview to, matching by string Id + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.ParentSurface"> + <summary> + Gets or sets the ParentSurface which this overview control is bound to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.SelectedRange"> + <summary> + Selected range of the range slider + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.Axis"> + <summary> + Gets current axis which this control is bound to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartOverview.ScrollbarStyle"> + <summary> + Get or sets style for scrollbar which is used by this overview control + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartOverview.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartOverview.OnApplyTemplate"> + <summary> + Overide to get the visuals from the control template + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartPieSurface"> + <summary> + Provides donut chart surface. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartPieSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurface.DrawInfoSegment(SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet)"> + <summary> + Draws labels for a segment. + </summary> + <param name="segmentSet">Segment set</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurface.ShowSelectedSegment(System.Windows.Shapes.Shape)"> + <summary> + Redraws a segment. + </summary> + <param name="segment">Segment</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurface.DrawInfosInternal(SciChart.Charting.Visuals.Shapes.PieSegment,SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet)"> + <summary> + Draws labels for a segment. + </summary> + <param name="segment">Chart segment</param> + <param name="segmSet">Segment Set</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurface.DrawSegments(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.IPieSegmentViewModel})"> + <summary> + Draws all the segments passed in. + </summary> + <param name="gaugeSegments">Segments models</param> + </member> + <member name="T:SciChart.Charting.Visuals.IPieSegmentViewModel"> + <summary> + Defines the base interface to a <see cref="T:SciChart.Charting.Visuals.PieSegmentItem" /> which provides a data-source for a <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IPieSegmentViewModel.Value"> + <summary> + The data value of the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IPieSegmentViewModel.Name"> + <summary> + The name of the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. It will represent the segment in the <see cref="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartLegend" />, appear in tooltips, etc. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IPieSegmentViewModel.Fill"> + <summary> + The <see cref="T:System.Windows.Media.Brush" /> used to fill the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.IPieSegmentViewModel.Percentage"> + <summary> + The value which is drawn on the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. The InsideLabel is bound to this property by default. + </summary> + <remarks>If not set, this value will be calculated automatically.</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.IPieSegmentViewModel.IsSelected"> + <summary> + The value indicating whether the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" /> is selected. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.PieSegmentItem"> + <summary> + Defines a data-source for a <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PieSegmentItem.Value"> + <summary> + The data value of the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PieSegmentItem.Name"> + <summary> + The name of the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. It will represent the segment in the <see cref="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartLegend" />, appear in tooltips, etc. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PieSegmentItem.Fill"> + <summary> + The <see cref="T:System.Windows.Media.Brush" /> used to fill the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.PieSegmentItem.Percentage"> + <summary> + The value which is drawn on the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. The InsideLabel is bound to this property by default. + </summary> + <remarks>If not set, this value will be calculated automatically.</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.PieSegmentItem.IsSelected"> + <summary> + The value indicating whether the current <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" /> is selected. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Quadrant"> + <summary> + Defines a quadrant of a circular area. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Quadrant.TopRight"> + <summary> + The top right quadrant. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Quadrant.BottomRight"> + <summary> + The bottom right quadrant. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Quadrant.BottomLeft"> + <summary> + The bottom left quadrant. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Quadrant.TopLeft"> + <summary> + The top left quadrant. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartPieSurfaceBase"> + <summary> + Defines the abstract base class for <see cref="T:SciChart.Charting.Visuals.SciChartPieSurface" /> and <see cref="T:SciChart.Charting.Visuals.SciChartDonutSurface" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet"> + <summary> + Holds information about one <see cref="T:SciChart.Charting.Visuals.Shapes.PieSegment" />. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartTitleProperty"> + <summary> + Defines the ChartTitle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.BrushesCollectionProperty"> + <summary> + Defines the BrushesCollection DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ItemTemplateProperty"> + <summary> + Defines the ItemTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.LegendItemTemplateProperty"> + <summary> + Defines the LegendItemTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentTooltipTemplateProperty"> + <summary> + Defines the SegmentTooltipTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ItemsSourceProperty"> + <summary> + Defines the ItemsSource DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentTooltipContainerStyleProperty"> + <summary> + Defines the SegmentTooltipContainerStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.AllowMultiSelectProperty"> + <summary> + Defines the AllowMultiSelect DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.AllowClickSelectionProperty"> + <summary> + Defines the AllowMultiSelect DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowTooltipProperty"> + <summary> + Defines the ShowTooltip DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowLegendProperty"> + <summary> + Defines the ShowLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.LegendListStyleProperty"> + <summary> + Defines the LegendListStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.InfoLinesStyleProperty"> + <summary> + Defines the InfoLinesStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.InsideLabelTemplateProperty"> + <summary> + Defines the InsideLabelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.OutsideLabelTemplateProperty"> + <summary> + Defines the OutsideLabelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.StartSegmentAnimationDurationProperty"> + <summary> + Defines the StartSegmentAnimationDuration DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.StartInfoLabelsAnimationDurationProperty"> + <summary> + Defines the StartInfoLabelsAnimationDuration DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowOutsideLabelProperty"> + <summary> + Defines the ShowOutsideLabel DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowInsideLabelProperty"> + <summary> + Defines the ShowInsideLabel DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSpacingProperty"> + <summary> + Defines the SegmentSpacing DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentOuterSpacingProperty"> + <summary> + Defines the SegmentOuterSpacing DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SelectionOffsetProperty"> + <summary> + Defines the SelectionOffset DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartPieSurfaceBase.LegendPlacementProperty"> + <summary> + Defines the LegendPlacement DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SelectionOffset"> + <summary> + Gets or sets the value which specifies the offset of selected segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSpacing"> + <summary> + Gets or sets the value that specifies the spacing between segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentOuterSpacing"> + <summary> + Gets or sets the value that specifies the outer spacing for segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowInsideLabel"> + <summary> + Gets or sets the value indicating whether to show labels inside segments or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.StartSegmentAnimationDuration"> + <summary> + Gets or sets the duration of animation on a chart that occurs on loading. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowOutsideLabel"> + <summary> + Gets or sets value indicating whether to show outside labels for segments or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.StartInfoLabelsAnimationDuration"> + <summary> + Gets or sets the duration of animation of chart labels that occurs on loading. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SelectedSegments"> + <summary> + Gets a collection of selected segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.InsideLabelTemplate"> + <summary> + Gets or sets a template for inside labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.OutsideLabelTemplate"> + <summary> + Gets or sets a template for outside labels. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.InfoLinesStyle"> + <summary> + Gets or sets a style for the information lines. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.LegendListStyle"> + <summary> + Gets or sets a style for the <see cref="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartLegend" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowTooltip"> + <summary> + Gets or sets a value indicating whether to show a tooltip or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowLegend"> + <summary> + Gets or sets a value indicating whether to show the chart legend or not. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.AllowMultiSelect"> + <summary> + Gets or sets a value indicating whether it is allowed to have multiple selected segments simultaneously. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.AllowClickSelection"> + <summary> + Gets or sets a value indicating whether it is possible to select chart segments by mouse clicks. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.CachedSegmentsSets"> + <summary> + Stores a list of cached segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentsModelsCollection"> + <summary> + Gets or sets segments models collection for the <see cref="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartLegend" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ValuesSum"> + <summary> + Gets the sum of all <see cref="P:SciChart.Charting.Visuals.IPieSegmentViewModel.Value" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSurface"> + <summary> + Gets the segments surface. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartLegend"> + <summary> + Returns the instance of a Legend control. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartTitle"> + <summary> + Gets or sets an optional Chart Title, displayed above the chart surface. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentTooltipContainerStyle"> + <summary> + Gets or sets the container style for a tooltip. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.BrushesCollection"> + <summary> + Gets or sets the brushes collection which is used to paint chart segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ItemTemplate"> + <summary> + Gets or sets a template for chart segments. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentTooltipTemplate"> + <summary> + Gets or sets a template for tooltips. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.LegendItemTemplate"> + <summary> + Gets or sets an item template for <see cref="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ChartLegend" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ItemsSource"> + <summary> + Gets or sets the data source for a chart. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetInfoYCoord(SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet,System.Double,System.Boolean,System.Boolean,System.Boolean,System.Boolean)"> + <summary> + Calculates the Y coordinate for outside segment labels. + </summary> + <param name="segmentModel">Segment info.</param> + <param name="infoYCoord">the Y coordinate.</param> + <param name="southArcPart">Specifies segment location.</param> + <param name="eastArcPart">Specifies segment location.</param> + <param name="northArcPart">Specifies segment location.</param> + <param name="westArcPart">Specifies segment location.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetQuadrant(System.Double)"> + <summary> + Returns the proper quadrant for an angle. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.CreateLabel(System.Windows.DataTemplate,SciChart.Charting.Visuals.IPieSegmentViewModel)"> + <summary> + Creates a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.PieLabelControl" /> out of a template. + </summary> + <param name="labelTemplate">Label template</param> + <param name="model">Segment view model</param> + <returns>Label control</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.RemoveSegments"> + <summary> + Removes all segments and labels from the <see cref="P:SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.OnSegmentMouseLeave(System.Object,System.Windows.Input.MouseEventArgs)"> + <summary> + Called when the mouse cursor leaves a segment. + </summary> + <param name="sender">Segment</param> + <param name="mouseEventArgs">Arguments detailing the mouse leave operation</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.OnSegmentMouseMove(System.Object,System.Windows.Input.MouseEventArgs)"> + <summary> + Called when a mouse move occurs on a segment. + </summary> + <param name="sender">Segment</param> + <param name="mouseEventArgs">Arguments detailing the mouse leave operation</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.OnSegmentMouseDown(System.Object,System.Windows.Input.MouseButtonEventArgs)"> + <summary> + Called when a mouse button is pressed on the segment. + </summary> + <param name="sender">Segment</param> + <param name="mouseButtonEventArgs">Arguments detailing the mouse leave operation</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.CalcSegmentCoord(System.Double,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Calculate screen coordinate from the center of the bound of segment. + </summary> + <param name="segmentCenterAngle">Angle center of segment bound</param> + <param name="radius">Segment radius</param> + <param name="xOffset">Segment x coord offset</param> + <param name="yOffset">Segment y coord offset</param> + <param name="offsetRadius">Point offset radius(default radius of segmnet)</param> + <returns>Screen coordinate from the center of the bound of segment</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.IsCoordInSegment(System.Windows.Point,SciChart.Charting.Visuals.Shapes.PieSegment)"> + <summary> + Checks whether a screen point is in a segment. + </summary> + <param name="screenPoint">Screen mouse coordinate</param> + <param name="segment">Segment</param> + <returns>If the screen point is in segment</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetSegmentBrush(SciChart.Charting.Visuals.IPieSegmentViewModel,System.Int32)"> + <summary> + Returns a proper brush for a segment. + </summary> + <param name="pieModel">View model</param> + <param name="index">View model index</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.AnimateInfoPart(System.Windows.Media.Animation.Storyboard,System.Double,System.Double,System.Double,System.Windows.PropertyPath)"> + <summary> + Sets up an animation for a segment and its labels. + </summary> + <param name="storyboard">storyboard</param> + <param name="from">Animation from</param> + <param name="to">Animation to</param> + <param name="milliseconds">Animation duration</param> + <param name="propertyPath">PropertyPath</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetItemFromTemplate(SciChart.Charting.Visuals.IPieSegmentViewModel)"> + <summary> + Creates a segment from a template. + </summary> + <param name="pieSegmentViewModel">Gauge model</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.InvalidateElement"> + <summary> + Requests that the element redraws itself plus children. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ExportToBitmapSource"> + <summary> + Exports SiChartPieSurface into BitmapSource. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ExportToBitmapSource(System.Boolean,System.Nullable{System.Windows.Size})"> + <summary> + Exports to bitmap source. + </summary> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output. When null, outputs at the current size. When a size is specified, the chart is cloned in memory and exported at the new size</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ExportToFile(System.String,SciChart.Core.ExportType,System.Boolean,System.Windows.Size)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartPieSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ExportToFile(System.String,SciChart.Core.ExportType,System.Boolean)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartPieSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.IsValidToDraw"> + <summary> + Validating before drawing. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.IsNorthAngleSide(System.Double)"> + <summary> + Checks whether a segment with this angle is facing north. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.IsEastAngleSide(System.Double)"> + <summary> + Checks whether a segment with this angle is facing east. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.IsSouthAngleSide(System.Double)"> + <summary> + Checks whether a segment with this angle is facing south. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.IsWestAngleSide(System.Double)"> + <summary> + Checks whether a segment with this angle is facing west. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetCashedBrushesCollection"> + <summary> + Returns a collection of cached brushes. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowSelectedSegment(System.Windows.Shapes.Shape)"> + <summary> + Redraws a segment. + </summary> + <param name="segment">Segment</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.DrawSegments(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.IPieSegmentViewModel})"> + <summary> + Draws all the segments passed in. + </summary> + <param name="gaugeSegments">Segments models</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.DrawInfoSegment(SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet)"> + <summary> + Draws labels for a segment. + </summary> + <param name="segmentSet"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.DrawInfosInternal(SciChart.Charting.Visuals.Shapes.PieSegment,SciChart.Charting.Visuals.SciChartPieSurfaceBase.SegmentSet)"> + <summary> + Draws labels for a segment. + </summary> + <param name="segment">Chart segment</param> + <param name="segmSet">Segment Set</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.ShowTooltipInternal(System.Windows.Shapes.Shape,System.Windows.Point)"> + <summary> + Shows a tooltip over a segment. + </summary> + <param name="shape">Segment</param> + <param name="coords">Mouse point coordinates</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.CalcCartesionCoordinate(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Transforms from polar coordinates to cartesian coordinates. + </summary> + <param name="angle">Angle</param> + <param name="radius">Circle radius</param> + <param name="xOffset">X coord offset</param> + <param name="yOffset">Y coord offset</param> + <returns>Position on segments surface</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetValuesSum(System.Collections.Generic.IEnumerable{SciChart.Charting.Visuals.IPieSegmentViewModel})"> + <summary> + Returns the accumulated value of <see cref="P:SciChart.Charting.Visuals.IPieSegmentViewModel.Value" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartPieSurfaceBase.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="T:SciChart.Charting.Visuals.ISciChartRadarSurface"> + <summary> + Common base interface for <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> derived classes. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.RenderableSeries"> + <summary> + Gets the collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> that this <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> draws. + </summary> + <remarks>A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> is bound to a collection of <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> derived types.</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.SelectedRenderableSeries"> + <summary></summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.RootGrid"> + <summary> + Gets the Root Grid that hosts the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurface" /> and <see cref="P:SciChart.Charting.Visuals.SciChartRadarSurface.RadarAxes" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.RadarAxes"> + <summary> + Gets the collection of Radar Axes (Categories), that a Radar Chart measures against. + See <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.AutoAxisLength"> + <summary> + Gets or sets a value indicating whether to calculate length of every <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> automatically or use their preset <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisLength" /> values. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.AutoAxisAngle"> + <summary> + Gets or sets a value indicating whether to place Radar Axes automatically or according to their <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" /> values. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.AxisAngleOffset"> + <summary> + Gets or sets an angle offset which is considered the angle origin for every <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" />. + Every <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> will be placed according to its <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" /> in the clockwise direction, starting at this angle. + If <see cref="P:SciChart.Charting.Visuals.ISciChartRadarSurface.AutoAxisLength" /> is set to True, the axes will be placed automatically and their <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" /> values will be ignored. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.DrawSeriesAboveAxis"> + <summary> + Gets or sets whether the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartRadarSurface.CentralAxisOffset"> + <summary> + Gets or sets a value specifying the origin of every axis from the <see cref="P:SciChart.Charting.Visuals.ISciChartRadarSurface.RadarAxes" /> collection. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartRadarSurface"> + <summary> + Provides a high performance chart surface with a single <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> viewport + for rendering multiple <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> and multiple <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> instances, + with <see cref="T:SciChart.Charting.Model.DataSeries.IRadarPointViewModel" /> bindings and multiple <see cref="T:SciChart.Charting.ChartModifiers.RadarChartModifierBase" /> derived behaviour modifiers. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.AutoAxisLengthProperty"> + <summary> + Defines the AutoAxisLength DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.AutoAxisAngleProperty"> + <summary> + Defines the AutoAxisAngle DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.CentralAxisOffsetProperty"> + <summary> + Defines the CentralAxisOffset DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.AxisAngleOffsetProperty"> + <summary> + Defines the AxisAngleOffset DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.RenderableSeriesProperty"> + <summary> + Defines the RenderableSeries DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.RadarAxesProperty"> + <summary> + Defines the RadarAxes DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.ChartModifiersProperty"> + <summary> + Defines the ChartModifiers DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.SelectedRenderableSeriesProperty"> + <summary> + Defines the SelectedRenderableSeries DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartRadarSurface.DrawSeriesAboveAxisProperty"> + <summary> + Defines the DrawSeriesAboveAxis DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.SelectedRenderableSeries"> + <summary> + Gets or sets a collection of selected <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" />. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.DrawSeriesAboveAxis"> + <summary> + Gets or sets whether the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.AutoAxisLength"> + <summary> + Gets or sets a value indicating whether to calculate length of every <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> automatically or use their preset <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisLength" /> values. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.AutoAxisAngle"> + <summary> + Gets or sets a value indicating whether to place Radar Axes automatically or according to their <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" /> values. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.ChartModifiers"> + <summary> + Gets or sets a collection of <see cref="T:SciChart.Charting.ChartModifiers.IRadarChartModifier" />, which alter the behaviour of the chart. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.CentralAxisOffset"> + <summary> + Gets or sets a value specifying the origin of every axis from the <see cref="P:SciChart.Charting.Visuals.SciChartRadarSurface.RadarAxes" /> collection. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.RenderableSeries"> + <summary> + Gets or sets a collection of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRadarPolygonRenderableSeries" /> that are used to render data on this chart. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.AxisAngleOffset"> + <summary> + Gets or sets an angle offset which is considered the angle origin for every <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" />. + Every <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> will be placed according to its <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" /> in the clockwise direction, starting at this angle. + If <see cref="P:SciChart.Charting.Visuals.SciChartRadarSurface.AutoAxisLength" /> is set to True, the axes will be placed automatically and their <see cref="P:SciChart.Charting.Visuals.Axes.RadarAxis.AxisAngle" /> values will be ignored. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.AxisArea"> + <summary> + Gets a UI panel which holds all <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" /> from the <see cref="P:SciChart.Charting.Visuals.SciChartRadarSurface.RadarAxes" /> collection. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartRadarSurface.RadarAxes"> + <summary> + Gets the collection of Radar Axes (Categories), that a Radar Chart measures against. + See <see cref="T:SciChart.Charting.Visuals.Axes.RadarAxis" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call <see cref="M:System.Windows.Controls.Control.ApplyTemplate" />. + In simplest terms, this means the method is called just before a UI element displays in an application. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.DoDrawingLoop"> + <summary> + The inner drawing loop. Called once per frame. Do your drawing here. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.MeasureOverride(System.Windows.Size)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.RegisterServices(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Called in the constructor of <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />, gives derived classes the opportunity to register services per <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance + </summary> + <returns> + The populated <see cref="T:SciChart.Core.Utility.IServiceContainer" />. Must not return null. Return at least an empty <see cref="T:SciChart.Core.Utility.ServiceContainer" /></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.OnRenderSurfaceDependencyPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called with the <see cref="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceProperty" /> changes. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.PrepareSurfaceForExport(System.Double,System.Double)"> + <summary> + Prepares the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> for export to bitmap or file. + </summary> + <param name="width">The width of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + <param name="height">The height of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.CreateCloneOfSurfaceInMemory(System.Windows.Size)"> + <summary> + Creates a clone of the current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> in memory at the specified size. + + This is a pre-requisite of exporting to bitmap or XPS at a non-default size. + </summary> + <param name="newSize">The desired new size of the in-memory <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /></param> + <returns>The cloned <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance in memory</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.Print(System.String)"> + <summary> + Outputs current <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> to a printer. + </summary> + <param name="description">Description of printing job.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> from its XML representation. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartRadarSurface.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.SciChartRadarSurface" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartScrollbar"> + <summary> + A scrollbar which allows to scroll <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> content + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.AxisProperty"> + <summary> + Provides the Axis which this scrollbar control is associated with + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRangeProperty"> + <summary> + Selected range of the range slider + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRangePointProperty"> + <summary> + Defines the SelectedRangePoint DependencyProperty, used internally for animations + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.GripsThicknessProperty"> + <summary> + Defines the GripsThickness DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.GripsLengthProperty"> + <summary> + Defines the GripsLength DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.GripsStyleProperty"> + <summary> + Defines the GripsStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.ViewportStyleProperty"> + <summary> + Defines the ViewportStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.NonSelectedAreaStyleProperty"> + <summary> + Defines the NonSelectedArea DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.OrientationProperty"> + <summary> + Defines The Orientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.ZoomLimitProperty"> + <summary> + Defines the ZoomLimit DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.DataRangeProperty"> + <summary> + Defines the DataRange DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartScrollbar.IsAnimatedProperty"> + <summary> + Defines the IsAnimated DependencyProperty + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRangeChanged"> + <summary> + Raised when the <see cref="P:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRange" /> changes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.IsAnimated"> + <summary> + Gets or sets whether zoom operations should be animated. <value>True</value> by default. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.DataRange"> + <summary> + Gets or sets the data range + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRange"> + <summary> + Selected range of the horizontal range slider + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.Axis"> + <summary> + Gets or sets Axis which this scrollbar control is bound to + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.GripsThickness"> + <summary> + Gets or sets thickness of grips + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.GripsLength"> + <summary> + Gets or sets length of resizing grips + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.NonSelectedAreaStyle"> + <summary> + Gets or sets style for non selected area of scrollbar + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.ViewportStyle"> + <summary> + Gets or sets style for viewport area of scrollbar which contains <see cref="P:SciChart.Charting.Visuals.SciChartScrollbar.SelectedRange" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.GripsStyle"> + <summary> + Gets or sets style for grips + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.Orientation"> + <summary> + Get or set whether <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> is displayed horizontally or vertically + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartScrollbar.ZoomLimit"> + <summary> + Gets or sets minimal size of viewport in pixels + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.OnApplyTemplate"> + <summary> + Override to get the visuals from the control template + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.Scroll(System.Double)"> + <summary> + Scrolls the scrollbar by <paramref name="offset" /> pixels. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.Resize(System.Double,System.Double)"> + <summary> + Resizes the scrollbar in both directions by <paramref name="startOffset" />, <paramref name="endOffset" /> pixels. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.AnimateSelectedRangeTo(SciChart.Data.Model.IRange,System.TimeSpan)"> + <summary> + Animates the SelectedRange property from its current start position to the destination over the specified duration. + Use this to get a smooth animated effect from one position to the next + </summary> + <param name="to"></param> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartScrollbar.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.SciChartScrollbar" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartSurface"> + <summary> + Provides a high performance chart surface with a single <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> viewport + for rendering multiple <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />, multiple X and Y <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> instances, + with <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> bindings, multiple <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> derived behaviour modifiers and + multiple <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> UIElement Annotations + </summary> + <seealso cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> + <seealso cref="T:SciChart.Charting.Visuals.Annotations.AnnotationBase" /> + <seealso cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ClipUnderlayAnnotationsProperty"> + <summary> + Defines the ClipUnderlayAnnotations DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ClipOverlayAnnotationsProperty"> + <summary> + Defines the ClipOverlayAnnotations DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ZoomExtentsCommandProperty"> + <summary> + Defines the ZoomExtentsCommand DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.AnimateZoomExtentsCommandProperty"> + <summary> + Defines the ZoomExtentsCommand DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.XAxisProperty"> + <summary> + Defines the XAxis DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.YAxisProperty"> + <summary> + Defines the YAxis DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.YAxesProperty"> + <summary> + Defines the YAxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.XAxesProperty"> + <summary> + Defines the YAxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.AnnotationsProperty"> + <summary> + Defines the Annotations DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ChartModifierProperty"> + <summary> + Defines the ChartModifier DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.LeftAxesPanelTemplateProperty"> + <summary> + Defines the LeftAxisPanelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.RightAxesPanelTemplateProperty"> + <summary> + Defines the RightAxisPanelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.TopAxesPanelTemplateProperty"> + <summary> + Defines the RightAxisPanelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.BottomAxesPanelTemplateProperty"> + <summary> + Defines the RightAxisPanelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.CenterXAxesPanelTemplateProperty"> + <summary> + Defines the CenterXAxesPanelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.CenterYAxesPanelTemplateProperty"> + <summary> + Defines the CenterYAxesPanelTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.GridLinesPanelStyleProperty"> + <summary> + Defines the GridLinesPanelStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.RenderableSeriesProperty"> + <summary> + Defines the RenderableSeries DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.SelectedRenderableSeriesProperty"> + <summary> + Defines the SelectedRenderableSeries DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ViewportManagerProperty"> + <summary> + Defines the ViewportManager DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ZoomHistoryManagerProperty"> + <summary> + Defines the ZoomHistoryManager DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.SeriesSourceProperty"> + <summary> + Defines the SeriesSource DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.IsPolarChartProperty"> + <summary> + Defines the IsPolarChart DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurface.ZoomStateProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.ZoomState" /> DependencyProperty + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciChartSurface.AxisAlignmentChanged"> + <summary> + Event raised when alignment of any axis changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciChartSurface.XAxesCollectionNewCollectionAssigned"> + <summary> + Event raised when XAxes DependencyProperty is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciChartSurface.YAxesCollectionNewCollectionAssigned"> + <summary> + Event raised when YAxes DependencyProperty is changed + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciChartSurface.AnnotationsCollectionNewCollectionAssigned"> + <summary> + Event raised when Annotations DependencyProperty is changed + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ZoomState"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.ZoomState" /> of the SciChartSurface, e.g. if user is zooming, or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.LeftAxesPanelTemplate"> + <summary> + Gets or sets the template that defines the panel which controls the layout of left-aligned axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.RightAxesPanelTemplate"> + <summary> + Gets or sets the template that defines the panel which controls the layout of right-aligned axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.BottomAxesPanelTemplate"> + <summary> + Gets or sets the template that defines the panel which controls the layout of bottom-aligned axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.TopAxesPanelTemplate"> + <summary> + Gets or sets the template that defines the panel which controls the layout of top-aligned axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.CenterXAxesPanelTemplate"> + <summary> + Gets or sets the template that defines the panel which controls the layout of center X axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.CenterYAxesPanelTemplate"> + <summary> + Gets or sets the template that defines the panel which controls the layout of center Y axis + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ClipOverlayAnnotations"> + <summary> + Gets or sets whether annotations over the chart should clip to bounds or not. Default value is True + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ClipUnderlayAnnotations"> + <summary> + Gets or sets whether annotations under the chart should clip to bounds or not. Default value is true + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.RenderableSeries"> + <summary> + Gets the collection of RenderableSeries that this SciChartSurface draws. + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.SelectedRenderableSeries"> + <summary> + Gets the collection of RenderableSeries that are selected. + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ZoomExtentsCommand"> + <summary> + Gets or sets the zoom extents command, which when invoked, causes the SciChartSurface to zoom to extents + </summary> + <value>The zoom extents command.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AnimateZoomExtentsCommand"> + <summary> + Gets or sets the Animate zoom extents command, which when invoked, causes the SciChartSurface to zoom to extents using animation + </summary> + <value>The zoom extents command.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.XAxis"> + <summary> + Gets or sets the primary XAxis on the SciChartSurface (default side=Bottom) + </summary> + <value>The X axis.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.YAxis"> + <summary> + Gets or sets the primary YAxis on the SciChartSurface (default side=Right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.YAxes"> + <summary> + Gets the collection of Y-Axis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> that this SciChartSurface measures against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.XAxes"> + <summary> + Gets the collection of X-Axis <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> that this SciChartSurface measures against + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.Annotations"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.Annotations.AnnotationCollection" /> which provides renderable annotations over the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ViewportManager"> + <summary> + Gets or sets the ViewportManager instance on the chart, which handles behavior of the viewport on render + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ZoomHistoryManager"> + <summary> + Gets or sets the current ZoomHistoryManager, which is responsible for VisibleRange history for all axes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AnnotationOverlaySurface"> + <summary> + Gets the Annotation Canvas over the chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AnnotationUnderlaySurface"> + <summary> + Gets the Annotation Canvas under the chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AdornerLayerCanvas"> + <summary> + Gets the Adorner Layer over the chart + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.ChartModifier"> + <summary> + Gets or sets the current ChartModifier, which alters the behaviour of the chart + </summary> + <value>The chart modifier.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.GridLinesPanel"> + <summary> + Gets the GridLinesPanel where gridlines are drawn + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.GridLinesPanelStyle"> + <summary> + Gets or sets the GridLinesPanel style. + </summary> + <value>The grid lines panel style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.SeriesSource"> + <summary> + The SeriesSource property allows data-binding to a collection of <see cref="T:SciChart.Charting.Model.ChartSeries.IChartSeriesViewModel" /> instances, + for pairing of <see cref="T:SciChart.Charting.Model.DataSeries.DataSeries`2" /> with <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.IsPolarChart"> + <summary> + Gets whether this <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> is a polar chart or not + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call <see cref="M:System.Windows.Controls.Control.ApplyTemplate" />. In simplest terms, this means the method is called just before a UI element displays in an application. For more information, see Remarks. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnSciChartRendered"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.SciChartSurfaceBase.Rendered" /> event, fired at the end of a render pass immediately before presentation to the screen + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.NotifyAxes"> + <summary> + Notifies all Axis that data has changed, and the DataRange property must be recalculated. + </summary> + <remarks> + This is an expensive operation and should only be called when necessary. It is called once every time SciChartSurface is drawn. + </remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.Dispose(System.Boolean)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.MeasureOverride(System.Windows.Size)"> + <summary> + Called to remeasure a control. + </summary> + <param name="constraint">The maximum size that the method can return.</param> + <returns> + The size of the control, up to the maximum specified by <paramref name="constraint" />. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.ZoomExtents"> + <summary> + Zooms the chart to the extents of the data, plus any X or Y Grow By fraction set on the X and Y Axes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.AnimateZoomExtents(System.TimeSpan)"> + <summary> + Zooms to extents with the specified animation duration + </summary> + <param name="duration">The duration of animation when zooming to extents</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.ZoomExtentsY"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.AnimateZoomExtentsY(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.ZoomExtentsX"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.AnimateZoomExtentsX(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the X-Direction, using animation with the specified duration + </summary> + <param name="duration">The duration of the animation</param> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.VersionAndLicenseInfo"> + <summary> + Returns version and license info as a formatted string + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.VersionInfo"> + <summary> + Returns version info as a formatted string + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.SetRuntimeLicenseKey(System.String)"> + <summary> + Apply the runtime license key. NOTE: New classes now load license and initialize libraries async. See <seealso cref="M:SciChart.Charting.Visuals.SciChart2DInitializer.LoadLibrariesAndLicenseAsync(System.String,System.String)" /> for 2D Charts and SciChart2D3DInitializer.LoadLibrariesAndLicenseAsync(string,string) for 2D & 3D libraries + </summary> + <param name="key">The license key string</param> + <seealso cref="M:SciChart.Charting.Visuals.SciChart2DInitializer.LoadLibrariesAndLicenseAsync(System.String,System.String)" /> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.DoDrawingLoop"> + <summary> + The inner drawing loop. Called once per frame. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other hit-testable element + </summary> + <param name="point">The point.</param> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current HitTestable element + </summary> + <param name="point">The point to test</param> + <returns>true if the Point is within the bounds</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current HitTestable element relative to another HitTestable element + </summary> + <param name="relativeTo">The relative to.</param> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.AttachDataSeries(SciChart.Charting.Model.DataSeries.IDataSeries)"> + <summary> + Attaches listeners for DataSeries.DataSeriesChanged + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.DetachDataSeries(SciChart.Charting.Model.DataSeries.IDataSeries,SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries)"> + <summary> + Detaches listeners for DataSeries.DataSeriesChanged + </summary> + <param name="dataSeries"></param> + <param name="renderableSeries"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnSciChartSurfaceLoaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is loaded. Perform initialization operations here. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnSciChartSurfaceUnloaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is Unloaded and removed from the visual tree. Perform cleanup operations here + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnArrangeSciChart"> + <summary> + Preparations for a render pass, called internally, returns the viewport size + </summary> + <returns>The required Viewport Size</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.GetWindowedYRange(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Data.Model.IRange)"> + <summary> + Equivalent of calling YAxis.GetMaximumRange() however returns the max range only for that axis (by the data-series on it) + "windowed" = "displayed in current viewport" + uses GrowBy() + </summary> + <param name="yAxis"></param> + <param name="xRange"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnIsCenterAxisChanged(SciChart.Charting.Visuals.Axes.IAxis)"> + <summary> + Called internally by SciChart when <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.IsCenterAxis" /> changes. Allows the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to place the axis in the center of chart + </summary> + <param name="axis"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnAxisAlignmentChanged(SciChart.Charting.Visuals.Axes.IAxis,SciChart.Charting.Visuals.Axes.AxisAlignment)"> + <summary> + Called internally by SciChart when <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.AxisAlignment" /> changes. Allows the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to reposition the axis, args.g. at the top, left, bottom, right + </summary> + <param name="axis"></param> + <param name="oldValue"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.UnsubscribeInnerSeriesBaseCollections"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> unloaded. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnSciChartSurfaceSizeChanged"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> Size changes. Perform render surface resize or redraw operations here + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnDataContextChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> DataContext changes. + </summary> + <param name="e">The instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnChildStyleChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the RenderSurfaceStyle DependencyProperty changes. May be overridden in derived classes + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.OnRenderSurfaceDependencyPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called with the <see cref="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceProperty" /> changes. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.RegisterServices(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Called in the constructor of <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />, gives derived classes the opportunity to register services per <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance + </summary> + <returns> + The populated <see cref="T:SciChart.Core.Utility.IServiceContainer" />. Must not return null. Return at least an empty <see cref="T:SciChart.Core.Utility.ServiceContainer" /></returns> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AxisAreaBottom"> + <summary> + Gets the Bottom AxisArea, which contains the Axes which have <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignment" /> set to <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Bottom" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AxisAreaRight"> + <summary> + Gets the Right AxisArea, which contains the Axes which have <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignment" /> set to <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Right" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AxisAreaTop"> + <summary> + Gets the Top AxisArea, which contains the Axes which have <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignment" /> set to <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Top" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.AxisAreaLeft"> + <summary> + Gets the Left AxisArea, which contains the Axes which have <see cref="P:SciChart.Charting.Visuals.Axes.AxisBase.AxisAlignment" /> set to <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Left" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.CenterXAxisArea"> + <summary> + Gets the center AxisArea which contains XAxes with <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.IsCenterAxis" /> flag equals to true + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurface.CenterYAxisArea"> + <summary> + Gets the center AxisArea which contains YAxes with <see cref="P:SciChart.Charting.Visuals.Axes.IAxis.IsCenterAxis" /> flag equals to true + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.#ctor(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Internal Ctor used for tests + </summary> + <param name="mockServices"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.PrepareSurfaceForExport(System.Double,System.Double)"> + <summary> + Prepares the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> for export to bitmap or file + </summary> + <param name="width">The width of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + <param name="height">The height of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.CreateCloneOfSurfaceInMemory(System.Windows.Size)"> + <summary></summary> + <param name="newSize"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.Print(System.String)"> + <summary> + Outputs current <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to printer + </summary> + <param name="description">Description of printing job</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.GetSchema"> + <summary> + Returns an XmlSchema that describes the XML representation of the object that is produced by the WriteXml method and consumed by the ReadXml method + </summary> + <remarks> + This method is reserved by <see cref="T:System.Xml.Serialization.IXmlSerializable" /> and should not be used + </remarks> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.ReadXml(System.Xml.XmlReader)"> + <summary> + Generates <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> from its XML representation. + </summary> + <param name="reader"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurface.WriteXml(System.Xml.XmlWriter)"> + <summary> + Converts <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> into its XML representation. + </summary> + <param name="writer"></param> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartSurfaceBase"> + <summary> + An abstract base class containing shared code between different implementations of <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.ClipModifierSurfaceProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ClipModifierSurface" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitleProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitle" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitleStyleProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitleStyle" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurface" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceStyleProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceStyle" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.MaxFrameRateProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.MaxFrameRate" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.ShowLicensingWarningsProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ShowLicensingWarnings" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartSurfaceBase.EnableMultiThreadedRenderingProperty"> + <summary>Defines the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.EnableMultiThreadedRendering" /> DependencyProperty</summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciChartSurfaceBase.Rendered"> + <summary> + Event raised at the end of a single render pass + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.DebugWhyDoesntSciChartRender"> + <summary> + Gets or sets a flag whether SciChart should output rendering exceptions and 'Why Scichart Doesn't Render' reasons to the Debug Console. + Default is True. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.EnableMultiThreadedRendering"> + <summary> + Gets or sets a value indicating if SciChart can use Multi-Threaded rendering (where available). This will seek to use multiple cores to speed up the drawing process but will result in higher CPU usage. This is recommended if the bottleneck is drawing, but not recommended if the bottleneck is some other process e.g. simulation or computation + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.LicenseDaysRemaining"> + <summary> + Gets the number of license days remaining + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.MaxFrameRate"> + <summary> + Gets or sets the Maximum Framerate of this SciChartSurface in Hertz (Frames per Second). Default is 100.0 + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ShowLicensingWarnings"> + <summary> + When True, Licensing warnings such as missing Runtime Keys, or invalid license tokens, are displayed on the SciChart UI. Set this property to false to hide such warnings. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceStyle"> + <summary> + Gets or sets the RenderSurface style. + </summary> + <value>The render surface style.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" />, <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.SupportsXamlRenderSurface"> + <summary> + Returns True if the current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance supports the <see cref="!:XamlRenderSurface" /> for high quality vector rendering and export. By default this is True, but some chart types, e.g. 3D Charts, cannot support this output + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.IsDisposed"> + <summary> + True if the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> has been disposed. If so do not draw! + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.SyncRoot"> + <summary> + A synchronization object which is locked during a render pass. If you lock this SciChart will not render and will be blocked on the UI thread until the lock is released. + + This is used internally by DataSeries to lock the SciChartSurface when bulk updates are done. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitle"> + <summary> + Gets or sets an optional Chart Title, displayed above the chart surface + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitleStyle"> + <summary> + Gets or sets <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ChartTitle" /> style, which is displayed above the chart surface + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ClipModifierSurface"> + <summary> + Gets or sets a value whether to clip the ChartModifierSurface property to bounds. Fefault false + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface"> + <summary> + Gets the ModifierSurface, which is used to draw primitives for the Chart Modifiers + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderPriority"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting.Visuals.RenderPriority" />. The default is <see cref="F:SciChart.Charting.Visuals.RenderPriority.Normal" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurface"> + <summary> + Gets or sets the RenderSurface implementation that this <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> uses. Default implementation for a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + is a <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" />, however SciChart supports + additional render surfaces, providing high quality software and high speed hardware accelerated or 3D renderers. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartSurfaceBase.RootGrid"> + <summary> + Gets the Root Grid that hosts the SciChart RenderSurface, GridLinesPanel, X-Axis and Y-Axes (Left and right) + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnLoad"> + <summary> + Forces initialization of the SciChartSurface in the case it is being used to render off-screen (on server) + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnSciChartRendered"> + <summary> + Raises the <see cref="E:SciChart.Charting.Visuals.SciChartSurfaceBase.Rendered" /> event, fired at the end of a render pass immediately before presentation to the screen + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.SetMouseCursor(System.Windows.Input.Cursor)"> + <summary> + Sets a Cursor on the SciChartSurface + </summary> + <param name="cursor">The new Cursor</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnInvalidateSciChartSurface(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Calls InvalidateElement on the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />, should be used as the callback for Dependency Properties in <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> that should trigger a redraw + </summary> + <param name="d">The d.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnSciChartSurfaceUnloaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is Unloaded and removed from the visual tree. Perform cleanup operations here + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnSciChartSurfaceLoaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is loaded. Perform initialization operations here. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnSciChartSurfaceSizeChanged"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> Size changes. Perform render surface resize or redraw operations here + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnChildStyleChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the RenderSurfaceStyle DependencyProperty changes. May be overridden in derived classes + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnDataContextChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> DataContext changes. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.OnRenderSurfaceDependencyPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called with the <see cref="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceProperty" /> changes. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.RegisterServices(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Called in the constructor of <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />, gives derived classes the opportunity to register services per <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance + </summary> + <param name="serviceContainer">The service container instance.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.DoDrawingLoop"> + <summary> + The inner drawing loop. Called once per frame. Do your drawing here. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToBitmapSource"> + <summary> + Export snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to <see cref="T:System.Windows.Media.Imaging.BitmapSource" /></summary> + <returns>The bitmap of the current SciChartSurface</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToBitmapSource(System.Boolean,System.Nullable{System.Windows.Size})"> + <summary> + Exports to bitmap source. + </summary> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output. When null, outputs at the current size. When a size is specified, the chart is cloned in memory and exported at the new size</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToStream(SciChart.Core.ExportType,System.Boolean)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to Stream + </summary> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + <returns>The <see cref="T:System.IO.Stream" /> which contains the image of the chart</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToStream(SciChart.Core.ExportType,System.Boolean,System.Windows.Size)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to Stream + </summary> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + <param name="size">Defines size for export output</param> + <returns>The <see cref="T:System.IO.Stream" /> which contains the image of the chart</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToFile(System.String,SciChart.Core.ExportType,System.Boolean)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToFile(System.String,SciChart.Core.ExportType,System.Boolean,System.Windows.Size)"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ExportToFileInternal(System.String,SciChart.Core.ExportType,System.Boolean,System.Nullable{System.Windows.Size})"> + <summary> + Saves snapshot of current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> to file + </summary> + <param name="fileName">The Filename to save to</param> + <param name="exportType">Defines format of file to export</param> + <param name="useXamlRenderSurface">Defines better quality of export output by using the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> when exporting to file. NOTE: The <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> type is only available in the SDK and Enterprise editions of SciChart</param> + <param name="size">Defines size for export output</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.PrepareSurfaceForExport(System.Double,System.Double)"> + <summary> + Prepares the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> for export to bitmap or file + </summary> + <param name="width">The width of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + <param name="height">The height of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.GetScaleFactorXy(System.Windows.Size)"> + <summary> + Calculates the scale factor for cloned chart properties based on a required size. + </summary> + <param name="size"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.ScaleStrokeThicknessInLineStyle(System.Windows.Style,System.String,System.Double)"> + <summary> + Scales the StrokeThickness for Major\Minor Grid\Tick lines that were set in related styles of an axis. + </summary> + <param name="style"></param> + <param name="propertyName"></param> + <param name="scaleFactor"></param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartSurfaceBase.CreateCloneOfSurfaceInMemory(System.Windows.Size)"> + <summary> + Creates a clone of the current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> in memory at the specified size. + + This is a pre-requisite of exporting to bitmap or XPS at a non-default size. + </summary> + <param name="newSize">The desired new size of the in-memory <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /></param> + <returns>The cloned <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance in memory</returns> + </member> + <member name="T:SciChart.Charting.Visuals.ISciChartTernarySurface"> + <summary> + Common base interface for <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> derived classes + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartTernarySurface.XAxis"> + <summary> + Gets or sets the XAxis control on the SciChartTernarySurface + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartTernarySurface.YAxis"> + <summary> + Gets or sets the YAxis control on the SciChartTernarySurface (default side=Right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartTernarySurface.ZAxis"> + <summary> + Gets or sets the ZAxis control on the SciChartTernarySurface (default side=Left) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartTernarySurface.CoordinateCalculators"> + <summary> + Gets all of SciChartTernarySurface coordinate calculators + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartTernarySurface.RenderableSeries"> + <summary> + Gets the collection of RenderableSeries that this SciChartSurface draws. + </summary> + <remarks>A <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" /> is bound to an <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> derived type. + If a RenderableSeries.IsEnabled=false, then this series is skipped when evaluating the series to draw</remarks> + </member> + <member name="P:SciChart.Charting.Visuals.ISciChartTernarySurface.RootGrid"> + <summary> + Gets the Root Grid that hosts the SciChart RenderSurface, GridLinesPanel, X-Axis and Y-Axes (Left and right) + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciChartTernarySurface"> + <summary> + Provides a high performance chart surface with a single <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> viewport + for rendering multiple <see cref="T:SciChart.Charting.Visuals.RenderableSeries.ITernaryRenderableSeries" />, X, Y and Z <see cref="T:SciChart.Charting.Visuals.Axes.ITernaryAxis" /> instances, + with <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> bindings, multiple <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> derived behaviour modifiers + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartTernarySurface.ChartModifierProperty"> + <summary> + Defines the ChartModifier DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartTernarySurface.RenderableSeriesProperty"> + <summary> + Defines the RenderableSeries DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartTernarySurface.IsEquilateralProperty"> + <summary> + Defines the IsEquilateral DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartTernarySurface.XAxisStyleProperty"> + <summary> + Defines the XAxisStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartTernarySurface.YAxisStyleProperty"> + <summary> + Defines the YAxisStyle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.SciChartTernarySurface.ZAxisStyleProperty"> + <summary> + Defines the ZAxisStyle DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.SciChartTernarySurface" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.ChartModifier"> + <summary> + Gets or sets the current ChartModifier, which alters the behaviour of the chart + </summary> + <value>The chart modifier.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.XAxisStyle"> + <summary> + Gets or sets the primary XAxisStyle on the SciChartTernarySurface (default side=Bottom) + </summary> + <value>The X axis.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.YAxisStyle"> + <summary> + Gets or sets the primary YAxisStyle on the SciChartTernarySurface (default side=Left) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.ZAxisStyle"> + <summary> + Gets or sets the primary ZAxisStyle on the SciChartTernarySurface (default side=Right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.CoordinateCalculators"> + <summary> + Gets all of SciChartTernarySurface coordinate calculators + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.XAxis"> + <summary> + Gets or sets the XAxis control on the SciChartTernarySurface + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.YAxis"> + <summary> + Gets or sets the YAxis control on the SciChartTernarySurface (default side=Right) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.ZAxis"> + <summary> + Gets or sets the ZAxis control on the SciChartTernarySurface (default side=Left) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciChartTernarySurface.RenderableSeries"> + <summary> + Gets the collection of RenderableSeries that this SciChartSurface draws. + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.PrepareSurfaceForExport(System.Double,System.Double)"> + <summary> + Prepares the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> for export to bitmap or file + </summary> + <param name="width">The width of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + <param name="height">The height of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.RegisterServices(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Called in the constructor of <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />, gives derived classes the opportunity to register services per <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance + </summary> + <returns> + The populated <see cref="T:SciChart.Core.Utility.IServiceContainer" />. Must not return null. Return at least an empty <see cref="T:SciChart.Core.Utility.ServiceContainer" /></returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.OnArrangeSciChart"> + <summary> + Preparations for a render pass, called internally, returns the viewport size + </summary> + <returns>The required Viewport Size</returns> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.OnRenderSurfaceDependencyPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called with the <see cref="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceProperty" /> changes. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.DoDrawingLoop"> + <summary> + The inner drawing loop. Called once per frame. Do your drawing here. + </summary> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciChartTernarySurface.OnSciChartSurfaceLoaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is loaded. Perform initialization operations here. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.SciThumb"> + <summary> + Custom simple common Thumb implementation + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciThumb.SciDragDelta"> + <summary> + Occurs one or more times as the mouse changes position when a <see cref="T:SciChart.Charting.Visuals.SciThumb" /> control has mouse capture. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciThumb.SciDragStarted"> + <summary> + Occurs when dragging starts on a <see cref="T:SciChart.Charting.Visuals.SciThumb" /> control. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.SciThumb.SciDragEnded"> + <summary> + Occurs when dragging ends on a <see cref="T:SciChart.Charting.Visuals.SciThumb" /> control. + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.SciThumb.#ctor"> + <summary> + Default constructor initialize <see cref="T:SciChart.Charting.Visuals.SciThumb" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.SciThumb.IsDragging"> + <summary> + Gets a value indicating whether a <see cref="T:SciChart.Charting.Visuals.SciThumb" /> control is being dragged. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Shapes.DonutSegment"> + <summary> + Donut slice shape for <see cref="T:SciChart.Charting.Visuals.SciChartDonutSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.DonutSegment.InsideArcSizeProperty"> + <summary> + Defines the InsideArcSizeProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.DonutSegment.InsideRadiusProperty"> + <summary> + Defines the InsideRadiusProperty DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.DonutSegment.InsideRadius"> + <summary> + Get or set radius for bottom arc + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.DonutSegment.InsideArcSize"> + <summary> + Get or set size of the bottom arc + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Shapes.DonutSegment.DrawGeometry(System.Windows.Media.StreamGeometryContext)"> + <summary> + Draws the donut segment + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.Shapes.PieSegment"> + <summary> + Pie slice shape for <see cref="T:SciChart.Charting.Visuals.SciChartPieSurface" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.RadiusProperty"> + <summary> + Defines the RadiusProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.TextProperty"> + <summary> + Defines the TextProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.XOffsetProperty"> + <summary> + Defines the XOffsetProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.YOffsetProperty"> + <summary> + Defines the YOffsetProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentAngleProperty"> + <summary> + Defines the SegmentAngleProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.StartRotationAngleProperty"> + <summary> + Defines the StartRotationAngleProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.EndRotationAngleProperty"> + <summary> + Defines the EndRotationAngleProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentValueProperty"> + <summary> + Defines the SegmentValueProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.ArcSizeProperty"> + <summary> + Defines the ArcSizeProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentModelProperty"> + <summary> + Defines the SegmentModelProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.AnimateSegmentProperty"> + <summary> + Defines the AnimateSegmentProperty DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.Shapes.PieSegment.IsSelectedProperty"> + <summary> + Defines the IsSelectedProperty DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.IsDrawn"> + <summary> + Show if the segment was drawn + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Segment is associated with + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.IsSelected"> + <summary> + Get or set the selection segment + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.ArcSize"> + <summary> + Get or set size of the top arc + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentModel"> + <summary> + Get or set segment model + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.XOffset"> + <summary> + Get or set x coordinate offset + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.AnimateSegment"> + <summary> + Get or set text of segment model + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.Text"> + <summary> + Get or set text of segment model + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.YOffset"> + <summary> + Get or set y coordinate offset + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentAngle"> + <summary> + Get or set segment angle + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.StartRotationAngle"> + <summary> + Get or set start of the arc angle + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.EndRotationAngle"> + <summary> + Get or set end of the arc angle + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentValue"> + <summary> + Get or set segment value. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.SegmentCenterAngle"> + <summary> + Get the angle center of the pie segment + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.Radius"> + <summary> + Get or set the radius of the pie + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.Shapes.PieSegment.DefiningGeometry"> + <summary> + Gets a value that represents the <see cref="T:System.Windows.Media.Geometry" /> of the <see cref="T:System.Windows.Shapes.Shape" />. + </summary> + <returns> + The <see cref="T:System.Windows.Media.Geometry" /> of the <see cref="T:System.Windows.Shapes.Shape" />. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.Shapes.PieSegment.DrawGeometry(System.Windows.Media.StreamGeometryContext)"> + <summary> + Draws the pie segment + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.Shapes.PieSegment.CalcCartesionCoordinate(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Transform the polar coordinate to the cartesian coordinate. + </summary> + <param name="angle"></param> + <param name="radius"></param> + <param name="xOffset"></param> + <param name="yOffset"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.GroupPane"> + <summary> + An ItemContainer for panes in the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup" /> control + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.GroupPane.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.GroupPane.PaneElement"> + <summary> + Gets or sets the Pane UIElement + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.GroupPane.PaneViewModel"> + <summary> + Gets or sets the Pane ViewModel + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.GroupPane.IsMainPane"> + <summary> + Gets whether this is the main pane + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.GroupPane.IsTabbed"> + <summary> + Gets or sets whether this pane is tabbed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.GroupPane.ChangeOrientationCommand"> + <summary> + Gets or sets the change orientation command. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.GroupPane.ClosePaneCommand"> + <summary> + Gets or sets the close pane command. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.IChildPane"> + <summary> + The interface to a child pane in a <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup" /> control, which displays 1..Many <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> + controls in a vertical chart group. Intended specifically for stock charts. + + Derive from this interface when creating a ViewModel which will form the basis of a Child Pane in a multi-paned stock chart application + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.IChildPane.Title"> + <summary> + Gets or sets the Title of this Child Pane + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.IChildPane.ZoomExtents"> + <summary> + Causes the child pane to zoom to extents + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.IChildPane.ClosePaneCommand"> + <summary> + A command which when invoked, closes the child pane + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.IChildItemPane.Title"> + <summary> + Gets or sets the Title of this Child Pane + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.IChildItemPane.ZoomExtents"> + <summary> + Causes the child pane to zoom to extents + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.IChildItemPane.ClosePaneCommand"> + <summary> + A command which when invoked, closes the child pane + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.MultiPane.ChartPaneState"> + <summary> + Defines possible chart pane states within the main chart. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.MultiPane.ChartPaneState.Normal"> + <summary> + Normal state (visible but not maximized). + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.MultiPane.ChartPaneState.Minimized"> + <summary> + Minimized state. + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.MultiPane.ChartPaneState.Maximized"> + <summary> + Maximized state (the only visible pane within the main chart). + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane"> + <summary> + An ItemContainer for panes in the <see cref="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane" /> control + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane.PaneElement"> + <summary> + Gets or sets the Pane UIElement + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane.PaneViewModel"> + <summary> + Gets or sets the Pane ViewModel + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane.IsTabbed"> + <summary> + Gets or sets whether this pane is tabbed + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane.MinimizePaneCommand"> + <summary> + Gets or sets the change orientation command. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.ItemPane.ClosePaneCommand"> + <summary> + Gets or sets the close pane command. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane"> + <summary> + An ItemPane for the <see cref="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane" /> control. Wraps your custom UIElement (provided by <see cref="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane" /> ItemTemplate property) + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane.HeaderTemplateProperty"> + <summary> + The HeaderTemplate property + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane.Resizing"> + <summary> + Fired when the outline of a pane is dragged + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane.Resized"> + <summary> + Fired after a dragging of the outline of a pane is done + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane.HeaderTemplate"> + <summary> + Gets or sets the header template. + </summary> + <value> + The header template. + </value> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartItemPane.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane"> + <summary> + An ItemsControl which allows grouping of multiple <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instances to create a multi-paned chart. Used specifically by StockCharts but also applicable to other chart types + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane.HasTabbedItems"> + <summary> + Gets a value indicating whether there are any tabbed panes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane.OnItemsSourceChanged(System.Collections.IEnumerable,System.Collections.IEnumerable)"> + <summary> + Called when the <see cref="P:System.Windows.Controls.ItemsControl.ItemsSource" /> property changes. + </summary> + <param name="oldValue">Old value of the <see cref="P:System.Windows.Controls.ItemsControl.ItemsSource" /> property.</param> + <param name="newValue">New value of the <see cref="P:System.Windows.Controls.ItemsControl.ItemsSource" /> property.</param> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane.OnItemsChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Invoked when the <see cref="P:System.Windows.Controls.ItemsControl.Items" /> property changes. + </summary> + <param name="e">Information about the change.</param> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.MultiPane.SciChartMultiPane.PropertyChanged"> + <summary> + Occurs when a property changes. Part of the <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup"> + <summary> + An ItemsControl which allows grouping of multiple <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> instances to create a multi-paned chart. Used specifically by StockCharts but also applicable to other chart types + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciChartGroup.VerticalChartGroupProperty"> + <summary> + Defines the VerticalChartGroup DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciChartGroup.IsTabbedProperty"> + <summary> + Defines the IsTabbed DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciChartGroup.IsTabbed"> + <summary> + Gets or sets value, indicates whether panes are tabbed or not + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciChartGroup.HasTabbedItems"> + <summary> + Gets a value, indicates, whether container has tabbed panes + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.SetVerticalChartGroup(System.Windows.DependencyObject,System.String)"> + <summary> + Sets the vertical chart group dependency Property + </summary> + <param name="element">The element.</param> + <param name="syncWidthGroup">The named group</param> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.GetVerticalChartGroup(System.Windows.DependencyObject)"> + <summary> + Gets the vertical chart group depedency property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.IsItemItsOwnContainerOverride(System.Object)"> + <summary> + Determines if the specified @group is (or is eligible to be) its own container. + </summary> + <param name="item">The @group to check.</param> + <returns> + true if the @group is (or is eligible to be) its own container; otherwise, false. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.GetContainerForItemOverride"> + <summary> + Creates or identifies the element that is used to display the given @group. + </summary> + <returns> + The element that is used to display the given @group. + </returns> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.OnItemsSourceChanged(System.Collections.IEnumerable,System.Collections.IEnumerable)"> + <summary> + Called when the <see cref="P:System.Windows.Controls.ItemsControl.ItemsSource" /> property changes. + </summary> + <param name="oldValue">Old value of the <see cref="P:System.Windows.Controls.ItemsControl.ItemsSource" /> property.</param> + <param name="newValue">New value of the <see cref="P:System.Windows.Controls.ItemsControl.ItemsSource" /> property.</param> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.OnItemsChanged(System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Invoked when the <see cref="P:System.Windows.Controls.ItemsControl.Items" /> property changes. + </summary> + <param name="e">Information about the change.</param> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroup.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.SciChartGroup.PropertyChanged"> + <summary> + Occurs when a property changes. Part of the <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.HorizontalGroupHelper"> + <summary> + A HelperClass used to perform the functionality of <see cref="F:SciChart.Charting.Visuals.TradeChart.SciChartGroup.VerticalChartGroupProperty" /> but when the chart is rotated (e.g. YAxis <see cref="T:SciChart.Charting.Visuals.Axes.AxisAlignment" /> = <see cref="F:SciChart.Charting.Visuals.Axes.AxisAlignment.Top" /></summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.HorizontalGroupHelper.HorizontalChartGroupProperty"> + <summary> + Defines the HorizontalChartGroup DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.HorizontalGroupHelper.SetHorizontalChartGroup(System.Windows.DependencyObject,System.String)"> + <summary> + Sets the Horizontal chart group dependency Property + </summary> + <param name="element">The element.</param> + <param name="syncWidthGroup">The named group</param> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.HorizontalGroupHelper.GetHorizontalChartGroup(System.Windows.DependencyObject)"> + <summary> + Gets the Horizontal chart group depedency property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.SciStockChart"> + <summary> + Provides a high performance Stock Chart control surface with a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> viewport. + + Templated to inclue a <see cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> as XAxis and <see cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> as YAxis. + + The SciStockChart can have an <see cref="T:SciChart.Charting.Model.DataSeries.IDataSeries" /> data source for each <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeries" />, or use the new MVVM API (see the <see cref="P:SciChart.Charting.Visuals.SciChartSurface.SeriesSource" /> property) + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.XAxisStyleProperty"> + <summary>Defines the XAxisStyle DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.YAxisStyleProperty"> + <summary>Defines the YAxisStyle DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsCursorEnabledProperty"> + <summary>Defines the IsCursorEnabled DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsRolloverEnabledProperty"> + <summary>Defines the IsRolloverEnabled DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsPanEnabledProperty"> + <summary>Defines the IsPanEnabled DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsRubberBandZoomEnabledProperty"> + <summary>Defines the IsRubberBandZoomEnabled DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.BarTimeFrameProperty"> + <summary>Defines the BarTimeFrame DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsXAxisVisibleProperty"> + <summary>Defines the IsXAxisVisible DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.VerticalChartGroupIdProperty"> + <summary>Defines the VerticalChartGroupId DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsAxisMarkersEnabledProperty"> + <summary>Defines the IsAxisMarkersEnabled DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.LegendSourceProperty"> + <summary>Defines the LegendSource DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.DefaultDataProviderProperty"> + <summary>Defines the CurrentDataProvider DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.ShowLegendProperty"> + <summary> Defines the ShowLegend DependencyProperty </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciStockChart.LegendStyleProperty"> + <summary> Defines the LegendStyle DependencyProperty </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciStockChart.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciStockChart" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.DefaultDataProvider"> + <summary> + Gets or set modifier which provides data for legend + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.LegendSource"> + <summary> + Gets or sets data source for legend + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.ShowLegend"> + <summary> + Gets or sets whether need to display legend + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.LegendStyle"> + <summary> + Gets or sets style for <see cref="T:SciChart.Charting.ChartModifiers.LegendModifier" /></summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsAxisMarkersEnabled"> + <summary> + Gets or sets whether Axis Markers are to be displayed on the right YAxis, showing the series values + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.VerticalChartGroupId"> + <summary> + Gets or sets a proxy value for the SciChartGroup.VerticalChartGroup attached property and MouseManager.MouseEventGroup property, which is used to bind together the chart sizes and mouse events + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.XAxisStyle"> + <summary> + Gets or sets a Style allowing direct overriding of the built-in XAxis (TargetType must be CategoryDateTimeAxis) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.YAxisStyle"> + <summary> + Gets or sets a Style allowing direct overriding of the built-in XAxis (TargetType must be NumericAxis) + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsXAxisVisible"> + <summary> + Gets or sets a value indicating whether the X axis is visible. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsCursorEnabled"> + <summary> + Gets or sets whether the CursorModifier is enabled or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsRolloverEnabled"> + <summary> + Gets or sets whether the RolloverModifier is enabled or not + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsPanEnabled"> + <summary> + Gets or sets whether the Pan modifier is enabled + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.IsRubberBandZoomEnabled"> + <summary> + Gets or sets whether the RubberBandXyZoom is enabled + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciStockChart.BarTimeFrame"> + <summary> + Gets or sets the BarTimeFrame, this is the time in seconds for each bar on the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciStockChart" /></summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciStockChart.ZoomExtents"> + <summary> + Zooms the chart to the extents of the data, plus any X or Y Grow By fraction set on the X and Y Axes + </summary> + </member> + <member name="T:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane"> + <summary> + An GroupPane for the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup" /> control. Wraps your custom UIElement (provided by <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroup" /> ItemTemplate property) + </summary> + </member> + <member name="F:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane.HeaderTemplateProperty"> + <summary> + The header template property + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane.Resizing"> + <summary> + Fired when the outline of a pane is dragged + </summary> + </member> + <member name="E:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane.Resized"> + <summary> + Fired after a dragging of the outline of a pane is done + </summary> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane" /> class. + </summary> + </member> + <member name="P:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane.HeaderTemplate"> + <summary> + Gets or sets the header template. + </summary> + <value> + The header template. + </value> + </member> + <member name="M:SciChart.Charting.Visuals.TradeChart.SciChartGroupPane.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="T:SciChart.Charting.VisualXcceleratorEngine"> + <summary> + Defines properties to enable and configure The Visual Xccelerator Engine + </summary> + </member> + <member name="F:SciChart.Charting.VisualXcceleratorEngine.IsEnabledProperty"> + <summary> + Defines the TryApplyDirectXRenderer attached property + </summary> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.SetIsEnabled(SciChart.Charting.Visuals.SciChartSurface,System.Boolean)"> + <summary> + Sets the IsEnabled attached property. When true, tries to apply VisualXccelerator engine to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> for incredibly fast WPF charts + </summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> tries to apply DirectX rendering to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />.</param> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.GetIsEnabled(SciChart.Charting.Visuals.SciChartSurface)"> + <summary> + Gets the IsEnabled attached property value + </summary> + </member> + <member name="F:SciChart.Charting.VisualXcceleratorEngine.DowngradeWithoutExceptionProperty"> + <summary> + Defines the DowngradeWithoutException attached property + </summary> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.SetDowngradeWithoutException(SciChart.Charting.Visuals.SciChartSurface,System.Boolean)"> + <summary> + Sets the DowngradeWithoutException attached property. When true, the VisualXcceleratorEngine will automatically downgrade to a software renderer without exception, else, will report exceptions to the user + </summary> + <param name="element"></param> + <param name="value"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.GetDowngradeWithoutException(SciChart.Charting.Visuals.SciChartSurface)"> + <summary> + Gets the DowngradeWithoutException attached property + </summary> + <param name="element"></param> + <returns></returns> + </member> + <member name="F:SciChart.Charting.VisualXcceleratorEngine.FallbackTypeProperty"> + <summary> + Defines the FallbackType attached property + </summary> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.SetFallbackType(SciChart.Charting.Visuals.SciChartSurface,System.Type)"> + <summary> + Sets the FallbackType attached property. This is the type of <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> which is created if DirectX is not available + </summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> tries to apply DirectX rendering to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />.</param> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.GetFallbackType(SciChart.Charting.Visuals.SciChartSurface)"> + <summary> + Sets the FallbackType attached property value + </summary> + </member> + <member name="F:SciChart.Charting.VisualXcceleratorEngine.EnableImpossibleModeProperty"> + <summary> + Defines the EnableImpossibleMode attached property + </summary> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.SetEnableImpossibleMode(SciChart.Charting.Visuals.ISciChartSurface,System.Boolean)"> + <summary> + Sets the EnableImpossibleMode attached property value on the current SciChartSurface. When true, we enable a ridiculous performance improvement for real-time and big-data charts. Warning, this mode is experimental! + </summary> + <param name="element"></param> + <param name="value"></param> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.GetEnableImpossibleMode(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Gets the EnableImpossibleMode attached property value from the current series + </summary> + </member> + <member name="F:SciChart.Charting.VisualXcceleratorEngine.AvoidBlacklistedGpuProperty"> + <summary> + Defines the AvoidBlacklistedGpu attached property + </summary> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.SetAvoidBlacklistedGpu(SciChart.Charting.Visuals.ISciChartSurface,System.Boolean)"> + <summary> + Sets the AvoidBlacklistedGpu attached property value on the current SciChartSurface. + When true, the GPU's name is checked against the Blacklist of GPUs. + If found, the SciChart will switch to the fallback renderer. + Note, there are several reasons why a GPU could belong to the blacklist. + For example, low computation capabilities of the GPU could cause + Timeout Detection and Recovery of Graphics Adapter Drivers by the OS, + resulting in crashing the application. + </summary> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.GetAvoidBlacklistedGpu(SciChart.Charting.Visuals.ISciChartSurface)"> + <summary> + Gets the AvoidBlacklistedGpu attached property value from the current series + </summary> + </member> + <member name="P:SciChart.Charting.VisualXcceleratorEngine.SupportsHardwareAcceleration"> + <summary> + Returns <value>True</value> if GPU supports hardware acceleration (DirectX). + </summary> + </member> + <member name="P:SciChart.Charting.VisualXcceleratorEngine.HasDirectX10OrBetterCapableGpu"> + <summary> + Returns <value>True</value> if GPU supports DirectX 10 or higher. + </summary> + </member> + <member name="P:SciChart.Charting.VisualXcceleratorEngine.IsGpuBlacklisted"> + <summary> + Returns <value>True</value> if GPU is blacklisted. + Note, there are several reasons why a GPU could belong to the blacklist. + For example, low computation capabilities of the GPU could cause + Timeout Detection and Recovery of Graphics Adapter Drivers by the OS, + resulting in crashing the application. + </summary> + </member> + <member name="P:SciChart.Charting.VisualXcceleratorEngine.UseAlternativeFillSource"> + <summary> + When false (default), uses <see cref="T:System.Windows.Interop.D3DImage" /> for hardware accelerated texture sharing. + + When true, uses software method to FillSource (avoiding use of D3DImage). This can help compatibility on certain systems + and prevent flicker which is due to D3DImage itself. + </summary> + <example> + To enable compatibility mode for VisualXcceleratorEngine, set this property once, statically, in your application + <code> + void Foo() + { + VisualXcceleratorEngine.UseAlternativeFillSource = true; + } + </code></example> + </member> + <member name="P:SciChart.Charting.VisualXcceleratorEngine.EnableForceWaitForGPU"> + <summary> + When false (default), no waiting for gpu + when true , we force wait for the gpu to finish rendering before invalidating the final image or copying it + </summary> + <example> + To enable compatibility mode for VisualXcceleratorEngine, set this property once, statically, in your application + <code> + void Foo() + { + VisualXcceleratorEngine.EnableForceWaitForGPU = true; + } + </code></example> + </member> + <member name="M:SciChart.Charting.VisualXcceleratorEngine.AssertSupportsDirectX"> + <summary> + Asserts whether this PC supports DirectX + </summary> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting3D.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting3D.dll Binary files differnew file mode 100644 index 000000000..f4142418e --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting3D.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting3D.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting3D.xml new file mode 100644 index 000000000..daa338e5f --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Charting3D.xml @@ -0,0 +1,13485 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Charting3D</name> + </assembly> + <members> + <member name="T:SciChart.Charting3D.StringToVector3TypeConverter"> + <summary> + TypeConverter to allow conversion of a string value to <see cref="T:SciChart.Charting3D.Vector3" />. Used to allow succinct Markup syntax e.g. + + <SciChart3DSurface WorldDimensions="10, 20, 30"/> + </summary> + </member> + <member name="M:SciChart.Charting3D.StringToVector3TypeConverter.CanConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Type)"> + <summary> + Returns whether the type converter can convert an object from the specified type to the type of this converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="sourceType">The type you want to convert from.</param> + <returns> + true if this converter can perform the conversion; otherwise, false. + </returns> + </member> + <member name="M:SciChart.Charting3D.StringToVector3TypeConverter.ConvertFrom(System.ComponentModel.ITypeDescriptorContext,System.Globalization.CultureInfo,System.Object)"> + <summary> + Converts from the specified value to the intended conversion type of the converter. + </summary> + <param name="context">An object that provides a format context.</param> + <param name="culture">The <see cref="T:System.Globalization.CultureInfo" /> to use as the current culture.</param> + <param name="value">The value to convert to the type of this converter.</param> + <returns> + The converted value. + </returns> + <exception cref="T:System.FormatException">Unable to convert the string {0} into a DoubleRange. Please use the format '1.234,5.678'</exception> + </member> + <member name="M:SciChart.Charting3D.Common.Extensions.AxisBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Common.Extensions.SeriesBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.AxisBinding.Mode"> + <summary> + Update type + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.AxisBinding.UpdateSourceTrigger"> + <summary> + Binding mode + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.AxisBinding.RelativeSource"> + <summary> + Description of the object to use as the source, relative to the target element. + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.AxisBinding.Path"> + <summary> + Gets or sets the path to the collection of IRenderableSeriesViewModels + </summary> + </member> + <member name="M:SciChart.Charting3D.Common.Extensions.SeriesBinding.#ctor(System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Common.Extensions.SeriesBinding" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.SeriesBinding.Mode"> + <summary> + Update type + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.SeriesBinding.UpdateSourceTrigger"> + <summary> + Binding mode + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.SeriesBinding.RelativeSource"> + <summary> + Description of the object to use as the source, relative to the target element. + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.SeriesBinding.Path"> + <summary> + Gets or sets the path to the collection of IRenderableSeriesViewModels + </summary> + </member> + <member name="T:SciChart.Charting3D.Common.Extensions.TooltipTemplateSelector"> + <summary> + Provides class for choosing proper DataTemplate according to a <see cref="T:System.Type" /> of <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /></summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.TooltipTemplateSelector.XyzSeriesTooltipTemplate"> + <summary> + Data template used for renderable series with <see cref="T:SciChart.Charting3D.Model.IXyzDataSeries3D" /> type + </summary> + </member> + <member name="P:SciChart.Charting3D.Common.Extensions.TooltipTemplateSelector.UniformGridSeriesTooltipTemplate"> + <summary> + Data template used for renderable series with <see cref="!:IUniformGridDataSeries3D" /> type + </summary> + </member> + <member name="M:SciChart.Charting3D.Common.Extensions.TooltipTemplateSelector.SelectTemplate(System.Object,System.Windows.DependencyObject)"> + <summary> + Contains the logic for choosing a proper DataTemplate + </summary> + </member> + <member name="M:SciChart.Charting3D.Common.Helpers.ResourceHelper.GetLocationUri(System.String,System.Reflection.Assembly)"> + <summary> + The resource should be defined as 'Resource' not as 'Embedded resource'. + </summary> + <param name="resourcePath">The resource path</param> + <param name="assembly">If null, then use calling assembly to find the resource</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Common.Helpers.ResourceHelper.LoadResourceFromUri(System.Uri,System.Reflection.Assembly)"> + <summary> + Will load resource from any assembly that is part of the application. + It does not rely on Application which is specific to a (UI) frameowrk. + </summary> + <param name="uri"></param> + <param name="asm"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Common.Helpers.ResourceHelper.GetAssemblyResourceStream(System.Reflection.Assembly,System.String)"> + <summary> + The path separator is '/'. The path should not start with '/'. + </summary> + <param name="asm"></param> + <param name="path"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Vector3ComponentConverter"> + <summary> + A <see cref="T:System.Windows.Data.IValueConverter" /> which accepts a <see cref="T:SciChart.Charting3D.Vector3" /> then depending on ConverterParameter = 'X', 'Y', 'Z' returns the component for the vector + </summary> + </member> + <member name="M:SciChart.Charting3D.Vector3ComponentConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3ComponentConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotSupportedException"></exception> + </member> + <member name="T:SciChart.Charting3D.Vector3StringConverter"> + <summary> + A <see cref="T:System.Windows.Data.IValueConverter" /> which accepts a <see cref="T:SciChart.Charting3D.Vector3" /> then depending on <see cref="P:SciChart.Charting3D.Vector3StringConverter.StringFormat" /> formats the string + </summary> + </member> + <member name="M:SciChart.Charting3D.Vector3StringConverter.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Vector3StringConverter" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3StringConverter.StringFormat"> + <summary> + Gets or sets the string format. Default is 'n2' + </summary> + </member> + <member name="M:SciChart.Charting3D.Vector3StringConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value produced by the binding source.</param> + <param name="targetType">The type of the binding target property.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3StringConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Converts a value. + </summary> + <param name="value">The value that is produced by the binding target.</param> + <param name="targetType">The type to convert to.</param> + <param name="parameter">The converter parameter to use.</param> + <param name="culture">The culture to use in the converter.</param> + <returns> + A converted value. If the method returns null, the valid null value is used. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.Extensions.AxisDescriptorExtensions.ToSCRTAxisDescriptor(SciChart.Charting3D.Primitives.IAxisDescriptor,SciChart.Charting3D.Interop.SCRTAxisDescriptor)"> + <summary> + Wrapper func which converts a C# <see cref="T:SciChart.Charting3D.Primitives.IAxisDescriptor" /> to <see cref="T:SciChart.Charting3D.Interop.SCRTAxisDescriptor" /> which is passed over the wire to C++ layer + </summary> + </member> + <member name="T:SciChart.Charting3D.Extensions.ColorExtensions"> + <summary> + Extension methods to convert <see cref="T:System.Windows.Media.Color" /> to SciChart3D types + </summary> + </member> + <member name="M:SciChart.Charting3D.Extensions.ColorExtensions.ToTsrVector4(System.Windows.Media.Color,SciChart.Charting3D.Interop.TSRVector4)"> + <summary> + Converts a <see cref="T:System.Windows.Media.Color" /> to <see cref="T:SciChart.Charting3D.Interop.TSRVector4" /> which has A,R,G,B components ranging from 0.0 - 1.0 + </summary> + <param name="color"></param> + <param name="tsrColor"></param> + </member> + <member name="M:SciChart.Charting3D.Extensions.ColorExtensions.ToTsrVector4(System.Windows.Media.Color)"> + <summary> + Converts a <see cref="T:System.Windows.Media.Color" /> to <see cref="T:SciChart.Charting3D.Interop.TSRVector4" /> which has A,R,G,B components ranging from 0.0 - 1.0 + </summary> + <param name="color"></param> + </member> + <member name="M:SciChart.Charting3D.Extensions.ColorExtensions.ToArgb(System.Windows.Media.Color)"> + <summary> + Converts a <see cref="T:System.Windows.Media.Color" /> to uint returning all four color components A,R,G,B in a single 32-bit value + </summary> + <param name="color"></param> + </member> + <member name="M:SciChart.Charting3D.Extensions.ColorExtensions.ToAbgr(System.Windows.Media.Color)"> + <summary> + Converts a <see cref="T:System.Windows.Media.Color" /> to uint returning all four color components A,B,G,R in a single 32-bit value + </summary> + <param name="color"></param> + </member> + <member name="M:SciChart.Charting3D.Extensions.CoordinateCalculatorExtensions.ToSCRTCoordinateCalculatorBase(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Wrapper func which converts a C# <see cref="!:ICoordinateCalculator<double>" /> to newly created <see cref="T:SciChart.Charting3D.Interop.SCRTCoordinateCalculator" /></summary> + </member> + <member name="M:SciChart.Charting3D.Extensions.ListExtensions.ToVectorstr(System.Collections.Generic.IList{System.String},SciChart.Charting3D.Interop.Vectorstr)"> + <summary> + Wrapper func which converts a C# <see cref="T:System.Collections.Generic.IList`1" /> to <see cref="T:SciChart.Charting3D.Interop.Vectorstr" /> which is passed over the wire to C++ layer + </summary> + </member> + <member name="M:SciChart.Charting3D.Extensions.ListExtensions.ToVectorwstr(System.Collections.Generic.IList{System.String},SciChart.Charting3D.Interop.Vectorwstr)"> + <summary> + Wrapper func which converts a C# <see cref="T:System.Collections.Generic.IList`1" /> to <see cref="T:SciChart.Charting3D.Interop.Vectorstr" /> which is passed over the wire to C++ layer + </summary> + </member> + <member name="M:SciChart.Charting3D.Extensions.ListExtensions.ToVectorf(System.Collections.Generic.IList{System.Single},SciChart.Charting3D.Interop.Vectorf)"> + <summary> + Wrapper func which converts a C# <see cref="T:System.Collections.Generic.IList`1" /> to <see cref="T:SciChart.Charting3D.Interop.Vectorf" /> which is passed over the wire to C++ layer + </summary> + </member> + <member name="M:SciChart.Charting3D.Extensions.VectorExtensions.ToTsrVector3(SciChart.Charting3D.Vector3)"> + <summary> + Converts a <see cref="T:SciChart.Charting3D.Vector3" /> to <see cref="T:SciChart.Charting3D.Interop.TSRVector3" /></summary> + <param name="vector3"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Extensions.VectorExtensions.ToVector3(SciChart.Charting3D.Interop.TSRVector3)"> + <summary> + Converts a <see cref="T:SciChart.Charting3D.Interop.TSRVector3" /> to <see cref="T:SciChart.Charting3D.Vector3" /></summary> + <param name="tsrVector3"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.BoundingBox"> + <summary> + Defines a Bounding Box in 3D space + </summary> + </member> + <member name="F:SciChart.Charting3D.BoundingBox.Vec0"> + <summary> + One corner of the bounding box in 3D space + </summary> + </member> + <member name="F:SciChart.Charting3D.BoundingBox.Vec1"> + <summary> + Another corner of the bounding box in 3D space + </summary> + </member> + <member name="M:SciChart.Charting3D.BoundingBox.#ctor(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.BoundingBox" /> struct. + </summary> + <param name="vec0">The vec0.</param> + <param name="vec1">The vec1.</param> + </member> + <member name="P:SciChart.Charting3D.BoundingBox.Center"> + <summary> + Computes the center of the bounding box in 3D space + </summary> + </member> + <member name="P:SciChart.Charting3D.BoundingBox.Max"> + <summary> + Gets the Maximums of the bounding box, e.g. Max.X is the maximum X value in the bounding box + </summary> + </member> + <member name="P:SciChart.Charting3D.BoundingBox.Min"> + <summary> + Gets the Minimums of the bounding box, e.g. Min.X is the minimum X value in the bounding box + </summary> + </member> + <member name="P:SciChart.Charting3D.BoundingBox.Corners"> + <summary> + Computes a list of 8 corners of the Bounding box in 3D Space + </summary> + </member> + <member name="M:SciChart.Charting3D.BoundingBox.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting3D.BoundingBox.Equals(SciChart.Charting3D.BoundingBox)"> + <summary> + Equalses the specified other. + </summary> + <param name="other">The other.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.BoundingBox.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns> + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + </returns> + </member> + <member name="T:SciChart.Charting3D.Math3D"> + <summary> + Helper class to expose certain 3D math functions + </summary> + </member> + <member name="F:SciChart.Charting3D.Math3D.Epsilon"> + <summary> + Minimum precision for floating point values. + </summary> + </member> + <member name="F:SciChart.Charting3D.Math3D.Epsilond"> + <summary> + Minimum precision for double-precision values + </summary> + </member> + <member name="M:SciChart.Charting3D.Math3D.RotateAroundPoint(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3,System.Single,SciChart.Charting3D.Vector3)"> + <summary> + Rotates a vector <paramref name="pointToRotate" /> around an arbitrary origin a certain number of degrees, with an arbitrary rotation axis + </summary> + <param name="originPoint">The origin point.</param> + <param name="pointToRotate">The point to rotate.</param> + <param name="rotationAngleDegrees">The rotation angle degrees.</param> + <param name="rotationAxis">The rotation axis.</param> + <returns>The rotated point</returns> + </member> + <member name="M:SciChart.Charting3D.Math3D.DirectionToPitchAndYaw(SciChart.Charting3D.Vector3,System.Single@,System.Single@)"> + <summary> + Computation of Pitch and Yaw angles from forward vector + </summary> + <remarks>See original implementation here: http://www.jldoty.com/code/DirectX/YPRfromUF/YPRfromUF.html</remarks> + <param name="direction">The forward vector.</param> + <param name="pitch">The pitch.</param> + <param name="yaw">The yaw.</param> + </member> + <member name="M:SciChart.Charting3D.Math3D.PitchAndYawToDirection(System.Single,System.Single,SciChart.Charting3D.Vector3@)"> + <summary> + Computation of normalized direction vector from Target, Radius, Pitch and Yaw: http://stackoverflow.com/questions/10569659/camera-pitch-yaw-to-direction-vector + </summary> + <param name="pitch">The pitch in Degrees.</param> + <param name="yaw">The yaw in Degrees.</param> + <param name="direction">The computed direction.</param> + </member> + <member name="M:SciChart.Charting3D.Math3D.DegToRad(System.Single)"> + <summary>Converts Degrees to Radians with floating point accuracy.</summary> + </member> + <member name="M:SciChart.Charting3D.Math3D.RadToDeg(System.Single)"> + <summary>Converts Radians to Degrees with floating point accuracy.</summary> + </member> + <member name="M:SciChart.Charting3D.Math3D.DegToRad(System.Double)"> + <summary>Converts Degrees to Radians with double precision accuracy.</summary> + </member> + <member name="M:SciChart.Charting3D.Math3D.RadToDeg(System.Double)"> + <summary>Converts Radians to Degrees with double precision accuracy.</summary> + </member> + <member name="M:SciChart.Charting3D.Math3D.IsZero(System.Single)"> + <summary>Checks if a floating point value is close to zero.</summary> + </member> + <member name="M:SciChart.Charting3D.Math3D.IsZero(System.Double)"> + <summary>Checks if a floating point value is close to zero.</summary> + </member> + <member name="T:SciChart.Charting3D.Matrix4"> + <summary> + Defines a three-component Vector with <see cref="T:System.Single">32-bit floating point</see> precision + </summary> + </member> + <member name="M:SciChart.Charting3D.Matrix4.TransformCoordinate(SciChart.Charting3D.Vector3)"> + <summary> + Transform a coordinate. + </summary> + <param name="vector">Vector to transform.</param> + <returns>Transformed vector.</returns> + </member> + <member name="T:SciChart.Charting3D.Plane"> + <summary> + Plane data type declaration represents a plane in 3d and has various different functions. + </summary> + </member> + <member name="P:SciChart.Charting3D.Plane.NormalX"> + <summary> + X component of the plane normal. + </summary> + </member> + <member name="P:SciChart.Charting3D.Plane.NormalY"> + <summary> + Y component of the plane normal. + </summary> + </member> + <member name="P:SciChart.Charting3D.Plane.NormalZ"> + <summary> + Z component of the plane normal. + </summary> + </member> + <member name="P:SciChart.Charting3D.Plane.Distance"> + <summary> + Distance along the normal to the origin. + </summary> + </member> + <member name="M:SciChart.Charting3D.Plane.op_Equality(SciChart.Charting3D.Plane,SciChart.Charting3D.Plane)"> + <summary> + Implements the == equality operator + </summary> + <param name="a">The first plane.</param> + <param name="b">The second plane.</param> + <returns> + The result of the operator = a == b + </returns> + </member> + <member name="M:SciChart.Charting3D.Plane.op_Inequality(SciChart.Charting3D.Plane,SciChart.Charting3D.Plane)"> + <summary> + Implements the != negative equality operator + </summary> + <param name="a">The first plane.</param> + <param name="b">The second plane.</param> + <returns> + The result of the operator = a != b + </returns> + </member> + <member name="M:SciChart.Charting3D.Plane.Equals(SciChart.Charting3D.Plane)"> + <summary> + Implements the Equality operator + </summary> + <param name="other">The other.</param> + <returns>True, if equals</returns> + </member> + <member name="M:SciChart.Charting3D.Plane.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting3D.Plane.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns> + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + </returns> + </member> + <member name="M:SciChart.Charting3D.Plane.Assign(System.Single,System.Single,System.Single,System.Single)"> + <summary> + Assigns a value from passed arguments. + </summary> + <param name="normalX">X-component of plane normal</param> + <param name="normalY">Y-component of plane normal</param> + <param name="normalZ">Z-component of plane normal</param> + <param name="distance">Distance to plane from origin</param> + </member> + <member name="M:SciChart.Charting3D.Plane.Assign(SciChart.Charting3D.Plane)"> + <summary> + Assigns a value from passed plane. + </summary> + <param name="plane">Plane from which value applies.</param> + </member> + <member name="M:SciChart.Charting3D.Plane.Apply(SciChart.Charting3D.Plane)"> + <summary> + Applies a value to passed plane. + </summary> + <param name="plane">Plane to which value applies.</param> + </member> + <member name="T:SciChart.Charting3D.Vector3"> + <summary> + Defines a three-component Vector with <see cref="T:System.Single">32-bit floating point</see> precision + </summary> + </member> + <member name="M:SciChart.Charting3D.Vector3.#ctor(System.Single,System.Single,System.Single)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Vector3" /> struct. + </summary> + <param name="x">The x value.</param> + <param name="y">The y value.</param> + <param name="z">The z value.</param> + </member> + <member name="M:SciChart.Charting3D.Vector3.#ctor(SciChart.Charting3D.Interop.TSRVector3)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Vector3" /> struct. + </summary> + <param name="tsrVector3">The internal tsrvector3 value.</param> + </member> + <member name="M:SciChart.Charting3D.Vector3.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Vector3" /> struct. + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3.X"> + <summary> + access x value as X + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3.Y"> + <summary> + access y value as Y + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3.Z"> + <summary> + access z value as Z + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3.Zero"> + <summary> + Gets a Zero Vector + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3.Length"> + <summary> + Computes the length of the vector + </summary> + </member> + <member name="P:SciChart.Charting3D.Vector3.LengthSquared"> + <summary> + Computes the length squared of the vector + </summary> + </member> + <member name="M:SciChart.Charting3D.Vector3.Distance(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Gets the distance as a scalar between two vectors + </summary> + <param name="a">The first vector.</param> + <param name="b">The second vector.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Subtraction(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Implements the - operator, which subtracts one vector from another + </summary> + <param name="a">The first vector.</param> + <param name="b">The second vector.</param> + <returns> + The result of the operator = a - b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Addition(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Implements the + operator, which adds one vector to another + </summary> + <param name="a">The first vector.</param> + <param name="b">The second vector.</param> + <returns> + The result of the operator = a + b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Addition(SciChart.Charting3D.Vector3,System.Single)"> + <summary> + Implements the + operator, which adds a scalar to a vector + </summary> + <param name="a">The first vector.</param> + <param name="scalar">The scalar.</param> + <returns> + The result of the operator = a + b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Addition(SciChart.Charting3D.Vector3,System.Double)"> + <summary> + Implements the + operator, which adds a double-precision scalar to a vector + </summary> + <param name="a">The first vector.</param> + <param name="scalar">The scalar.</param> + <returns> + The result of the operator = a + b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Multiply(SciChart.Charting3D.Vector3,System.Single)"> + <summary> + Implements the * operator, which multiplies a vector by a scalar + </summary> + <param name="a">The first vector.</param> + <param name="scalar">The scalar.</param> + <returns> + The result of the operator = a * b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Multiply(SciChart.Charting3D.Vector3,System.Double)"> + <summary> + Implements the * operator, which multiplies a vector by a double-precision scalar + </summary> + <param name="a">The first vector.</param> + <param name="scalar">The scalar.</param> + <returns> + The result of the operator = a * b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_ExclusiveOr(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Implements the ^ cross product operator + </summary> + <param name="lhs">The first vector.</param> + <param name="rhs">The second vector.</param> + <returns> + The result of the operator = a CROSS b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.DotProduct(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Vector dot product. + </summary> + <param name="vector1">First vector.</param> + <param name="vector2">Second vector.</param> + <returns>Dot product of two vectors.</returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.Lerp(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3,System.Single)"> + <summary> + Linear interpolation between two vectors given a factor from 0.0 (equals from) to 1.0 (equals to) + </summary> + <param name="from">The From vector.</param> + <param name="to">The too vector.</param> + <param name="factor">The linear interpolation factor.</param> + <returns>The linearly interpolated vector</returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.ToString"> + <summary> + Returns a <see cref="T:System.String" /> that represents this instance. + </summary> + <returns> + A <see cref="T:System.String" /> that represents this instance. + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Equality(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Implements the == equality operator + </summary> + <param name="a">The first vector.</param> + <param name="b">The second vector.</param> + <returns> + The result of the operator = a == b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.op_Inequality(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Implements the != negative equality operator + </summary> + <param name="a">The first vector.</param> + <param name="b">The second vector.</param> + <returns> + The result of the operator = a != b + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.Equals(SciChart.Charting3D.Vector3)"> + <summary> + Implements the Equality operator + </summary> + <param name="other">The other.</param> + <returns>True, if equals</returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting3D.Vector3.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns> + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + </returns> + </member> + <member name="T:SciChart.Charting3D.Model.ChartData.BaseXyzSeriesInfo3D"> + <summary> + <para> Provides a ViewModel containing info about a <see cref="T:SciChart.Charting3D.Model.ChartData.BaseXyzSeriesInfo3D" />, such as name, value, color. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> types are + produced by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> as well as other modifiers. They are consumed by legend controls and may be consumed + by a custom <see cref="T:System.Windows.Controls.ItemsControl" /> binding to collection of <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />. </para> + <para> See the examples suite, specifically RolloverModifier, SciTrader and Legends examples for more information. </para> + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.BaseXyzSeriesInfo3D.#ctor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance to wrap.</param> + <param name="entityId">The scene entity Id that corresponds to the series.</param> + <param name="hitTestInfo">The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing information about a hit-test operation.</param> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.BaseXyzSeriesInfo3D.VertexId"> + <summary> + Gets or sets the vertex id at the hit-test site + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartData.ChartDataObject3D"> + <summary> + Provides a ViewModel containing info about chart series, which can be bound to. + See <see cref="P:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendData" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.ChartDataObject3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartData.ChartDataObject3D" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.ChartDataObject3D.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting3D.Model.ChartData.SeriesInfo3D})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartData.ChartDataObject3D" /> class. + </summary> + <param name="seriesInfos">The series infos.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.ChartDataObject3D.SeriesInfo"> + <summary> + Gets or sets a collection of <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> instances. + </summary> + <value>The series info.</value> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D"> + <summary> + <para> Provides a ViewModel containing info about a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, such as name, value, color. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> types are + produced by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> as well as other modifiers. They are consumed by legend controls and may be consumed + by a custom <see cref="T:System.Windows.Controls.ItemsControl" /> binding to collection of <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />. </para> + <para> See the examples suite, specifically RolloverModifier, SciTrader and Legends examples for more information.</para> + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.#ctor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class. + </summary> + <param name="rSeries">The r series.</param> + <param name="entityId">The scene entity Id that corresponds to the series.</param> + <param name="hitTestInfo">The hit test information.</param> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.PointMetadata"> + <summary> + Gets the metadata associated with the point at the hit-test site. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.Fill"> + <summary> + Gets or sets the brush of the series. + </summary> + <value>The brush of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance which this <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> wraps + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.SeriesName"> + <summary> + Gets or sets the name of the series. + </summary> + <value>The name of the series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.XValue"> + <summary> + Gets or sets the X-value. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.YValue"> + <summary> + Gets or sets the Y-value. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.ZValue"> + <summary> + Gets or sets the Z-value. + </summary> + <value>The value.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.FormattedXValue"> + <summary> + Gets a formatted XValue. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.FormattedYValue"> + <summary> + Gets a formatted YValue. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.FormattedZValue"> + <summary> + Gets a formatted ZValue. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.GetXCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using X axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.GetYCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using Y axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.GetZCursorFormattedValue(System.IComparable)"> + <summary> + Returns a value formatted using Z axis format for cursors. + </summary> + <param name="value">The value to format.</param> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.HitVertex"> + <summary> + Gets or sets <see cref="T:System.Windows.Media.Media3D.Vector3D" /> in world coordinates that was at the hit-test site + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.IsHit"> + <summary> + Get or sets whether the HitTest operation was a hit or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.IsVisible"> + <summary> + Gets or sets whether the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> that this <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> represents is visible or not. + NOTE: Setting this value will show or hide the associated <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> and may be data-bound to + </summary> + <value> + <c>true</c> if this instance is visible; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.Stroke"> + <summary> + Gets or sets the color of the series. + </summary> + <value>The color of the series.</value> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.HitVertexCoords"> + <summary> + Gets or sets <see cref="T:SciChart.Charting3D.Vector3" /> in world coordinates that was at the hit-test site + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.SeriesInfo3D.Clone"> + <summary> + Creates a new object that is a copy of the current instance. + </summary> + <returns> + A new object that is a copy of this instance. + </returns> + </member> + <member name="T:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D"> + <summary> + <para> Provides a ViewModel containing info about a <see cref="T:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D" />, such as name, value, color. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> types are + produced by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> as well as other modifiers. They are consumed by legend controls and may be consumed + by a custom <see cref="T:System.Windows.Controls.ItemsControl" /> binding to collection of <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />. </para> + <para> See the examples suite, specifically RolloverModifier, SciTrader and Legends examples for more information. </para> + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D.#ctor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance to wrap.</param> + <param name="entityId">The scene entity Id that corresponds to the series.</param> + <param name="hitTestInfo">The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing information about a hit-test operation.</param> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D.Z"> + <summary> + Gets or sets the Z index at the hit-test site + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartData.SurfaceMeshSeriesInfo3D.X"> + <summary> + Gets or sets the J index at the hit-test site + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartData.WaterfallSeriesInfo3D"> + <summary> + <para> Provides a ViewModel containing info about a <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" />, such as name, value, color. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> types are + produced by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> as well as other modifiers. They are consumed by legend controls and may be consumed + by a custom <see cref="T:System.Windows.Controls.ItemsControl" /> binding to collection of <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />. </para> + <para> See the examples suite, specifically RolloverModifier, SciTrader and Legends examples for more information. </para> + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartData.WaterfallSeriesInfo3D.#ctor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartData.WaterfallSeriesInfo3D" /> class. + </summary> + <param name="rSeries">The <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance to wrap.</param> + <param name="entityId">The scene entity Id that corresponds to the series.</param> + <param name="hitTestInfo">The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing information about a hit-test operation.</param> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.IAxis3DViewModel"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.IAxis3DViewModel.FontFamily"> + <summary> + Gets or sets a font of the axis plane labels. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel"> + <summary> + Base class for the <see cref="T:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel" /> derived classes. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel" /> derived class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.FontFamily"> + <summary> + Gets or sets a font of the axis plane labels. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.DrawMajorGridLines"> + <summary> + If True, draws Major Grid Lines, else skips this step. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.DrawMinorGridLines"> + <summary> + If True, draws Minor Grid Lines, else skips this step. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.DrawMajorBands"> + <summary> + If True, draws Major Axis Bands (a filled area between major gridlines), else skips this step. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.PositiveSideClipping"> + <summary> + Gets or sets a value determining how Renderable Series is clipped by axis at its positive side. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.NegativeSideClipping"> + <summary> + Gets or sets a value determining how Renderable Series is clipped by axis at its negative side. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.PlaneBorderColor"> + <summary> + Gets or sets a color of the axis plane border. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.PlaneBorderThickness"> + <summary> + Gets or sets a thickness of the axis plane border. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.AxisBase3DViewModel.LabelDepthTestEnabled"> + <summary> + If True, labels text is always on top. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.NumericAxis3DViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting3D.Visuals.Axis.NumericAxis3DForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.NumericAxis3DViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartSeries.NumericAxis3DViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.NumericAxis3DViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.DateTimeAxis3DViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting3D.Visuals.Axis.DateTimeAxis3DForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.DateTimeAxis3DViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartSeries.DateTimeAxis3DViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.DateTimeAxis3DViewModel.SubDayTextFormatting"> + <summary> + Gets or sets the TextFormatting used for axis labels when the range of the axis is sub-day. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.DateTimeAxis3DViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.TimeSpanAxis3DViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting3D.Visuals.Axis.TimeSpanAxis3DForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.TimeSpanAxis3DViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartSeries.TimeSpanAxis3DViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.TimeSpanAxis3DViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.LogarithmicNumericAxis3DViewModel"> + <summary> + Defines a default data context for the <see cref="T:SciChart.Charting3D.Visuals.Axis.LogarithmicNumericAxis3DForMvvm" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.LogarithmicNumericAxis3DViewModel.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.ChartSeries.LogarithmicNumericAxis3DViewModel" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.LogarithmicNumericAxis3DViewModel.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.LogarithmicNumericAxis3DViewModel.ViewType"> + <summary> + Gets the ViewType to instantiate for this view-model. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.Opacity"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <value>The color of the series.</value> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.IsSelected"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.DataSeries"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.PaletteProvider"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel.PointMarker"> + <summary></summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.Fill"> + <summary> + Gets or sets the Fill Color for columns + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.SelectedDataPointFill"> + <summary> + Gets or sets the Fill Color for selected data points + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.ColumnShape"> + <summary> + Gets or sets the Shape of the colums. Should be of <see cref="T:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D" /> type + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X and Z dimension + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.DataPointWidthX"> + <summary> + Gets or sets the DataPointWidthX, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X dimension + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.DataPointWidthZ"> + <summary> + Gets or sets the DataPointWidthZ, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in Z dimension + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ColumnRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel"> + <summary> + Provides a default data context for the <see cref="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D" /> in MVVM scenarios. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness to apply to the wireframe. + Used when the DrawMeshAs property is WireFrame or SolidWireFrame. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.DrawMeshAs"> + <summary> + Gets or sets how to draw the mesh + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.MeshColorPalette"> + <summary> + Gets or sets the MeshColorPalette which is used to calculate color from data value. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.MeshPaletteMode"> + <summary> + Gets or sets the MeshPaletteMode which defines how to apply the ColorMapTexture. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.PaletteMinMaxMode"> + <summary> + Gets or sets the PaletteMinMaxMode which defines how to apply PaletteMinimum and PaletteMaximum. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.PaletteMinimum"> + <summary> + Gets or sets the PaletteMinimum color in regards to X, Y and Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.PaletteMaximum"> + <summary> + Gets or sets the PaletteMaximum color in regards to X, Y and Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.ColorMapTexture"> + <summary> + Gets or sets the ColorMapTexture generated when the ColorPalette property changes. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.ColorMapTextureSize"> + <summary> + Gets or sets the Size of the texture to create when the ColorPalette property is set. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.FreeSurfaceRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.ImpulseRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.ImpulseRenderableSeries3DViewModel.#ctor"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ImpulseRenderableSeries3DViewModel.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the lines. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ImpulseRenderableSeries3DViewModel.SelectedDataPointStroke"> + <summary> + Gets or sets the Stroke Color for selected data points + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ImpulseRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.MountainRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.MountainRenderableSeries3DViewModel.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the lines. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.MountainRenderableSeries3DViewModel.Fill"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.MountainRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="M:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel.#ctor"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the lines. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel.SelectedDataPointStroke"> + <summary> + Gets or sets the Stroke Color for selected data points + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel.IsLineStrips"> + <summary> + Gets or sets the IsLineStrips + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel.IsAntialiased"> + <summary> + Gets or sets whether the Lines are antialiased (default FALSE). + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.PointLineRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.ScatterRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.ScatterRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.StrokeThickness"> + <summary> + Gets or sets the stroke thickness to apply to the wireframe. Used when <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.DrawMeshAs" /> is WireFrame or SolidWireFrame + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.HeightScaleFactor"> + <summary> + Gets or sets the height scale factor. Default is 1.0f. Value of 0.0f will render a flat Uniform Surface Mesh. Value of 1.0f will use the scaling of the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> YAxis + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshResolution"> + <summary> + Gets or sets the mesh resolution. By default for each point in the <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`1" />, there will be one vertex in the resulting mesh. To increase the resolution, use <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshResolution" /> x2 or <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshResolution" /> x4 + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.DrawMeshAs"> + <summary> + Gets or sets how to draw the mesh + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.DrawSkirt"> + <summary> + Gets or sets whether to draw the skirt (geometry from the edges of the surface mesh to the zero line in Y) + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshColorPalette"> + <summary> + Gets or sets the MeshColorPalette which is used to calculate color from data value + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.Minimum"> + <summary> + Gets or sets value which corresponds to min color + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.Maximum"> + <summary> + Gets or sets value which corresponds to max color + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshPaletteMode"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshPaletteMode" />, which defines how to apply the <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.ColorMapTexture" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.ColorMapTexture"> + <summary> + Gets or sets the ColorMapTexture generated when the <see cref="T:System.Drawing.Imaging.ColorPalette" /> property changes. Alternatively, this property may be set by the user if a custom texture is required. + Also see <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.MeshPaletteMode" />, which defines how the <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.ColorMapTexture" /> is applied to the surface mesh geometry + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.ColorMapTextureSize"> + <summary> + Gets or sets the Size of the texture to create when the <see cref="T:System.Drawing.Imaging.ColorPalette" /> property is set. If the user sets the <see cref="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.ColorMapTexture" /> directly, this property is ignored + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.SurfaceMeshRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel"> + <summary></summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.ClipMode"> + <summary> + Gets or sets how a Waterfall Chart renders its data. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.YColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling slices of a waterfall chart. + The slices will be painted along Y axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.ZColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling slices of a waterfall chart. + The slices will be painted along Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.YStrokeColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for paining outlines of slices of a waterfall chart. + The outlines of slices will be painted along Y axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.ZStrokeColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for paining outlines of slices of a waterfall chart. + The outlines of slices will be painted along Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.SelectedColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling selected slices of a waterfall chart. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.SelectedStroke"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for paining outlines of selected slices of a waterfall chart. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.StrokeThickness"> + <summary> + Gets or sets the stroke thickness of waterfall chart slices. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.SliceThickness"> + <summary> + Gets or sets the thickness of waterfall chart slices. + Produces volumetric slices if set to a value > 0. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.ChartSeries.WaterfallRenderableSeries3DViewModel.ViewType"> + <summary> + Gets the RenderableSeries3D Type to which this ViewModel will be associated + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.DataBoundingBox"> + <summary> + Provides a bounding box in Data-coordinates + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.DataBoundingBox.XRange"> + <summary> + The X-Range + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.DataBoundingBox.YRange"> + <summary> + The Y-Range + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.DataBoundingBox.ZRange"> + <summary> + The Z-Range + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataBoundingBox.Equals(System.Object)"> + <summary> + Determines whether the specified <see cref="T:System.Object" />, is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with this instance.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting3D.Model.DataBoundingBox.Equals(SciChart.Charting3D.Model.DataBoundingBox)"> + <summary> + Equalses the specified other. + </summary> + <param name="other">The other.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.DataBoundingBox.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns> + A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table. + </returns> + </member> + <member name="T:SciChart.Charting3D.Model.DataSeries3D"> + <summary> + A generic abstract base class which defines a generic DataSeries which contains 1..N columns, + such as X,Y,Z in the case of plain X,Y,Z data. + </summary> + <seealso cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.IXyzDataSeries`3" /> + <seealso cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`3" /> + <see cref="!:IUniformGridDataSeries3D" /> + <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`1" /> + <seealso cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + <remarks>DataSeries3D are assigned to the RenderableSeries3D via the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DataSeries" /> property. Any time a DataSeries3D is appended to, the + parent <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> will be redrawn.</remarks> + </member> + <member name="F:SciChart.Charting3D.Model.DataSeries3D.SyncRoot"> + <summary> + The Synchronization Object for the DataSeries3D. + </summary> + </member> + <member name="E:SciChart.Charting3D.Model.DataSeries3D.DataSeriesChanged"> + <summary> + Event raised whenever points are added to, removed or one or more DataSeries3D properties changes, requiring a redraw of the parent SciChartSurface. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.SeriesName"> + <summary> + Gets or sets the name of this series. + </summary> + <value>The name of the series.</value> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /> which this <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> instance is attached to. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.YRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Y direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries3D.IsDirty"> + <summary> + Gets or sets a value indicating whether this instance is dirty. If dirty, any cached data must be re-calculated. You can set this value to <value>True</value> to force recalculation of caches. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.OnDataSeriesChanged(SciChart.Charting.Model.DataSeries.DataSeriesUpdate,SciChart.Charting.Model.DataSeries.DataSeriesAction)"> + <summary> + Raises the <see cref="E:SciChart.Charting3D.Model.DataSeries3D.DataSeriesChanged" /> event. May be called by DataSeries3D or by user code to trigger a redraw on the ParentSurface. The event is not raised while <see cref="P:SciChart.Core.Framework.ISuspendable.IsSuspended" /> is <value>True</value>. + <seealso cref="T:SciChart.Charting.Model.DataSeries.DataSeriesUpdate" /></summary> + <param name="dsUpdate"></param> + <param name="dataSeriesAction"></param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass. + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing. + </returns> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.Clear"> + <summary> + Clears the DataSeries. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued. + </summary> + <returns> + The disposable Update Suspender. + </returns> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by <see cref="T:SciChart.Core.Framework.IUpdateSuspender" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode)"> + <summary> + May be called to trigger a redraw on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. This method is extremely useful + when <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> are in a ViewModel and bound via MVVM to <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />. + Please see the <paramref name="rangeMode" /> parameter for invalidation options. + </summary> + <param name="rangeMode">Provides <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> invalidation options for the parent surface.</param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, <see cref="M:SciChart.Charting3D.Model.DataSeries3D.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)" /> is called. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries3D.GetBounds"> + <summary> + Gets the bounding box for the data (containing <see cref="P:SciChart.Charting3D.Model.DataSeries3D.XRange" />, <see cref="P:SciChart.Charting3D.Model.DataSeries3D.YRange" />, <see cref="P:SciChart.Charting3D.Model.DataSeries3D.ZRange" />). + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IDoubleDoubleList"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting3D.Model.DoubleDoubleList`1" />: a class which wraps a two-dimensional jagged array of type T and allows conversion to double at index i,j + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDoubleDoubleList.CountI"> + <summary> + Gets the count of the inner array in the I-direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDoubleDoubleList.CountJ"> + <summary> + Gets the count of the inner array in the J-direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDoubleDoubleList.Item(System.Int32,System.Int32)"> + <summary> + Gets the and converts the item at index i,j to <see cref="T:System.Double" /></summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns></returns> + </member> + <member name="P:SciChart.Charting3D.Model.IDoubleDoubleList.InnerArray"> + <summary> + Gets the untyped inner array + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.DoubleDoubleList`1"> + <summary> + A class which wraps a two-dimensional jagged array of type T and allows conversion to double at index i,j + </summary> + <typeparam name="T">The type of item</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.DoubleDoubleList`1.#ctor(`0[][],System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.DoubleDoubleList`1" /> class. + </summary> + <param name="inputArray">The input array.</param> + <param name="iCount">The i count.</param> + <param name="jCount">The j count.</param> + </member> + <member name="P:SciChart.Charting3D.Model.DoubleDoubleList`1.CountI"> + <summary> + Gets the count of the inner array in the I-direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DoubleDoubleList`1.CountJ"> + <summary> + Gets the count of the inner array in the J-direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DoubleDoubleList`1.InnerArray"> + <summary> + Gets the untyped inner array + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DoubleDoubleList`1.Item(System.Int32,System.Int32)"> + <summary> + Gets the and converts the item at index i,j to <see cref="T:System.Double" /></summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`1"> + <summary> + The mesh data series defined by parametrized in regards to spherical coordinates system: Radius, Pole, Azimuth. + </summary> + <typeparam name="TAllPoints">The X,Y,Z type.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`1.#ctor(System.Int32,System.Int32,System.Func{System.Double,System.Double,System.Double},System.Func{System.Double,System.Double,System.Double},System.Func{System.Double,System.Double,System.Double},System.Func{System.Double,System.Double,System.Double,`0},System.Func{System.Double,System.Double,System.Double,`0},System.Func{System.Double,System.Double,System.Double,`0},System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`1" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="radialDistanceFunction">Custom function that provides a value, treated as radius argument in X/Y/Z custom functions.</param> + <param name="azimuthalAngleFunction">Custom function that provides a value, treated as azimuth argument in X/Y/Z custom functions.</param> + <param name="polarAngleFunction">Custom function that provides a value, treated as pole argument in X/Y/Z custom functions.</param> + <param name="xFunction">Custom function that provides the position X value, based on passed radius, azimuth and pole arguments.</param> + <param name="yFunction">Custom function that provides the position Y value, based on passed radius, azimuth and pole arguments.</param> + <param name="zFunction">Custom function that provides the position Z value, based on passed radius, azimuth and pole arguments.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + <param name="vMin">The minimum value of V component of the 2D grid.</param> + <param name="vMax">The maximum value of V component of the 2D grid.</param> + </member> + <member name="T:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`3"> + <summary> + The mesh data series defined by parametrized in regards to spherical coordinates system: Radius, Pole, Azimuth. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`3.#ctor(System.Int32,System.Int32,System.Func{System.Double,System.Double,System.Double},System.Func{System.Double,System.Double,System.Double},System.Func{System.Double,System.Double,System.Double},System.Func{System.Double,System.Double,System.Double,`0},System.Func{System.Double,System.Double,System.Double,`1},System.Func{System.Double,System.Double,System.Double,`2},System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`3" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="radialDistanceFunction">Custom function that provides a value, treated as radius argument in X/Y/Z custom functions.</param> + <param name="azimuthalAngleFunction">Custom function that provides a value, treated as azimuth argument in X/Y/Z custom functions.</param> + <param name="polarAngleFunction">Custom function that provides a value, treated as pole argument in X/Y/Z custom functions.</param> + <param name="xFunction">Custom function that provides the position X value, based on passed radius, azimuth and pole arguments.</param> + <param name="yFunction">Custom function that provides the position Y value, based on passed radius, azimuth and pole arguments.</param> + <param name="zFunction">Custom function that provides the position Z value, based on passed radius, azimuth and pole arguments.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + <param name="vMin">The minimum value of V component of the 2D grid.</param> + <param name="vMax">The maximum value of V component of the 2D grid.</param> + </member> + <member name="M:SciChart.Charting3D.Model.CustomFreeSurfaceDataSeries3D`3.GetDataValue(System.Double,System.Double,`0@,`1@,`2@)"> + <summary> + Gets the 3-Dimensional data value by specified UV index of the 2D grid in the surface. + </summary> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="T:SciChart.Charting3D.Model.CylindroidDataSeries3D`1"> + <summary> + Data Series that defines the Cylindroid in 3-Dimensional space ( see: https://en.wikipedia.org/wiki/Cylinder#Cylindrical_surfaces ). + </summary> + <typeparam name="TAllPoints">The XZ and Y type.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.CylindroidDataSeries3D`1.#ctor(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.CylindroidDataSeries3D`1" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + <param name="vMin">The minimum value of V component of the 2D grid.</param> + <param name="vMax">The maximum value of V component of the 2D grid.</param> + </member> + <member name="T:SciChart.Charting3D.Model.CylindroidDataSeries3D`2"> + <summary> + Data Series that defines the Cylindroid in 3-Dimensional space ( see: https://en.wikipedia.org/wiki/Cylinder#Cylindrical_surfaces ). + </summary> + <typeparam name="TXZ">The type of the X and the Z.</typeparam> + <typeparam name="TY">The type of the Y.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.CylindroidDataSeries3D`2.#ctor(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.CylindroidDataSeries3D`2" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + <param name="vMin">The minimum value of V component of the 2D grid.</param> + <param name="vMax">The maximum value of V component of the 2D grid.</param> + </member> + <member name="P:SciChart.Charting3D.Model.CylindroidDataSeries3D`2.A"> + <summary> + The A component of the Cylindroid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.CylindroidDataSeries3D`2.B"> + <summary> + The B component of the Cylindroid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.CylindroidDataSeries3D`2.H"> + <summary> + The height of the Cylindroid. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.CylindroidDataSeries3D`2.GetDataValue(System.Double,System.Double,`0@,`1@,`0@)"> + <summary> + Gets the 3-Dimensional data value by specified UV index of the 2D grid in the surface. + </summary> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="M:SciChart.Charting3D.Model.CylindroidDataSeries3D`2.GetDataDisplacement(`0,System.Double,System.Double,`0@,`0@)"> + <summary> + Gets X and Z offsets in regards to passed scale value and UV coordinates. + </summary> + <param name="dataValue">Value from the Height Map.</param> + <param name="u">The U coordinate.</param> + <param name="v">The V coordinate.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + </member> + <member name="T:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1"> + <summary> + Data Series that defines the Ellipsoid in 3-Dimensional space by the Standard equation ( see: https://en.wikipedia.org/wiki/Ellipsoid#Standard_equation ). + </summary> + <typeparam name="TXYZ">The type of the X, Y, and Z axes.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1.#ctor(System.Int32,System.Int32,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + <param name="vMin">The minimum value of V component of the 2D grid.</param> + <param name="vMax">The maximum value of V component of the 2D grid.</param> + </member> + <member name="P:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1.A"> + <summary> + The A component of the Standard ellipsoid equation. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1.B"> + <summary> + The B component of the Standard ellipsoid equation. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1.C"> + <summary> + The C component of the Standard ellipsoid equation. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1.GetDataValue(System.Double,System.Double,`0@,`0@,`0@)"> + <summary> + Gets the 3-Dimensional coordinate by specified U and V index of the surface. + </summary> + <param name="u">The U coordinate.</param> + <param name="v">The V coordinate.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="M:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1.GetDataDisplacement(`0,System.Double,System.Double,`0@,`0@,`0@)"> + <summary> + Gets the displacement along the XZ axes in regards to Displacement Map data and UV coordinates. + </summary> + <param name="dataValue">Value of an element of the grid data data grid.</param> + <param name="u">The U coordinate of the surface.</param> + <param name="v">The V coordinate of the surface.</param> + <param name="x">When method returns, contains the the Displacement Map value along the X axis.</param> + <param name="y">When method returns, contains the the Displacement Map value along the Y axis.</param> + <param name="z">When method returns, contains the the Displacement Map value along the Z axis.</param> + </member> + <member name="T:SciChart.Charting3D.Model.IFreeSurfaceDataSeries3D"> + <summary> + Defines the base interface to a <see cref="T:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3" />, the data source for various 3D RenderableSeries + such as <see cref="T:SciChart.Charting3D.Model.EllipsoidDataSeries3D`1" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfaceDataSeries3D.UCount"> + <summary> + Gets number of U segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfaceDataSeries3D.VCount"> + <summary> + Gets number of V segments of the 2D grid. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3"> + <summary> + 2D grid based free shaped 3D surface. + </summary> + <typeparam name="TX">The type of the x.</typeparam> + <typeparam name="TY">The type of the y.</typeparam> + <typeparam name="TZ">The type of the z.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.OffsetX"> + <summary> + Gets or sets a data offset by X axis of the Surface. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.OffsetY"> + <summary> + Gets or sets a data offset by Y axis of the Surface. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.OffsetZ"> + <summary> + Gets or sets a data offset by Z axis of the Surface. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.UCount"> + <summary> + Gets number of U segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.VCount"> + <summary> + Gets number of V segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.YRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Y direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.InvalidOperationException">Expected TPointSeries generic constraint to be ISurfaceDataSeries3D</exception> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.Clear"> + <summary> + Clears the DataSeries. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.GetDataValue(System.Double,System.Double,`0@,`1@,`2@)"> + <summary> + Gets the 3-Dimensional data value by specified UV index of the 2D grid in the surface. + </summary> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.GetDisplacedDataValue(System.Int32,System.Int32,System.Double,System.Double,`0@,`1@,`2@)"> + <summary> + Gets the 3-Dimensional data value with the Displacement Map value applied. + </summary> + <param name="uIndex">The index of U coordinate in the 2D grid space.</param> + <param name="vIndex">The index of V coordinate in the 2D grid space.</param> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.GetU(System.Int32)"> + <summary> + Gets the U coordinate by passed index of the 2D grid. + </summary> + <param name="index">Index of the U segment of the 2D grid.</param> + <returns>The U coordinate.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.GetV(System.Int32)"> + <summary> + Gets the V coordinate by passed index of the 2D grid. + </summary> + <param name="index">Index of the V segment of the 2D grid.</param> + <returns>The V coordinate.</returns> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.CachedXRange"> + <summary> + Internal access to the cached XRange for testing. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.CachedYRange"> + <summary> + Internal access to the cached YRange for testing. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3.CachedZRange"> + <summary> + Internal access to the cached ZRange for testing. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D"> + <summary> + This contains the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.IFreeSurfaceDataSeries3D" /> + to a render-loop compatible collection + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.UCount"> + <summary> + Gets number of U segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.VCount"> + <summary> + Gets number of V segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.OffsetXAsDouble"> + <summary> + Gets a data offset by X axis of the Surface represented in <see cref="T:System.Double" /> type. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.OffsetYAsDouble"> + <summary> + Gets a data offset by Y axis of the Surface represented in <see cref="T:System.Double" /> type. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.OffsetZAsDouble"> + <summary> + Gets a data offset by Z axis of the Surface represented in <see cref="T:System.Double" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.GetU(System.Int32)"> + <summary> + Gets the U coordinate by passed index of the 2D grid. + </summary> + <param name="index">Index of the U segment of the 2D grid.</param> + <returns>The U coordinate.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.GetV(System.Int32)"> + <summary> + Gets the V coordinate by passed index of the 2D grid. + </summary> + <param name="index">Index of the V segment of the 2D grid.</param> + <returns>The V coordinate.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.GetValueAsDouble(System.Double,System.Double,System.Double@,System.Double@,System.Double@)"> + <summary> + Gets a value at specified UV coordinate represented in <see cref="T:System.Double" /> type. + </summary> + <param name="u">The U coordinate.</param> + <param name="v">The V coordinate.</param> + <param name="xAsDouble">When this method returns, contains a value by the X axis.</param> + <param name="yAsDouble">When this method returns, contains a value by the Y axis.</param> + <param name="zAsDouble">When this method returns, contains a value by the Z axis.</param> + </member> + <member name="M:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D.GetValueWithOffsetAsDouble(System.Int32,System.Int32,System.Double@,System.Double@,System.Double@)"> + <summary> + Gets a value at specified index of the UV coordinate represented in <see cref="T:System.Double" /> type. + </summary> + <param name="uIndex">The index of the U coordinate.</param> + <param name="vIndex">The index of the V coordinate.</param> + <param name="xAsDouble">When this method returns, contains a value by the X axis.</param> + <param name="yAsDouble">When this method returns, contains a value by the Y axis.</param> + <param name="zAsDouble">When this method returns, contains a value by the Z axis.</param> + </member> + <member name="T:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3"> + <summary> + This contains the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3" /> + to a render-loop compatible collection + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.#ctor(SciChart.Charting3D.Model.FreeSurfaceDataSeries3D{`0,`1,`2})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3" /> class. + </summary> + <param name="dataSeries">The free surface data series.</param> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.UCount"> + <summary> + Gets number of U segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.VCount"> + <summary> + Gets number of V segments of the 2D grid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.OffsetXAsDouble"> + <summary> + Gets a data offset by X axis of the Surface represented in <see cref="T:System.Double" /> type. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.OffsetYAsDouble"> + <summary> + Gets a data offset by Y axis of the Surface represented in <see cref="T:System.Double" /> type. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.OffsetZAsDouble"> + <summary> + Gets a data offset by Z axis of the Surface represented in <see cref="T:System.Double" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetXValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> X value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The X-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetYValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> Y value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The Y-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetZValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> Z value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The Z-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetValueAsDouble(System.Double,System.Double,System.Double@,System.Double@,System.Double@)"> + <summary> + Gets a value at specified UV coordinate represented in <see cref="T:System.Double" /> type. + </summary> + <param name="u">The U coordinate.</param> + <param name="v">The V coordinate.</param> + <param name="xAsDouble">When this method returns, contains a value by the X axis.</param> + <param name="yAsDouble">When this method returns, contains a value by the Y axis.</param> + <param name="zAsDouble">When this method returns, contains a value by the Z axis.</param> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetValueWithOffsetAsDouble(System.Int32,System.Int32,System.Double@,System.Double@,System.Double@)"> + <summary> + Gets a value at specified index of the UV coordinate represented in <see cref="T:System.Double" /> type. + </summary> + <param name="uIndex">The index of the U coordinate.</param> + <param name="vIndex">The index of the V coordinate.</param> + <param name="xAsDouble">When this method returns, contains a value by the X axis.</param> + <param name="yAsDouble">When this method returns, contains a value by the Y axis.</param> + <param name="zAsDouble">When this method returns, contains a value by the Z axis.</param> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetU(System.Int32)"> + <summary> + Gets the U coordinate by passed index of the 2D grid. + </summary> + <param name="index">Index of the U segment of the 2D grid.</param> + <returns>The U coordinate.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.GetV(System.Int32)"> + <summary> + Gets the V coordinate by passed index of the 2D grid. + </summary> + <param name="index">Index of the V segment of the 2D grid.</param> + <returns>The V coordinate.</returns> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.SyncRoot"> + <summary> + Gets the Synchronization object + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.FreeSurfacePointSeries3D`3.IsDirty"> + <summary> + Gets or sets a value indicating whether the wrapped DataSeries is Dirty. This will be set to True when the DataSeries has changes, and must be set to False after creating a 3D mesh + </summary> + <remarks> + By setting this to FALSE after a mesh is created, you can cache meshes until the data changes again + </remarks> + </member> + <member name="T:SciChart.Charting3D.Model.DisplacementAxis3D"> + <summary> + Enumerates 3D axes along which displacement map is applied. + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.DisplacementAxis3D.XAxis"> + <summary> + X axis. + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.DisplacementAxis3D.YAxis"> + <summary> + Y axis. + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.DisplacementAxis3D.ZAxis"> + <summary> + Z axis. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IDisplaceableFreeSurfacePointSeries"> + <summary> + Interface of Free Surface data series with the Displacement Map, applied to its points displacing them along X and/or Y and/or Z axes. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDisplaceableFreeSurfacePointSeries.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value as double at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.IDisplaceableFreeSurfacePointSeries.IsAxesPropagationAbsolute"> + <summary> + Gets value determining whether the displacement is absolute. + This means that surface is displaced by a value from the displacement map + by specified displacement axes absolutely, ignoring its relative direction + from the origin. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDisplaceableFreeSurfacePointSeries.DisplacementAxes"> + <summary> + Gets axes by which surface can be displaced. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.PolarDataSeries3D`1"> + <summary> + Data Series that defines the polar chart in 3D space. + </summary> + <typeparam name="TAllPoints">The type of the x.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.PolarDataSeries3D`1.#ctor(System.Int32,System.Int32,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.PolarDataSeries3D`1" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + </member> + <member name="T:SciChart.Charting3D.Model.PolarDataSeries3D`2"> + <summary> + Data Series that defines the polar chart in 3D space. + </summary> + <typeparam name="TPolar">The type of the x.</typeparam> + <typeparam name="THeight">The type of the y.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.PolarDataSeries3D`2.#ctor(System.Int32,System.Int32,System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.PolarDataSeries3D`2" /> class. + </summary> + <param name="uCount">The U dimension of the 2D grid.</param> + <param name="vCount">The V dimension of the 2D grid.</param> + <param name="uMin">The minimum value of U component of the 2D grid.</param> + <param name="uMax">The maximum value of U component of the 2D grid.</param> + </member> + <member name="P:SciChart.Charting3D.Model.PolarDataSeries3D`2.A"> + <summary> + The A component of ... + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.PolarDataSeries3D`2.B"> + <summary> + The B component of ... + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.PolarDataSeries3D`2.GetDataValue(System.Double,System.Double,`0@,`1@,`0@)"> + <summary> + Gets the 3-Dimensional data value by specified UV index of the 2D grid in the surface. + </summary> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="T:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1"> + <summary> + Free Surface data series with the grid data, applied to its points displacing them along the XYZ axes. + </summary> + <typeparam name="TXYZ">Type of X, Y, and Z axes.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.InternalArray"> + <summary> + Accesses the internal array. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.InvalidOperationException">Expected TPointSeries generic constraint to be ISurfaceDataSeries3D</exception> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.GetDataDisplacement(`0,System.Double,System.Double,`0@,`0@,`0@)"> + <summary> + Gets the displacement along the XZ axes in regards to Displacement Map data and UV coordinates. + </summary> + <param name="dataValue">Value of an element of the grid data data grid.</param> + <param name="u">The U coordinate of the surface.</param> + <param name="v">The V coordinate of the surface.</param> + <param name="x">When method returns, contains the the Displacement Map value along the X axis.</param> + <param name="y">When method returns, contains the the Displacement Map value along the Y axis.</param> + <param name="z">When method returns, contains the the Displacement Map value along the Z axis.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.GetRowAt(System.Int32)"> + <summary> + Returns the row at the specified Z Index + </summary> + <param name="zIndex"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.CopyFrom(SciChart.Data.Model.GridData{`0})"> + <summary> + Fills the ScalableXZFreeSurfaceDataSeries from a <see cref="T:SciChart.Data.Model.GridData`1" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.CopyFrom(`0[][])"> + <summary> + Fills the ScalableXZFreeSurfaceDataSeries from a two dimensional array. Assumes the array is rectangular + </summary> + <param name="innerArray">The inner array.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.SetRowAt(System.Int32,`0[])"> + <summary> + Sets the row at the specified Z index + </summary> + <param name="zIndex">Index of the z.</param> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.PushRow(`0[])"> + <summary> + Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction + </summary> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1.GetDisplacedDataValue(System.Int32,System.Int32,System.Double,System.Double,`0@,`0@,`0@)"> + <summary> + Gets the 3-Dimensional data value with the Displacement Map value applied. + </summary> + <param name="uIndex">The index of U coordinate in the 2D grid space.</param> + <param name="vIndex">The index of V coordinate in the 2D grid space.</param> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="T:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfacePointSeries`1"> + <summary> + This contains the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfaceDataSeries`1" /> + to a render-loop compatible collection + </summary> + <typeparam name="TXYZ">Type of X, Y, and Z Axes.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfacePointSeries`1.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value as double at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfacePointSeries`1.IsAxesPropagationAbsolute"> + <summary> + Gets value determining whether the displacement is absolute. + This means that surface is displaced by a value from the displacement map + by specified displacement axes absolutely, ignoring its relative direction + from the origin. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDisplaceableFreeSurfacePointSeries`1.DisplacementAxes"> + <summary> + Gets axes by which surface can be displaced. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2"> + <summary> + Free Surface data series with the grid data, applied to its points displacing them along the XZ axes. + </summary> + <typeparam name="TXZ">Type of X and Z axes.</typeparam> + <typeparam name="TY">Type of the Y axis.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.InternalArray"> + <summary> + Accesses the internal array. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.InvalidOperationException">Expected TPointSeries generic constraint to be ISurfaceDataSeries3D</exception> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.GetDataDisplacement(`0,System.Double,System.Double,`0@,`0@)"> + <summary> + Gets the displacement along the XZ axes in regards to Displacement Map data and UV coordinates. + </summary> + <param name="dataValue">Value of an element of the grid data data grid.</param> + <param name="u">The U coordinate of the surface.</param> + <param name="v">The V coordinate of the surface.</param> + <param name="x">When method returns, contains the Displacement Map value along the X axis.</param> + <param name="z">When method returns, contains the Displacement Map value along the Z axis.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.GetRowAt(System.Int32)"> + <summary> + Returns the row at the specified Z Index + </summary> + <param name="zIndex"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.CopyFrom(SciChart.Data.Model.GridData{`0})"> + <summary> + Fills the ScalableXZFreeSurfaceDataSeries from a <see cref="T:SciChart.Data.Model.GridData`1" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.CopyFrom(`0[][])"> + <summary> + Fills the ScalableXZFreeSurfaceDataSeries from a two dimensional array. Assumes the array is rectangular + </summary> + <param name="innerArray">The inner array.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.SetRowAt(System.Int32,`0[])"> + <summary> + Sets the row at the specified Z index + </summary> + <param name="zIndex">Index of the z.</param> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.PushRow(`0[])"> + <summary> + Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction + </summary> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2.GetDisplacedDataValue(System.Int32,System.Int32,System.Double,System.Double,`0@,`1@,`0@)"> + <summary> + Gets the 3-Dimensional data value with the Displacement Map value applied. + </summary> + <param name="uIndex">The index of U coordinate in the 2D grid space.</param> + <param name="vIndex">The index of V coordinate in the 2D grid space.</param> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="T:SciChart.Charting3D.Model.XzDisplaceableFreeSurfacePointSeries`2"> + <summary> + This contains the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.XzDisplaceableFreeSurfaceDataSeries`2" /> + to a render-loop compatible collection + </summary> + <typeparam name="TXZ">Type of X and Z Axes.</typeparam> + <typeparam name="TY">Type of the Y Axis.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.XzDisplaceableFreeSurfacePointSeries`2.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value as double at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.XzDisplaceableFreeSurfacePointSeries`2.IsAxesPropagationAbsolute"> + <summary> + Gets value determining whether the displacement is absolute. + This means that surface is displaced by a value from the displacement map + by specified displacement axes absolutely, ignoring its relative direction + from the origin. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XzDisplaceableFreeSurfacePointSeries`2.DisplacementAxes"> + <summary> + Gets axes by which surface can be displaced. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3"> + <summary> + Free Surface data series with the grid data, applied to its points displacing them along the Y axis. + </summary> + <typeparam name="TX">Type of the X Axis.</typeparam> + <typeparam name="TY">Type of the Y Axis.</typeparam> + <typeparam name="TZ">Type of the Z Axis.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.InternalArray"> + <summary> + Accesses the internal array. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.InvalidOperationException">Expected TPointSeries generic constraint to be ISurfaceDataSeries3D</exception> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.GetRowAt(System.Int32)"> + <summary> + Returns the row at the specified Z Index + </summary> + <param name="zIndex"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.CopyFrom(SciChart.Data.Model.GridData{`1})"> + <summary> + Fills the ScalableXZFreeSurfaceDataSeries from a <see cref="T:SciChart.Data.Model.GridData`1" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.CopyFrom(`1[][])"> + <summary> + Fills the ScalableXZFreeSurfaceDataSeries from a two dimensional array. Assumes the array is rectangular + </summary> + <param name="innerArray">The inner array.</param> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.SetRowAt(System.Int32,`1[])"> + <summary> + Sets the row at the specified Z index + </summary> + <param name="zIndex">Index of the z.</param> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.PushRow(`1[])"> + <summary> + Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction + </summary> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3.GetDisplacedDataValue(System.Int32,System.Int32,System.Double,System.Double,`0@,`1@,`2@)"> + <summary> + Gets the 3-Dimensional data value with applied displacement by specified UV index of the 2D grid in the surface. + </summary> + <param name="uIndex">The index of U coordinate in the 2D grid space.</param> + <param name="vIndex">The index of V coordinate in the 2D grid space.</param> + <param name="u">The U coordinate in the 2D grid space.</param> + <param name="v">The V coordinate in the 2D grid space.</param> + <param name="x">When method returns, contains a value of the X coordinate.</param> + <param name="y">When method returns, contains a value of the Y coordinate.</param> + <param name="z">When method returns, contains a value of the Z coordinate.</param> + </member> + <member name="T:SciChart.Charting3D.Model.YDisplaceableFreeSurfacePointSeries`3"> + <summary> + This contains the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.YDisplaceableFreeSurfaceDataSeries`3" /> + to a render-loop compatible collection + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.YDisplaceableFreeSurfacePointSeries`3.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets Displacement Map value as double at the UV index. + </summary> + <param name="uIndex">The U index.</param> + <param name="vIndex">The V index.</param> + <returns>The item at this index</returns> + </member> + <member name="P:SciChart.Charting3D.Model.YDisplaceableFreeSurfacePointSeries`3.IsAxesPropagationAbsolute"> + <summary> + Gets value determining whether the displacement is absolute. + This means that surface is displaced by a value from the displacement map + by specified displacement axes absolutely, ignoring its relative direction + from the origin. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.YDisplaceableFreeSurfacePointSeries`3.DisplacementAxes"> + <summary> + Gets axes by which surface can be displaced. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IBaseGridDataSeries3D"> + <summary> + Defines the base interface to a <see cref="T:SciChart.Charting3D.Model.BaseGridDataSeries3D`3" />, the data source for various 3D RenderableSeries + such as <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.IBaseGridDataSeries3D.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets the <see cref="T:System.IComparable">item</see> at the i,j index + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The item at this index</returns> + </member> + <member name="M:SciChart.Charting3D.Model.IBaseGridDataSeries3D.GetX(System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable">item</see> at the X index + </summary> + <param name="i">The i index.</param> + <returns>The item at this index</returns> + </member> + <member name="M:SciChart.Charting3D.Model.IBaseGridDataSeries3D.GetZ(System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable">item</see> at the Z index + </summary> + <param name="j">The j index.</param> + <returns>The item at this index</returns> + </member> + <member name="T:SciChart.Charting3D.Model.BaseGridDataSeries3D`3"> + <summary> + <para>The BaseGridDataSeries3D wraps a 2D array of type <typeparamref name="TY" /> which become the Y-values (heights) in various RenderableSeries</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> the Y-values map to the heights, whereas the <see cref="!:StartX" />, <see cref="!:StepX" />, <see cref="!:StartZ" />, <see cref="!:StepZ" /> defines the X and Z values</para> + </summary> + <typeparam name="TX">The type of the x.</typeparam> + <typeparam name="TY">The type of the y.</typeparam> + <typeparam name="TZ">The type of the z.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="!:BaseGridDataSeries3D<T>" /> class. + </summary> + <param name="xSize">Size of the x.</param> + <param name="zSize">Size of the z.</param> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.InternalArray"> + <summary> + Accesses the internal array, which is a rectangular array indexed by Z then X + </summary> + <example> + <code language="csharp"> + int xSize = 10; + int zSize = 20; + var data = new BaseGridDataSeries3D<double>(xSize, zSize); + + double value = data.InternalArray[z][x]; + </code> + </example> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.XSize"> + <summary> + Gets the X-Size of the Grid + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.ZSize"> + <summary> + Gets the Y-Size of the grid + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.SyncRoot"> + <summary> + Gets an object for thread synchronization purposes + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.SciChart#Charting3D#Model#IBaseGridDataSeries3D#Item(System.Int32,System.Int32)"> + <summary> + Returns the Y-value at index z,x + </summary> + <param name="x">The XIndex</param> + <param name="z">The ZIndex</param> + <returns></returns> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.YRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Y direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.Item(System.Int32,System.Int32)"> + <summary> + Returns the Y-value at index Z,X + </summary> + <param name="x">The XIndex</param> + <param name="z">The ZIndex</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.Clear"> + <summary> + Clears the DataSeries, resetting to an empty array of XSize,ZSize + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.Clear(System.Int32,System.Int32)"> + <summary> + Clears the <see cref="T:SciChart.Charting3D.Model.BaseGridDataSeries3D`3" />, resetting its X,Z size + </summary> + <param name="xSize">The new XSize</param> + <param name="zSize">The new ZSize</param> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.SciChart#Charting3D#Model#IBaseGridDataSeries3D#GetX(System.Int32)"> + <summary> + Computes the X data-value at the specified index + </summary> + <param name="i"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.SciChart#Charting3D#Model#IBaseGridDataSeries3D#GetZ(System.Int32)"> + <summary> + Computes the Z data-value at the specified index + </summary> + <param name="j"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.GetX(System.Int32)"> + <summary> + Computes the X data-value at the specified index + </summary> + <param name="i"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.GetZ(System.Int32)"> + <summary> + Computes the Z data-value at the specified index + </summary> + <param name="j"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.GetRowAt(System.Int32)"> + <summary> + Returns the row at the specified Z Index + </summary> + <param name="zIndex"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.CopyFrom(SciChart.Data.Model.GridData{`1})"> + <summary> + Fills the BaseGridDataSeries3D from a <see cref="T:SciChart.Data.Model.GridData`1" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.CopyFrom(`1[][])"> + <summary> + Fills the BaseGridDataSeries3D from a two dimensional array. Assumes the array is rectangular + </summary> + <param name="innerArray">The inner array.</param> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.SetRowAt(System.Int32,`1[])"> + <summary> + Sets the row at the specified Z index + </summary> + <param name="zIndex">Index of the z.</param> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.PushRow(`1[])"> + <summary> + Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction + </summary> + <param name="row">The row.</param> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.IsDirty"> + <summary> + Gets or sets a value indicating whether this instance is dirty. If dirty, any cached data must be re-calculated. You can set this value = true to force recalculation of caches + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.InvalidOperationException">Expected TPointSeries generic constraint to be IGridPointSeries3D</exception> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.To2DArray"> + <summary> + Creates a new 2-Dimensional array and fills with values. This can be used for debugging purposes or for interop with other types. Changing the values here does *not* change the GridPointSeries3D + </summary> + <returns>The 2-Dimensional array representation of the GridPointSeries3D in Z,X orientation</returns> + </member> + <member name="M:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.OnIsHeightmapDirtyChanged"> + <summary> + Invoked right after Dirty State changed to indicated that the mesh is invalid. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.BaseGridDataSeries3D`3.CachedYRange"> + <summary> + Internal access to the cached YRange for testing. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IGridPointSeries3D"> + <summary> + Defines the interface to a GridPointSeries3D - the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.BaseGridDataSeries3D`3" /> + to a render-loop compatible collection + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IGridPointSeries3D.CountZ"> + <summary> + Gets the count in the I direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IGridPointSeries3D.CountX"> + <summary> + Gets the count in the J direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IGridPointSeries3D.Values"> + <summary> + Gets the raw, wrapped values as <see cref="T:SciChart.Charting3D.Model.IDoubleDoubleList" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.IGridPointSeries3D.GetX(System.Int32)"> + <summary> + Gets the X value at index j + </summary> + <param name="j">The j index.</param> + <returns>The X-value as double</returns> + </member> + <member name="M:SciChart.Charting3D.Model.IGridPointSeries3D.GetZ(System.Int32)"> + <summary> + Gets the Z value at index i + </summary> + <param name="i">The i index.</param> + <returns>The Z-value as double</returns> + </member> + <member name="T:SciChart.Charting3D.Model.GridPointSeries3D`3"> + <summary> + This contains the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.BaseGridDataSeries3D`3" /> + to a render-loop compatible collection + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.#ctor(SciChart.Charting3D.Model.BaseGridDataSeries3D{`0,`1,`2})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.GridPointSeries3D`3" /> class. + </summary> + <param name="dataSeries">The grid data series.</param> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.GridPointSeries3D`3.CountZ"> + <summary> + Gets the count in the I direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.GridPointSeries3D`3.CountX"> + <summary> + Gets the count in the J direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.GridPointSeries3D`3.Values"> + <summary> + Gets the raw, wrapped values as <see cref="T:SciChart.Charting3D.Model.IDoubleDoubleList" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.GetX(System.Int32)"> + <summary> + Gets the X value at index j + </summary> + <param name="j">The j index.</param> + <returns>The X-value as double</returns> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.GetZ(System.Int32)"> + <summary> + Gets the Z value at index i + </summary> + <param name="i">The i index.</param> + <returns>The Z-value as double</returns> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.GetXValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> X value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The X-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.GetYValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> Y value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The Y-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.GridPointSeries3D`3.GetZValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> Z value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The Z-value.</returns> + </member> + <member name="P:SciChart.Charting3D.Model.GridPointSeries3D`3.SyncRoot"> + <summary> + Gets the Synchronization object + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.GridPointSeries3D`3.IsDirty"> + <summary> + Gets or sets a value indicating whether the wrapped DataSeries is Dirty. This will be set to True when the DataSeries has changes, and must be set to False after creating a 3D mesh + </summary> + <remarks> + By setting this to FALSE after a mesh is created, you can cache meshes until the data changes again + </remarks> + </member> + <member name="T:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`1"> + <summary> + <para>The NonUniformGridDataSeries3D wraps a 2D array of type <typeparamref name="TAllPoints" /> which become the Y-values (heights) in various RenderableSeries</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> the Y-values map to the heights, whereas the + <see cref="!:NonUniformGridDataSeries3D<TX,TY,TZ>.StartX" />, <see cref="!:NonUniformGridDataSeries3D<TX,TY,TZ>.StepX" />, + <see cref="!:NonUniformGridDataSeries3D<TX,TY,TZ>.StartZ" />, <see cref="!:NonUniformGridDataSeries3D<TX,TY,TZ>.StepZ" /> defines the X and Z values</para> + </summary> + <typeparam name="TAllPoints">The X,Y,Z type.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`1.#ctor(System.Int32,System.Int32,System.Func{System.Int32,`0},System.Func{System.Int32,`0})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`1" /> class. + </summary> + <param name="xSize">Size in the X direction.</param> + <param name="zSize">Size in the Z direction.</param> + <param name="xMapping">Defines the grid mapping to X data range.</param> + <param name="zMapping">Defines the grid mapping to Y data range.</param> + </member> + <member name="T:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3"> + <summary> + <para>The NonUniformGridDataSeries3D wraps a 2D array of type <typeparamref name="TY" /> which become the Y-values (heights) in various RenderableSeries</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> the Y-values map to the heights, whereas the <see cref="!:StartX" />, <see cref="!:StepX" />, <see cref="!:StartZ" />, <see cref="!:StepZ" /> defines the X and Z values</para> + </summary> + <typeparam name="TX">The type of the x.</typeparam> + <typeparam name="TY">The type of the y.</typeparam> + <typeparam name="TZ">The type of the z.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3.#ctor(System.Int32,System.Int32,System.Func{System.Int32,`0},System.Func{System.Int32,`2})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3" /> class. + </summary> + <param name="xSize">Size in the X direction.</param> + <param name="zSize">Size in the Z direction.</param> + <param name="xMapping">Defines the grid mapping to X data range.</param> + <param name="zMapping">Defines the grid mapping to Y data range.</param> + </member> + <member name="P:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3.GetX(System.Int32)"> + <summary> + Computes the X data-value at the specified index + </summary> + <param name="i"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.NonUniformGridDataSeries3D`3.GetZ(System.Int32)"> + <summary> + Computes the Z data-value at the specified index + </summary> + <param name="j"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`1"> + <summary> + <para>The UniformGridDataSeries3D wraps a 2D array of type <typeparamref name="TAllPoints" /> which become the Y-values (heights) in various RenderableSeries</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> the Y-values map to the heights, whereas the + <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StartX" />, <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StepX" />, + <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StartZ" />, <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StepZ" /> defines the X and Z values</para> + </summary> + <typeparam name="TAllPoints">The X,Y,Z type.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.UniformGridDataSeries3D`1.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`1" /> class. + </summary> + <param name="xSize">Size in the X direction.</param> + <param name="zSize">Size in the Z direction.</param> + </member> + <member name="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`3"> + <summary> + <para>The UniformGridDataSeries3D wraps a 2D array of type <typeparamref name="TY" /> which become the Y-values (heights) in various RenderableSeries</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> the Y-values map to the heights, whereas the <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StartX" />, <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StepX" />, <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StartZ" />, <see cref="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StepZ" /> defines the X and Z values</para> + </summary> + <typeparam name="TX">The type of the x.</typeparam> + <typeparam name="TY">The type of the y.</typeparam> + <typeparam name="TZ">The type of the z.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`1" /> class. + </summary> + <param name="xSize">Size of the x.</param> + <param name="zSize">Size of the z.</param> + </member> + <member name="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StartX"> + <summary> + Gets the start X value, that is, the X data-value at this.InternalArray[0, z] + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StepX"> + <summary> + Gets the step-X value, that is, the data-value size between each element in the grid in the X-direction + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StartZ"> + <summary> + Gets the start Z value, that is, the Z data-value at this.InternalArray[x, 0] + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.StepZ"> + <summary> + Gets the step-Z value, that is, the data-value size between each element in the grid in the Z-direction + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.GetX(System.Int32)"> + <summary> + Computes the X data-value at the specified index + </summary> + <param name="i"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.UniformGridDataSeries3D`3.GetZ(System.Int32)"> + <summary> + Computes the Z data-value at the specified index + </summary> + <param name="j"></param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Model.HeightmapBasedDataSeries3DDirtyStates"> + <summary> + Enumerates possible dirty states of the Data Series 3D. + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.HeightmapBasedDataSeries3DDirtyStates.Clean"> + <summary> + Data Series is clean + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.HeightmapBasedDataSeries3DDirtyStates.Mesh"> + <summary> + 3D Mesh is dirty + </summary> + </member> + <member name="F:SciChart.Charting3D.Model.HeightmapBasedDataSeries3DDirtyStates.Heightmap"> + <summary> + Heightmap is dirty + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D"> + <summary> + Abstract base type for 3D Data Series, based on the Heightmap. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D.IsDirty"> + <summary> + Gets or sets a value indicating whether this instance is dirty. + If dirty, cached data must be re-calculated. You can set this value = true + to force recalculation of caches + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D.IsMeshDirty"> + <summary> + Gets or sets value determining whether the mesh is dirty. + If dirty, cached data must be re-calculated. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D.IsHeightmapDirty"> + <summary> + Gets or sets value determining whether the heightmap is dirty. + If dirty, cached data must be re-calculated. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D.SuspendUpdates(System.Boolean,System.Boolean)"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued. + </summary> + <param name="invalidateMesh">Determines whether mesh should be marked as dirty after resuming updates.</param> + <param name="invalidateHeightmap">Determines whether heightmap should be marked as dirty after resuming updates.</param> + <returns> + The disposable Update Suspender. + </returns> + </member> + <member name="M:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D.OnIsMeshDirtyChanged"> + <summary> + Invoked right after Dirty State changed to indicated that the mesh is invalid. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.HeightmapBasedDataSeries3D.OnIsHeightmapDirtyChanged"> + <summary> + Invoked right after Dirty State changed to indicated that the heightmap is invalid. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IDataSeries3D"> + <summary> + Defines the base interface to a DataSeries3D which provides a data-source for <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />. + </summary> + <seealso cref="T:SciChart.Charting3D.Model.DataSeries3D" /> + <seealso cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> + <seealso cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + <remarks>DataSeries are assigned to the RenderableSeries via the <see cref="P:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.DataSeries" /> property. Any time a DataSeries is appended to, the + parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> will be redrawn.</remarks> + </member> + <member name="E:SciChart.Charting3D.Model.IDataSeries3D.DataSeriesChanged"> + <summary> + Event raised whenever points are added to, removed or one or more DataSeries3D properties changes, requiring a redraw of the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDataSeries3D.SeriesName"> + <summary> + Gets or sets the name of this series. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDataSeries3D.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /> which this <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> instance is attached to. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDataSeries3D.XRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the X direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDataSeries3D.YRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Y direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDataSeries3D.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDataSeries3D.IsDirty"> + <summary> + Gets or sets a value indicating whether this instance is dirty. If dirty, any cached data must be re-calculated. You can set this value to <value>True</value> to force recalculation of caches. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.IDataSeries3D.OnDataSeriesChanged(SciChart.Charting.Model.DataSeries.DataSeriesUpdate,SciChart.Charting.Model.DataSeries.DataSeriesAction)"> + <summary> + Raises the <see cref="E:SciChart.Charting3D.Model.IDataSeries3D.DataSeriesChanged" /> event. May be called by DataSeries3D or by user code to trigger a redraw on the ParentSurface. The event is not raised while <see cref="P:SciChart.Core.Framework.ISuspendable.IsSuspended" /> is <value>True</value>. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.IDataSeries3D.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns>The PointSeries, which may be used for drawing</returns> + </member> + <member name="M:SciChart.Charting3D.Model.IDataSeries3D.Clear"> + <summary> + Clears the DataSeries. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.IDataSeries3D.GetBounds"> + <summary> + Gets the bounding box for the data (containing <see cref="P:SciChart.Charting3D.Model.IDataSeries3D.XRange" />, <see cref="P:SciChart.Charting3D.Model.IDataSeries3D.YRange" />, <see cref="P:SciChart.Charting3D.Model.IDataSeries3D.ZRange" />). + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IDoubleList"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting3D.Model.DoubleList`1" />: a class which wraps anarray of type T and allows conversion to double at index i,j + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDoubleList.Count"> + <summary> + Gets the of the inner array + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IDoubleList.Item(System.Int32)"> + <summary> + Gets and converts the i'th item to <see cref="T:System.Double" /></summary> + <param name="index">The index.</param> + <returns>The value at index i as <see cref="T:System.Double" /></returns> + </member> + <member name="M:SciChart.Charting3D.Model.IDoubleList.GetAsDoubles(System.Double[])"> + <summary> + Gets and converts the internal array as doubles, storing the value in outputArray + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.DoubleList`1"> + <summary> + A class which wraps an array of type T and allows conversion to double at index i + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DoubleList`1.#ctor(`0[],System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.DoubleList`1" /> class. + </summary> + <param name="inputArray">The input array.</param> + <param name="count">The count.</param> + </member> + <member name="P:SciChart.Charting3D.Model.DoubleList`1.Count"> + <summary> + Gets the of the inner array + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.DoubleList`1.Item(System.Int32)"> + <summary> + Gets the <see cref="T:System.Double" /> at the specified index. + </summary> + <value> + The <see cref="T:System.Double" />. + </value> + <param name="index">The index.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Model.DoubleList`1.GetAsDoubles(System.Double[])"> + <summary> + Gets and converts the internal array as doubles, storing the value in outputArray + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.DataSeries.IHitTestable3D"> + <summary> + Defines the base interface for a type which can be hit-tested + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.IHitTestable3D.GetXValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> X value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The X-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.IHitTestable3D.GetYValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> Y value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The Y-value.</returns> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.IHitTestable3D.GetZValue(System.Int32,System.Int32)"> + <summary> + Gets the <see cref="T:System.IComparable" /> Z value by indices. + </summary> + <param name="i">The i index.</param> + <param name="j">The j index.</param> + <returns>The Z-value.</returns> + </member> + <member name="T:SciChart.Charting3D.Model.DataSeries.Waterfall.IWaterfallDataSeries3D"> + <summary> + Defines the base interface to a <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3" />, the data source for the <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.IWaterfallDataSeries3D.SelectRows(System.Collections.Generic.IList{System.Int32},System.Boolean)"> + <summary> + Performs selection or deselection of data rows at specified <paramref name="zIndices" />. + </summary> + <param name="zIndices">The indices of row to select.</param> + <param name="isSelected">Value indicating whether select or deselect the rows.</param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.IWaterfallDataSeries3D.GetSelectedRows"> + <summary> + Returns a list of Z indices of selected data rows. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`1"> + <summary> + <para>The WaterfallDataSeries3D wraps a 2D array of type <typeparamref name="TAllPoints" /> which become the Y-values (heights) in various RenderableSeries.</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" /> the Y-values map to the heights of chart slices, whereas the <see cref="!:StartX" />, <see cref="!:StepX" />, <see cref="!:StartZ" />, <see cref="!:StepZ" /> defines the X and Z values.</para> + </summary> + <typeparam name="TAllPoints">The type of the X, Y, Z.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`1.#ctor(System.Int32,System.Int32)"> + <summary> + Creates an instance of a <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`1" />. + </summary> + <param name="xSize">The size of every data row.</param> + <param name="zSize">The amount of data rows.</param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`1.#ctor(System.Int32,`0[])"> + <summary> + Creates an instance of a <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`1" />. + </summary> + <param name="xSize">The size of every data row.</param> + <param name="zValues">These Z values define positions of every data row.</param> + </member> + <member name="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3"> + <summary> + <para>The WaterfallDataSeries3D wraps a 2D array of type <typeparamref name="TY" /> which become the Y-values (heights) in various RenderableSeries.</para> + <para>For instance, in the <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" /> the Y-values map to the heights of chart slices, whereas the <see cref="!:StartX" />, <see cref="!:StepX" />, <see cref="!:StartZ" />, <see cref="!:StepZ" /> defines the X and Z values.</para> + </summary> + <typeparam name="TX">The type of the x.</typeparam> + <typeparam name="TY">The type of the y.</typeparam> + <typeparam name="TZ">The type of the z.</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.#ctor(System.Int32,System.Int32)"> + <summary> + Creates an instance of a <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3" />. + </summary> + <param name="xSize">The size of every data row.</param> + <param name="zSize">The amount of data rows.</param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.#ctor(System.Int32,`2[])"> + <summary> + Creates an instance of a <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3" />. + </summary> + <param name="xSize">The size of every data row.</param> + <param name="zValues">These Z values define positions of every data row.</param> + </member> + <member name="P:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.ZRange"> + <summary> + Gets the total extents of the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> in the Z direction. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.GetZ(System.Int32)"> + <summary> + Returns the Z data-value at the specified index. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.Clear(System.Int32,System.Int32)"> + <summary> + Clears the <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3" />, resetting its X,Z size. + </summary> + <param name="xSize">The new XSize.</param> + <param name="zSize">The new ZSize.</param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.GetSelectedRows"> + <summary> + Returns a list of Z indices of selected data rows. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.PushRow(`2,`1[])"> + <summary> + Pushes a row into the array, which discards one old row in the First In First Out fashion. Use this method to scroll the Waterfall in the Z-direction. + </summary> + <param name="zValue">The new Z value.</param> + <param name="yValues">The new Y row.</param> + </member> + <member name="M:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3.SelectRows(System.Collections.Generic.IList{System.Int32},System.Boolean)"> + <summary> + Performs selection or deselection of data rows at specified <paramref name="zIndices" />. + </summary> + <param name="zIndices">The indices of row to select.</param> + <param name="isSelected">Value indicating whether select or deselect the rows.</param> + </member> + <member name="T:SciChart.Charting3D.Model.IPointSeries3D"> + <summary> + A Placeholder interface for PointSeries - the result of resampling or conversion from DataSeries to a render-loop compatible collection + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IPointSeries3D.SyncRoot"> + <summary> + Gets the Synchronization object + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IPointSeries3D.IsDirty"> + <summary> + Gets or sets a value indicating whether the wrapped DataSeries is Dirty. This will be set to True when the DataSeries has changes, and must be set to False after creating a 3D mesh + </summary> + <remarks> + By setting this to FALSE after a mesh is created, you can cache meshes until the data changes again + </remarks> + </member> + <member name="T:SciChart.Charting3D.Model.IPointMetadata3D"> + <summary> + Provides the interface for metadata for 3D vertices. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IPointMetadata3D.Parent"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IPointMetadata3D.IsSelected"> + <summary> + Gets or sets a value indicating whether this data-point is selected. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IPointMetadata3D.VertexColor"> + <summary> + Gets or sets the overridden VertexColor for this point. Defaults to null (which means use default color provided by the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IPointMetadata3D.PointScale"> + <summary> + Gets or sets the custom scaling for this point. Defaults to 1.0. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.PointMetadata3D"> + <summary> + A metadata class for 3D vertices. Implements <see cref="T:System.ComponentModel.INotifyPropertyChanged" />. Stores scale, color, IsSelected and a user-defined object (tag) + </summary> + </member> + <member name="E:SciChart.Charting3D.Model.PointMetadata3D.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.PointMetadata3D.#ctor(System.Nullable{System.Windows.Media.Color},System.Single,System.Boolean,System.Object)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.PointMetadata3D" /> class. + </summary> + <param name="vertexColor">Color of the vertex.</param> + <param name="pointScale">The point scale.</param> + <param name="isSelected">if set to <c>true</c> [is selected].</param> + <param name="tag">The tag.</param> + </member> + <member name="P:SciChart.Charting3D.Model.PointMetadata3D.Parent"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.PointMetadata3D.PointScale"> + <summary> + Gets or sets the custom scaling for this point. Defaults to 1.0 + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.PointMetadata3D.VertexColor"> + <summary> + Gets or sets the overridden VertexColor for this point. Defaults to null (which means use default color provided by the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.PointMetadata3D.IsSelected"> + <summary> + Gets or sets a value indicating whether this data-point is selected. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.PointMetadata3D.Tag"> + <summary> + Gets or sets a custom object or Tag. You can pass through your own Tags to PointMetadata3D and use it + in <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" />, or tooltips or selection callbacks + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.PointMetadata3D.OnPropertyChanged(System.String)"> + <summary> + Raises the <see cref="E:SciChart.Charting3D.Model.PointMetadata3D.PropertyChanged" /> event + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="M:SciChart.Charting3D.Model.PointMetadata3D.OnParentDataSeriesChanged(SciChart.Charting.Model.DataSeries.DataSeriesUpdate,SciChart.Charting.Model.DataSeries.DataSeriesAction)"> + <summary> + Called when the parent data-series changes + </summary> + <param name="dsUpdate">The type of update.</param> + <param name="dsAction"></param> + </member> + <member name="T:SciChart.Charting3D.Model.XyzDataPointViewModel`1"> + <summary> + Provides a ViewModel for an XYZ Data-point to assist binding in tooltips and data-point selection + </summary> + <typeparam name="TAllPoints">The TX,TY and TZ type of the data</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataPointViewModel`1.#ctor(System.Int32,`0,`0,`0,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.XyzDataPointViewModel`1" /> class. + </summary> + <param name="index">The index.</param> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + <param name="pointMetadata3D">The point metadata3 d.</param> + </member> + <member name="T:SciChart.Charting3D.Model.XyzDataPointViewModel`3"> + <summary> + Provides a ViewModel for an XYZ Data-point to assist binding in tooltips and data-point selection + </summary> + <typeparam name="TX">The TX type of the data</typeparam> + <typeparam name="TY">The TY type of the data</typeparam> + <typeparam name="TZ">The TZ type of the data</typeparam> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataPointViewModel`3.#ctor(System.Int32,`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.XyzDataPointViewModel`3" /> class. + </summary> + <param name="index">The index.</param> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + <param name="pointMetadata3D">The point metadata3 d.</param> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataPointViewModel`3.Index"> + <summary> + Gets or sets the index to the data + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataPointViewModel`3.X"> + <summary> + Gets or sets the x value + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataPointViewModel`3.Y"> + <summary> + Gets or sets the y value + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataPointViewModel`3.Z"> + <summary> + Gets or sets the z value + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataPointViewModel`3.PointMetadata3D"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.Model.XyzDataPointViewModel`3.PointMetadata3D" /></summary> + </member> + <member name="T:SciChart.Charting3D.Model.IXyzDataSeries3D"> + <summary> + Defines the index to an <see cref="T:SciChart.Charting3D.Model.XyzDataSeries3D`3" />, a <see cref="T:SciChart.Charting3D.Model.DataSeries3D" /> derived type which is a stream of X,Y,Z values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzDataSeries3D.Count"> + <summary> + Gets the count of the IXyzDataSeries3D + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D.PerformSelection(System.Boolean,System.Collections.Generic.IList{System.Int32})"> + <summary> + Performs selection on the provided indices. If indices == null applies the flag to all data-points, else, applies the flag just to the defined data-points + </summary> + <param name="isSelected"></param> + <param name="indices"></param> + </member> + <member name="T:SciChart.Charting3D.Model.IXyzDataSeries3D`3"> + <summary> + Defines the index to an <see cref="T:SciChart.Charting3D.Model.XyzDataSeries3D`3" />, a <see cref="T:SciChart.Charting3D.Model.DataSeries3D" /> derived type which is a stream of X,Y,Z values + </summary> + <typeparam name="TX">The type of the x.</typeparam> + <typeparam name="TY">The type of the y.</typeparam> + <typeparam name="TZ">The type of the z.</typeparam> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzDataSeries3D`3.XValues"> + <summary> + Gets the Z values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzDataSeries3D`3.YValues"> + <summary> + Gets the Y values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzDataSeries3D`3.ZValues"> + <summary> + Gets the Z values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzDataSeries3D`3.WValues"> + <summary> + Gets the W values, which are optional point-metadatas per Xyzw point + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.Append(`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw + </summary> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw + </summary> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + /// <param name="w">The W-values, which contain metadata about the point</param></member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.Update(System.Int32,`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified X-value. Automatically triggers a redraw + </summary> + <param name="index">The Index to update</param> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.Insert(System.Int32,`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Inserts an X, Y, Z point at the specified index. Automatically triggers a redraw + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Inserts a collection of X, Y and Z points at the specified index, automatically triggering a redraw + </summary> + <param name="startIndex">The index to insert at</param> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + <param name="w">The W-values, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y,Z values at the specified index + </summary> + <param name="index">The index to remove at</param> + </member> + <member name="M:SciChart.Charting3D.Model.IXyzDataSeries3D`3.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index + </summary> + <param name="startIndex">Starting index of the range of elements to remove</param> + <param name="count">The number of elements to remove</param> + </member> + <member name="T:SciChart.Charting3D.Model.XyzDataSeries3D`1"> + <summary> + An XyzDataSeries3D is a <see cref="T:SciChart.Charting3D.Model.DataSeries3D" /> type which provides a stream of X,Y,Z points of type <typeparamref name="TAllPoints" /></summary> + <typeparam name="TAllPoints">The type of all points.</typeparam> + </member> + <member name="T:SciChart.Charting3D.Model.XyzDataSeries3D`3"> + <summary> + An XyzDataSeries3D is a <see cref="T:SciChart.Charting3D.Model.DataSeries3D" /> type which provides a stream of X,Y,Z points of type <typeparamref name="TX" />, <typeparamref name="TY" />, <typeparamref name="TZ" /></summary> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Model.XyzDataSeries3D`3" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.XRange"> + <summary> + Gets the computed XRange, which is an <see cref="T:SciChart.Data.Model.IRange" /></summary> + <remarks>Note: The performance implications of calling this is the XyzDataSeries3D will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.YRange"> + <summary> + Gets the computed YRange, which is an <see cref="T:SciChart.Data.Model.IRange" /></summary> + <remarks>Note: The performance implications of calling this is the XyzDataSeries3D will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.ZRange"> + <summary> + Gets the computed ZRange, which is an <see cref="T:SciChart.Data.Model.IRange" /></summary> + <remarks>Note: The performance implications of calling this is the XyzDataSeries3D will perform a full recalculation on each get. It is recommended to get and cache if this property is needed more than once</remarks> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.XValues"> + <summary> + Gets the Z values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.YValues"> + <summary> + Gets the Y values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.ZValues"> + <summary> + Gets the Z values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.WValues"> + <summary> + Gets the W values + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.Count"> + <summary> + Gets the count of the IXyzDataSeries3D + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.IsDirty"> + <summary> + Gets or sets a value indicating whether this instance is dirty. If dirty, any cached data must be re-calculated. You can set this value to <value>True</value> to force recalculation of caches. + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.Append(`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Appends a single X, Y0, Y1 point to the series, automatically triggering a redraw + </summary> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.Append(System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Appends a collection of X, Y0 and Y1 points to the series, automatically triggering a redraw + </summary> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.Update(System.Int32,`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Updates (overwrites) the Y0, Y1 values at the specified X-value. Automatically triggers a redraw + </summary> + <param name="index">The Index to update</param> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.Insert(System.Int32,`0,`1,`2,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Inserts an X, Y, Z point at the specified index. Automatically triggers a redraw + </summary> + <param name="index">The index to insert at</param> + <param name="x">The X-value</param> + <param name="y">The Y-value</param> + <param name="z">The Z-value</param> + <param name="w">The W-value, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0},System.Collections.Generic.IEnumerable{`1},System.Collections.Generic.IEnumerable{`2},System.Collections.Generic.IEnumerable{SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Inserts a collection of X, Y and Z points at the specified index, automatically triggering a redraw + </summary> + <param name="startIndex">The index to insert at</param> + <param name="x">The X-values</param> + <param name="y">The Y-values</param> + <param name="z">The Z-values</param> + <param name="w">The W-values, which contains metadata about the point</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.RemoveAt(System.Int32)"> + <summary> + Removes the X,Y,Z values at the specified index + </summary> + <param name="index">The index to remove at</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of points starting from the specified index + </summary> + <param name="startIndex">Starting index of the range of elements to remove</param> + <param name="count">The number of elements to remove</param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.ToPointSeries``1"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <typeparam name="TPointSeries">The type of <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /></typeparam> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.Clear"> + <summary> + Clears the DataSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.PerformSelection(System.Boolean,System.Collections.Generic.IList{System.Int32})"> + <summary> + Performs selection on the provided indices. If indices == null applies the flag to all data-points, else, applies the flag just to the defined data-points + </summary> + <param name="isSelected"></param> + <param name="indices"></param> + </member> + <member name="M:SciChart.Charting3D.Model.XyzDataSeries3D`3.AppendMetadata(SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Appends a single metadata value to the end of the <see cref="P:SciChart.Charting3D.Model.XyzDataSeries3D`3.WValues" /> list. + </summary> + </member> + <member name="T:SciChart.Charting3D.Model.IXyzPointSeries3D"> + <summary> + Defines the interface to a XyzPointSeries3D - the result of resampling or conversion from <see cref="T:SciChart.Charting3D.Model.XyzDataSeries3D`3" /> + to a render-loop compatible collection + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzPointSeries3D.Count"> + <summary> + Gets the count of the point series + </summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzPointSeries3D.XValues"> + <summary> + Gets the underlying raw X values wrapped in a <see cref="T:SciChart.Charting3D.Model.IDoubleList" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzPointSeries3D.YValues"> + <summary> + Gets the underlying raw Y values wrapped in a <see cref="T:SciChart.Charting3D.Model.IDoubleList" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzPointSeries3D.ZValues"> + <summary> + Gets the underlying raw Z values wrapped in a <see cref="T:SciChart.Charting3D.Model.IDoubleList" /></summary> + </member> + <member name="P:SciChart.Charting3D.Model.IXyzPointSeries3D.WValues"> + <summary> + Gets the underlying raw <see cref="T:SciChart.Charting3D.Model.PointMetadata3D" /> values + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting3D.Model.ChartSeries.BaseRenderableSeries3DViewModel" />, a viewmodel to a renderable series, which is used in the new <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> MVVM API. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + <value>The color of the series.</value> + </member> + <member name="P:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel.IsSelected"> + <summary> + Gets or sets whether the series is selected. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel.DataSeries"> + <summary> + Gets or sets the DataSeries associated with this series + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel.PaletteProvider"> + <summary> + Gets or Sets an optional <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance, which may be used to override specific data-point colors during rendering. + For more details, see the <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> documentation + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel.PointMarker"> + <summary> + Gets or sets the point marker which may be rendered at points on the 3D series. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.RenderableSeries3DSourceCollection"> + <summary> + Contains a collection of RenderableSeries and associated RenderableSeriesViewModels + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.RenderableSeries3DSourceCollection.#ctor(System.Collections.Generic.IEnumerable{SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.RenderableSeries3DSourceCollection" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurface.DisplacementValueCalc"> + <summary> + Encapsulates logic of displacement value and axes propagation vector encoding. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurface.DisplacementValueCalc.GetCoordinate(System.Double)"> + <summary> + Calculates displacement value in the coordinate space. + </summary> + <param name="value">Displacement value to in the date coordinate space.</param> + <returns>Calculated displacement value in the coordinate space.</returns> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurface.DisplacementValueCalc.GetAxesPropagation(System.Double@,System.Double@,System.Double@)"> + <summary> + Gets displacement propagation value for each axes. + </summary> + <param name="xAxisPropagation">Displacement propagation value for X axis.</param> + <param name="yAxisPropagation">Displacement propagation value for Y axis.</param> + <param name="zAxisPropagation">Displacement propagation value for Z axis.</param> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.Impulse.ImpulseUniformGridSceneEntityHelper"> + <summary> + A class for a <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity" /> which uses <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`3" /> data as input, and transforms + into scene geometry + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Impulse.ImpulseUniformGridSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Impulse.ImpulseUniformGridSceneEntityHelper.GetDataValues(SciChart.Charting3D.Model.IPointSeries3D,System.Collections.Generic.List{SciChart.Charting3D.Model.PointMetadata3D}@)"> + <summary> + Transforms data from an IPointSeries3D into a list of data-values (Vector3D) and PointMetadata3D. Used to create the mesh + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Impulse.ImpulseUniformGridSceneEntityHelper.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.ColumnRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.ColumnRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.ColumnRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.ImpulseRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.ImpulseRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.ImpulseRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.MountainRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.MountainRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.MountainRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.MountainRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.PointLineRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.PointLineRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.PointLineRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.ScatterRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.ScatterRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.ScatterRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.SurfaceMeshRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.SurfaceMeshRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.SurfaceMeshRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.SurfaceMeshRenderableSeries3DForMvvm.OnColorPaletteChanged(System.Object,System.EventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.RenderableSeries.MeshColorPalette" /> property changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.WaterfallRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.WaterfallRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.WaterfallRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurfaceRenderableSeries3DForMvvm"> + <summary> + Defines a class which extends the original <see cref="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D" /> and is created internally + per every <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.IRenderableSeries3DViewModel" /> of appropriate type in MVVM scenarios + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurfaceRenderableSeries3DForMvvm.#ctor"> + <summary> + Initializes a new instance of the <seealso cref="T:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurfaceRenderableSeries3DForMvvm" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.FreeSurfaceRenderableSeries3DForMvvm.OnColorPaletteChanged(System.Object,System.EventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.RenderableSeries.MeshColorPalette" /> property changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.MountainSceneEntity.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity"> + <summary> + SceneEntity added to the 3D Scene which draws a Waterfall Chart. See also the <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D)"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity" /> instance for a <paramref name="renderableSeries" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.HeightmapData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi"></param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity.PerformSelection(System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection on this entity, setting the IsSelected flag to True or False on the specified <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="isSelected">if set to <c>true</c> the vertices become .</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntity.GetDataGridIndex(System.UInt32)"> + <summary> + Returns a <see cref="T:SciChart.Charting3D.Primitives.HeightMapIndex" /> that corresponds to <param name="vertexId" />. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntityHelper"> + <summary> + A base class for a <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" /> which uses <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`3" /> data as input, and transforms + into scene geometry. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.HeightmapData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntityHelper.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.RenderableSeries.Waterfall.WaterfallSceneEntityHelper.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,System.Windows.Media.Media3D.Vector3D},System.Func{System.Windows.Media.Media3D.Vector3D,SciChart.Charting3D.Vector3},System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.AxisLabels.XyAxisPlane"> + <summary> + Defines the DrawLabelsMode for XY axis plane on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.AxisLabels.XyAxisPlane.DrawLabelsModeProperty"> + <summary> + Defines the DrawLabelsMode attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.AxisLabels.XyAxisPlane.SetDrawLabelsMode(System.Windows.DependencyObject,SciChart.Charting3D.Interop.eAxisPlaneDrawLabelsMode)"> + <summary> + Sets the DrawLabelsMode attached property + </summary> + <param name="element">The element.</param> + <param name="value">The value.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.AxisLabels.XyAxisPlane.GetDrawLabelsMode(System.Windows.DependencyObject)"> + <summary> + Gets the DrawLabelsMode attached property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Visuals.AxisLabels.ZxAxisPlane"> + <summary> + Defines the DrawLabelsMode for ZX axis plane on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.AxisLabels.ZxAxisPlane.DrawLabelsModeProperty"> + <summary> + Defines the DrawLabelsMode attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.AxisLabels.ZxAxisPlane.SetDrawLabelsMode(System.Windows.DependencyObject,SciChart.Charting3D.Interop.eAxisPlaneDrawLabelsMode)"> + <summary> + Sets the DrawLabelsMode attached property + </summary> + <param name="element">The element.</param> + <param name="value">The value.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.AxisLabels.ZxAxisPlane.GetDrawLabelsMode(System.Windows.DependencyObject)"> + <summary> + Gets the DrawLabelsMode attached property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Visuals.AxisLabels.ZyAxisPlane"> + <summary> + Defines the DrawLabelsMode for ZY axis plane on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.AxisLabels.ZyAxisPlane.DrawLabelsModeProperty"> + <summary> + Defines the DrawLabelsMode attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.AxisLabels.ZyAxisPlane.SetDrawLabelsMode(System.Windows.DependencyObject,SciChart.Charting3D.Interop.eAxisPlaneDrawLabelsMode)"> + <summary> + Sets the DrawLabelsMode attached property + </summary> + <param name="element">The element.</param> + <param name="value">The value.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.AxisLabels.ZyAxisPlane.GetDrawLabelsMode(System.Windows.DependencyObject)"> + <summary> + Gets the DrawLabelsMode attached property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Visuals.Object.ObjectCoordinateMode"> + <summary> + Enumeration constants to define the Coordinate mode used to place an object model. + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectCoordinateMode.WorldCoordinates"> + <summary> + WorldCoordinates, requires that coordinates X, Y, Z are world coordinates. + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectCoordinateMode.DataCoordinates"> + <summary> + DataCoordinates, requires that coordinates X, Y, Z are data-values. + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectCoordinateMode.Relative"> + <summary> + Relative, requires that coordinates X, Y, Z are double values between 0.0 and 1.0. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.Object.Rotation3D"> + <summary> + A class which have parameters for 3D rotation. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.Rotation3D.Axis"> + <summary> + Gets or Sets the 3D axis of rotation direction X, Y or Z. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.Rotation3D.Angle"> + <summary> + Gets or Sets rotation angle. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.Object.ObjectModelSource"> + <summary> + A class which allows loading and converts to bites *.obj model file or object model file <see cref="T:System.IO.Stream" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModelSource.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModelSource" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModelSource.#ctor(System.IO.Stream)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModelSource" /> class and specified the object model file <see cref="T:System.IO.Stream" />. <see cref="T:System.IO.Stream" /> will be closed automatically. + </summary> + <param name="streamSource">The object model file <see cref="T:System.IO.Stream" /></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModelSource.#ctor(System.Uri)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModelSource" /> class and specified the <see cref="T:System.Uri" /> source of the object model file. + </summary> + <param name="source">The <see cref="T:System.Uri" /> source of the object model file</param> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModelSource.Source"> + <summary> + Gets or sets the <see cref="T:System.Uri" /> source of the object model file. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModelSource.StreamSource"> + <summary> + Sets the <see cref="T:System.IO.Stream" /> of the object model file. <see cref="T:System.IO.Stream" /> will be closed automatically. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.Object.TextureSource"> + <summary> + A class which allows loading *.jpg, *.png texture file or texture file <see cref="T:System.IO.Stream" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.TextureSource.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.TextureSource" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.TextureSource.#ctor(System.IO.Stream)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.TextureSource" /> class using the specified texture file <see cref="T:System.IO.Stream" />. <see cref="T:System.IO.Stream" /> will be closed automatically. + </summary> + <param name="streamSource">The texture file <see cref="T:System.IO.Stream" /></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.TextureSource.#ctor(System.Uri)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.TextureSource" /> class using the specified <see cref="T:System.Uri" /> source of the *.jpg, *.png texture file. + </summary> + <param name="source">The object model <see cref="T:System.Uri" /> source file</param> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.TextureSource.StreamSource"> + <summary> + Sets the <see cref="T:System.IO.Stream" /> of the *.jpg, *.png texture file. <see cref="T:System.IO.Stream" /> will be closed automatically. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.TextureSource.Source"> + <summary> + Gets or sets the <see cref="T:System.Uri" /> source of the object model file. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.Object.ObjectModel3D"> + <summary> + Defines the class for object model within SciChart3D. + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.PositionProperty"> + <summary> + Defines the Position dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.ScaleProperty"> + <summary> + Defines the Scale dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.DrawBoundingBoxProperty"> + <summary> + Defines the DrawBoundingBox dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.BoundingBoxStrokeThicknessProperty"> + <summary> + Defines the BoundingBoxStrokeThickness dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.BoundingBoxStrokeProperty"> + <summary> + Defines the BoundingBoxStroke dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.SourceProperty"> + <summary> + Defines the Source dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.CoordinateModeProperty"> + <summary> + Defines the CoordinateMode dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.RotationProperty"> + <summary> + Defines the Rotation dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.TextureSourceProperty"> + <summary> + Defines the TextureSource dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjectModel3D.DiffuseColorProperty"> + <summary> + Defines the DiffuseColor dependency property + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModel3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.#ctor(System.Uri,System.Windows.Media.Color)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModel3D" /> class using the specified object model <see cref="T:System.Uri" /> source and diffuse model color. + </summary> + <param name="modelSource">The object model <see cref="T:System.Uri" /> source file</param> + <param name="diffuseColor">The diffuse model color</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.#ctor(System.IO.Stream,System.Windows.Media.Color)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModel3D" /> class using the specified texture file <see cref="T:System.IO.Stream" />. <see cref="T:System.IO.Stream" /> will be closed automatically. + </summary> + <param name="modelStreamSource">The object model file <see cref="T:System.IO.Stream" />. <see cref="T:System.IO.Stream" /> will be closed automatically.</param> + <param name="diffuseColor">The diffuse model color</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.#ctor(System.Uri,System.Uri)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModel3D" /> class using the specified object model <see cref="T:System.Uri" /> source file and texture <see cref="T:System.Uri" /> source file. + </summary> + <param name="modelSource">The object model <see cref="T:System.Uri" /> source file</param> + <param name="textureSource">The texture <see cref="T:System.Uri" /> source file</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.#ctor(System.IO.Stream,System.IO.Stream)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModel3D" /> class using the specified texture file <see cref="T:System.IO.Stream" /> and texture file <see cref="T:System.IO.Stream" />. All Streams will be closed automatically. + </summary> + <param name="modelStreamSource">The object model file <see cref="T:System.IO.Stream" />. <see cref="T:System.IO.Stream" /> will be closed automatically.</param> + <param name="textureStreamSource">The texture file <see cref="T:System.IO.Stream" />. <see cref="T:System.IO.Stream" /> will be closed automatically.</param> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.BoundingBoxStroke"> + <summary> + Gets or sets the <see cref="T:System.Windows.Media.Color" /> of the bounding model box. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.DiffuseColor"> + <summary> + Gets or sets the diffuse <see cref="T:System.Windows.Media.Color" /> of the object model + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.TextureSource"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.TextureSource" /> to use when setting texture source for object model. It allows loading *.jpg, *.png texture file or texture file <see cref="T:System.IO.Stream" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.CoordinateMode"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectCoordinateMode" /> to use when placing the object model. E.g. the default of DataCoordinates requires that X,Y,Z coordinates are data-values. The value + of Relative requires that X,Y,Z are double values from 0.0 to 1.0. And the WorldCoonrdinates value requires that X,Y,Z are double values world coordinates. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.Rotation"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Visuals.Object.Rotation3D" /> parameters for object model rotation. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.Source"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Visuals.Object.ObjectModelSource" /> to use when setting object model source. It allows loading *.jpg, *.png texture file or texture file <see cref="T:System.IO.Stream" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.BoundingBoxStrokeThickness"> + <summary> + Gets or sets the bounding box lines thickness. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.DrawBoundingBox"> + <summary> + Gets or sets a value indicating whether to draw bounding box or not. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.Scale"> + <summary> + Gets or sets the scale factor of the object model. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.Position"> + <summary> + Gets ot sets the position of the object model. + </summary> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.IsAttached"> + <summary> + Gets or sets whether this Element is attached to a parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <value> + <c>true</c> if this instance is attached; otherwise, <c>false</c>.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Visuals.Object.ObjectModel3D.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> to perform operations on + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.LoadObjectModel(System.IO.Stream)"> + <summary> + Load the object model. + </summary> + <param name="streamSource">Object model file <see cref="T:System.IO.Stream" /></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.LoadObjectModel(System.Uri)"> + <summary> + Load the object model. + </summary> + <param name="uriSource">Object model file <see cref="T:System.Uri" /></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.LoadTexture(System.IO.Stream)"> + <summary> + Load the object model texture. + </summary> + <param name="streamSource">Object model texture file <see cref="T:System.IO.Stream" /></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Object.ObjectModel3D.LoadTexture(System.Uri)"> + <summary> + Load the object model texture. + </summary> + <param name="uriSource">Object model texture file <see cref="T:System.Uri"></see></param> + </member> + <member name="T:SciChart.Charting3D.Visuals.Object.ObjSceneEntity"> + <summary> + A class which allows loading of Wavefront *.obj files into the 3D Scene + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjSceneEntity._xCalc"> + <summary> + The XAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" />, which converts pixel to world coordinates. + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjSceneEntity._yCalc"> + <summary> + The YAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" />, which converts pixel to world coordinates. + </summary> + </member> + <member name="F:SciChart.Charting3D.Visuals.Object.ObjSceneEntity._zCalc"> + <summary> + The ZAxis <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" />, which converts pixel to world coordinates. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.Primitives.Font3DStyle"> + <summary> + Enumerates possible styles of the 3D font. + </summary> + </member> + <member name="T:SciChart.Charting3D.Visuals.Primitives.Font3D"> + <summary> + Defines the wrapper for the the <see cref="T:SciChart.Charting3D.Interop.TSRFont" /> class from the c++, which provide text drawing functionality + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.#ctor(System.String,System.UInt32,SciChart.Charting3D.Visuals.Primitives.Font3DStyle)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Visuals.Primitives.Font3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.Begin"> + <summary> + Begins creating the text on the 3D surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.BeginBillboard(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Begins creating the text on the 3D surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.BeginScreenSpace(System.Single,System.Single,System.Single)"> + <summary> + Begins creating the text on the 3D surface + </summary> + <param name="rotationAngle"></param> + <param name="f"></param> + <param name="f1"></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.End"> + <summary> + Ends creating the text and draws it on the 3D surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.EndScreenSpace"> + <summary> + Ends creating the text and draws it on the 3D surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.AddText(System.String,System.Windows.Media.Color,System.Single,System.Single,System.Single)"> + <summary> + Adds text which will be rendered after <see cref="M:SciChart.Charting3D.Visuals.Primitives.Font3D.End" /> method was called + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.Font3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="T:SciChart.Charting3D.Visuals.Primitives.ISolidMesh"> + <summary> + Defines the interface to a SolidMesh, a re-usable 3D model consisting of triangles which may be dynamically created, frozen, and repeatedly drawn. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.ISolidMesh.SetTextureCoord(System.Single,System.Single)"> + <summary> + Sets texture coordinates for the current vertex. + </summary> + <param name="u"></param> + <param name="v"></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.ISolidMesh.SetTexture(SciChart.Charting3D.Texture2D)"> + <summary> + Sets a <see cref="T:SciChart.Charting3D.Texture2D" /> to render on the current mesh. + </summary> + <param name="texture">A texture to be rendered.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.ISolidMesh.SetVertex3(SciChart.Charting3D.Vector3)"> + <summary> + Sets a position of the current vertex. + </summary> + <param name="xyzVector">The <see cref="T:SciChart.Charting3D.Vector3" /> which defines the position.</param> + </member> + <member name="T:SciChart.Charting3D.Visuals.Primitives.SolidMesh"> + <summary> + Defines a re-usable 3D model consisting of triangles which may be dynamically created, frozen, and repeatedly drawn. + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.#ctor(System.Boolean)"> + <summary> + Creates an instance of a <see cref="T:SciChart.Charting3D.Visuals.Primitives.SolidMesh" />. + </summary> + <param name="isTriangleStrips"></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetOpacity(System.Single)"> + <summary> + Sets the opacity for the current vertex. + </summary> + <param name="opacity">The opacity.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex. + </summary> + <param name="color">The color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetVertexColor(System.UInt32)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="colorArgb">32-bit representation of ARGB color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetTextureCoord(System.Single,System.Single)"> + <summary> + Sets texture coordinates for the current vertex. + </summary> + <param name="u"></param> + <param name="v"></param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetVertex4(System.Single,System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z,W value of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + <param name="w">The w parameter, often the size.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetVertex3(SciChart.Charting3D.Vector3)"> + <summary> + Sets a position of the current vertex. + </summary> + <param name="xyzVector">The <see cref="T:SciChart.Charting3D.Vector3" /> which defines the position.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetVertex3(System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z position of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.Freeze"> + <summary> + Freezes this instance. No further drawing may be done + </summary> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetTexture(SciChart.Charting3D.Texture2D)"> + <summary> + Sets a <see cref="T:SciChart.Charting3D.Texture2D" /> to render on the current mesh. + </summary> + <param name="texture">A texture to be rendered.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.Draw"> + <summary> + Draws this instance. + </summary> + <exception cref="T:System.InvalidOperationException">Must call ImmediatePointsContext.Freeze() to complete the vertices before calling Draw()</exception> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.Draw(SciChart.Charting3D.Interop.TSRShaderEffect)"> + <summary> + Draws this instance. + </summary> + <exception cref="T:System.InvalidOperationException">Must call ImmediatePointsContext.Freeze() to complete the vertices before calling Draw()</exception> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.SetSelectionId(System.UInt64)"> + <summary> + Sets the selection identifier for the current vertex. + </summary> + <param name="selectionId">The selection identifier.</param> + </member> + <member name="M:SciChart.Charting3D.Visuals.Primitives.SolidMesh.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.ApiElementBase3D"> + <summary> + Base class to expose properties and methods for <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> derived types + </summary> + </member> + <member name="E:SciChart.Charting3D.Modifiers.ApiElementBase3D.PropertyChanged"> + <summary> + Occurs when a property changes in the <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to perform operations on + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.XAxis"> + <summary> + Returns the XAxis on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.YAxis"> + <summary> + Returns the YAxes on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.ZAxis"> + <summary> + Returns the ZAxis on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" />, <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.ModifierSurface"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IChartModifierSurface" /> instance on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, which acts as a canvas to place UIElements + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.IsAttached"> + <summary> + Gets or sets whether this Element is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <value> + <c>true</c> if this instance is attached; otherwise, <c>false</c>.</value> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ApiElementBase3D.RootGrid"> + <summary> + Gets the <see cref="T:SciChart.Charting.Visuals.IMainGrid" /> which is the root component for the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />, + containing the XAxis, YAxes, ModifierSurface, RenderSurface and GridLinesPanel + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ApiElementBase3D.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ApiElementBase3D.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ApiElementBase3D.OnInvalidateParentSurface"> + <summary> + Raises the <see cref="T:SciChart.Charting.Utility.InvalidateSciChartMessage" /> which causes the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> to invalidate + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ApiElementBase3D.GetAndAssertTemplateChild``1(System.String)"> + <summary> + Gets the TemplateChild by the specified name and casts to type <typeparamref name="T" />, asserting that the result is not null + </summary> + <typeparam name="T">The Type of the templated part</typeparam> + <param name="childName">Name of the templated part.</param> + <returns>The template part instance</returns> + <exception cref="T:System.InvalidOperationException">Unable to Apply the Control Template. Child is missing or of the wrong type</exception> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ApiElementBase3D.OnPropertyChanged(System.String)"> + <summary> + Raises the PropertyChanged event, as part of <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> implementation + </summary> + <param name="propertyName">Name of the property.</param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D"> + <summary> + Defines the base class to a Chart Modifier, which can be used to extend the interactivity or rendering of the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <seealso cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ReceiveHandledEventsProperty"> + <summary> + Defines the ReceiveHandledEvents DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsEnabledProperty"> + <summary> + Defines the IsEnabled Attached Property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ExecuteOnProperty"> + <summary> + Defines the ExecuteOn DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ExecuteWhenProperty"> + <summary> + Defines the ExecuteWhen DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsEnabled"> + <summary> + Gets or sets a value indicating whether this element is enabled in the user interface (UI). + </summary> + <returns>true if the element is enabled; otherwise, false. The default value is true.</returns> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ExecuteOn"> + <summary> + Determines when the <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> executes, + e.g. <see cref="F:SciChart.Charting.ChartModifiers.ExecuteOn.MouseDoubleClick" /> will cause the modifier to execute on mouse double click + click of the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ExecuteWhen"> + <summary> + Determines which keyboard modifiers filter when the <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> executes, + e.g. <see cref="F:SciChart.Core.Utility.Mouse.MouseModifier.Shift" /> will cause the modifier to only work if SHIFT is pressed + when the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> is focussed + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ReceiveHandledEvents"> + <summary> + Gets or sets a value, indicates whether current modifier handles events + which have already been marked as handled + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsMouseLeftButtonDown"> + <summary> + Gets if the Left mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsMouseMiddleButtonDown"> + <summary> + Gets if the Middle mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsMouseRightButtonDown"> + <summary> + Gets of the right mouse button is currently down + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.Viewport3D"> + <summary> + Gets the Viewport3D - which is the 3D DirectX viewport used to render the scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.RootEntity"> + <summary> + Gets the root <see cref="T:SciChart.Charting3D.SciChart3DRootSceneEntity" />, which is the root node for the entire 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsDragging"> + <summary> + Gets whether the user is currently dragging the chart + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup"> + <summary> + Gets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ModifierName"> + <summary> + Gets modifier name + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.CaptureMouse"> + <summary> + Attempts to force capture of the mouse to this element. + </summary> + <returns> + true if the mouse is successfully captured; otherwise, false. + </returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ReleaseMouseCapture"> + <summary> + Releases the mouse capture, if this element held the capture. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.CanReceiveMouseEvents"> + <summary> + Returns a value indicating whether mouse events should be propagated to the mouse target. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ResetKeyboardFocus"> + <summary> + Sets a keyboard focus on a parent root element of the mouse target. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.GetPointRelativeTo(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Transforms the input point relative to the <see cref="T:SciChart.Core.Framework.IHitTestable" /> element. Can be used to transform + points relative to the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" />, or <see cref="P:SciChart.Charting.Visuals.SciChartSurface.XAxis" /> for instance. + </summary> + <param name="point">The input point</param> + <param name="relativeTo">The <see cref="T:SciChart.Core.Framework.IHitTestable" /> element to translate points relative to</param> + <returns>The output point</returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="args">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchManipulationStarting(SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchManipulationStarted(SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchManipulationCompleted(SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs)"> + <summary> + Called when a manipulation is completed + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierTouchManipulationInertiaStarting(SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs)"> + <summary> + Called when a manipulation inertia is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the MouseLeave event is fired for a Master of current <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnDataContextChanged(System.Object,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the DataContext of the <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> changes + </summary> + <param name="sender"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.IsPointWithinBounds(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets whether the mouse point is within the bounds of the hit-testable element. Assumes the mouse-point has not been translated yet (performs translation) + </summary> + <param name="mousePoint"></param> + <param name="hitTestable"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> instance + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.OnParentSurfaceMouseEnter"> + <summary> + Called when the mouse enters the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MatchesExecuteOn(SciChart.Core.Utility.Mouse.MouseButtons,SciChart.Charting.ChartModifiers.ExecuteOn)"> + <summary> + Determines whether the currently pressed mouse buttons matches the <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ExecuteOn" />. + Used to filter events such as zoom or pan on right mouse button + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MatchesExecuteWhen(SciChart.Core.Utility.Mouse.MouseModifier,SciChart.Core.Utility.Mouse.MouseModifier)"> + <summary> + Determines whether the currently pressed modifier key matches the <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.ExecuteWhen" />. + Used to TODO + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.FreeLookModifier3D"> + <summary> + <para>The FreeLookModifier3D provides the behaviour of free look (free rotation of camera, plus movement) by dragging the mouse and via keyboard shortcuts</para> + <para>It can be enabled by setting an FreeLookModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property, or as part of a <see cref="T:SciChart.Charting3D.Modifiers.ModifierGroup3D" /></para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.MovementSpeedProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.MovementSpeed" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.ForwardKeyProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.ForwardKey" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.BackKeyProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.BackKey" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.RightKeyProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.RightKey" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.LeftKeyProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.LeftKey" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.UpKeyProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.UpKey" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.FreeLookModifier3D.DownKeyProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.DownKey" /> DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.FreeLookModifier3D.#ctor"> + <summary> + <para>Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.FreeLookModifier3D" /> class.</para> + <para>The FreeLookModifier3D provides the behaviour of free look (free rotation of camera, plus movement) by dragging the mouse and via keyboard shortcuts</para> + <para>It can be enabled by setting an FreeLookModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property, or as part of a <see cref="T:SciChart.Charting3D.Modifiers.ModifierGroup3D" /></para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.DownKey"> + <summary> + Gets or sets the key which moves the camera Down in world space + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.UpKey"> + <summary> + Gets or sets the key which moves the camera Up in world space + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.LeftKey"> + <summary> + Gets or sets the key which moves the camera Left in world space + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.RightKey"> + <summary> + Gets or sets the key which moves the camera Right in world space + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.BackKey"> + <summary> + Gets or sets the key which moves the camera Backwards in world space + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.ForwardKey"> + <summary> + Gets or sets the key which moves the camera Forwards in world space + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.FreeLookModifier3D.MovementSpeed"> + <summary> + Gets or sets the Movement Speed, e.g. world units traversed on key-press + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.FreeLookModifier3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.FreeLookModifier3D.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.FreeLookModifier3D.GetVectors(SciChart.Charting3D.ICameraController,SciChart.Charting3D.Vector3@,SciChart.Charting3D.Vector3@,System.Single@)"> + <summary> + Computes position, target vectors and ortho zoom factor depending on keys pressed + </summary> + <param name="camera">The camera.</param> + <param name="positionVector">The position vector.</param> + <param name="targetVector">The target vector.</param> + <param name="orthoZoomFactor">The ortho zoom factor.</param> + <returns>True if any update occurred</returns> + </member> + <member name="T:SciChart.Charting3D.Modifiers.IChartModifier3D"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" />, which can be used to extend the interactivity or rendering of the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.IChartModifier3D.ParentSurface"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /> to perform operations on + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D"> + <summary> + An abstract base class which factors out handling of Tooltips and Axis Labels which are shared in the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> and derived types + </summary> + <seealso cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> + </member> + <member name="F:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.SourceModeProperty"> + <summary> + Defines the RolloverMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.CurrentPoint"> + <summary> + The Current MousePoint on the parent <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.SourceMode"> + <summary> + Gets or sets type of series on which interaction is performed + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.OnParentSurfaceMouseLeave"> + <summary> + Called when the mouse leaves the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="args">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.HandleMouseEvent(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + General logic for processing mouse events + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.IsEnabledAt(System.Windows.Point)"> + <summary> + When overridden in derived classes, indicates whether mouse point is valid for current modifier + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.GetSeriesInfoAt(System.Windows.Point)"> + <summary> + Enumerates RenderableSeries on the parent <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.ParentSurface" /> and gets <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> objects in given point + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.GetSeriesInfoAt(System.Func{SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,SciChart.Charting3D.RenderableSeries.HitTestInfo3D})"> + <summary> + Called internally, gets the SeriesInfo on all RenderableSeries using the provided hit-test function + </summary> + <param name="hitTestMethod">The hit-test function</param> + <returns>The seriesinfo list</returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.IsHitPointValid(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.IsSeriesValid(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + When overridden in derived classes, indicates whether the series should be inspected in order to get <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> inside the <see cref="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.LegendModifier3D"> + <summary> + Defines a custom chart modifier which provides a Legend control on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendDataProperty"> + <summary> + Defines the LegendData DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendPlacementProperty"> + <summary> + Defines the LegendPlacement DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendItemTemplateProperty"> + <summary> + Defines the LegendTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.OrientationProperty"> + <summary> + Defines the LegendOrientation DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.ShowSeriesMarkersProperty"> + <summary> + Defines the ShowSeriesMarkers DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.ShowVisibilityCheckboxesProperty"> + <summary> + Defines the ShowVisibilityCheckboxes DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.ShowLegendProperty"> + <summary> + Defines the ShowLegend DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendTemplateProperty"> + <summary> + Defines the SciChartLegend DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.LegendModifier" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendData"> + <summary> + The LegendData object provides a collection of <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> which can be bound to in ItemsControls or SciChartLegend control. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.ShowVisibilityCheckboxes"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. If true, shows the Visibility Checkboxes in the automatically generated legend. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.ShowSeriesMarkers"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. If true, shows the Series Markers in the automatically generated legend + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendPlacement"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. Defines the placement of the auto-generated legend + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendItemTemplate"> + <summary> + Gets or sets the Legend Item Template, which provides UI that binds to a single <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> instance. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendTemplate"> + <summary> + Used in combination with <see cref="P:SciChart.Charting.ChartModifiers.LegendModifier.ShowLegend" /> = true. An optional control template for the auto-generated <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> control + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.Orientation"> + <summary> + Gets or sets the Orientation of the Legend Items, e.g. Vertical, or Horizontal + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.LegendModifier3D.ShowLegend"> + <summary> + If true, then the LegendModifier automatically shows and hosts a <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> inside the chart surface, according to <see cref="P:SciChart.Charting3D.Modifiers.LegendModifier3D.LegendPlacement" />. If false, then the user may provide an alternative legend control + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting3D.SciChart3DRenderSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.IsHitPointValid(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.UpdateLegend"> + <summary> + Refreshes the legend with up-to-date <see cref="T:SciChart.Charting.Model.ChartData.SeriesInfo" /> with series names, latest values + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.LegendModifier3D.UpdateSeriesInfo(SciChart.Charting3D.Model.ChartData.SeriesInfo3D,SciChart.Charting3D.Model.ChartData.SeriesInfo3D)"> + <summary> + Does a replace of the data on the OldSeriesInfo instance with data from NewSeriesInfo + </summary> + <param name="oldSeriesInfo"></param> + <param name="newSeriesInfo"></param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.ModifierGroup3D"> + <summary> + Allows a collection of modifiers to be set on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property. Child modifiers are stored in the + <see cref="P:SciChart.Charting.ChartModifiers.ModifierGroup.ChildModifiers" /> collection, which is backed by a DependencyProperty so may be bound to in Xaml. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ModifierGroup3D.ChildModifiersProperty"> + <summary> + Defines the ChildModifiers DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.#ctor(SciChart.Charting3D.Modifiers.IChartModifier3D[])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> class. + </summary> + <param name="childModifiers">The child modifier collection.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ModifierGroup3D.ChildModifiers"> + <summary> + Gets or sets a collection of child modifiers in this group + </summary> + <value>The child modifiers.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ModifierGroup3D.Item(System.String)"> + <summary> + Gets the <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" /> with the specified name. + </summary> + <value> + The <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" />. + </value> + <param name="name">The name.</param> + <returns></returns> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ModifierGroup3D.Item(System.Int32)"> + <summary> + Gets the <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" /> at the specified index. + </summary> + <value> + The <see cref="T:SciChart.Charting.ChartModifiers.IChartModifier" />. + </value> + <param name="index">The index.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the mouse leaves the Master of current <see cref="P:SciChart.Charting.ChartModifiers.ChartModifierBase.MouseEventGroup" /></summary> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Down interaction occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Move interaction occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Multi-Touch Up interaction occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the manipulation operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchManipulationStarting(SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchManipulationStarted(SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchManipulationCompleted(SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs)"> + <summary> + Called when a manipulation is completed + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierTouchManipulationInertiaStarting(SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs)"> + <summary> + Called when a manipulation inertia is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Charting3D.Modifiers.ChartModifierBase3D.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.HasModifier(System.Type)"> + <summary> + Determines whether the current <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> has a child modifier of the desired type + </summary> + <param name="desiredType">The type of child modifier to search for</param> + <returns> + <c>true</c> if the current <see cref="T:SciChart.Charting.ChartModifiers.ModifierGroup" /> has a chlid modifier by this type; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ModifierGroup3D.OnDataContextChanged(System.Object,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the DataContext of the <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D"> + <summary> + <para>The MouseWheelZoomModifier3D provides the behaviour of zoom (changing camera radius to target) by spinning the mouse-wheel</para> + <para>It can be enabled by setting an MouseWheelZoomModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property, or as part of a <see cref="T:SciChart.Charting3D.Modifiers.ModifierGroup3D" /></para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D.MouseWheelSensitivityProperty"> + <summary>Defines The <see cref="P:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D.MouseWheelSensitivity" /> DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D.#ctor"> + <summary> + <para>Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D" /> class.</para> + <para>The MouseWheelZoomModifier3D provides the behaviour of zoom (changing camera radius to target) by spinning the mouse-wheel</para> + <para>It can be enabled by setting an MouseWheelZoomModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property, or as part of a <see cref="T:SciChart.Charting3D.Modifiers.ModifierGroup3D" /></para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D.MouseWheelSensitivity"> + <summary> + Gets or sets the mouse wheel sensitivity factor. Default is 20.0f, this is the amount of world units that the camera adjusts its radial distance by on each mousewheel delta + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.MouseWheelZoomModifier3D.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse wheel operation</param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.OrbitModifier3D"> + <summary> + <para>The OrbitModifier3D provides the behaviour of orbit (rotation around camera target) by dragging the mouse</para> + <para>It can be enabled by setting an OrbitModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property, or as part of a <see cref="T:SciChart.Charting3D.Modifiers.ModifierGroup3D" /></para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.OrbitModifier3D.DegreesPerPixelSensitivityProperty"> + <summary>Defines the DegreesPerPixelSensitivity DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.OrbitModifier3D.#ctor"> + <summary> + <para>Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.OrbitModifier3D" /></para> + <para>The OrbitModifier3D provides the behaviour of orbit (rotation around camera target) by dragging the mouse</para> + <para>It can be enabled by setting an OrbitModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property, or as part of a <see cref="T:SciChart.Charting3D.Modifiers.ModifierGroup3D" /></para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.OrbitModifier3D.Dragging"> + <summary> + Gets or sets a value indicating whether this <see cref="T:SciChart.Charting3D.Modifiers.OrbitModifier3D" /> is dragging. + </summary> + <value> + <c>true</c> if dragging; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting3D.Modifiers.OrbitModifier3D.LastPoint"> + <summary> + Gets or sets the last mouse point. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.OrbitModifier3D.DegreesPerPixelSensitivity"> + <summary> + Defines the number of degrees (angle) to orbit the target for each pixel of mouse-move. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.OrbitModifier3D.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.OrbitModifier3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.OrbitModifier3D.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.PinchZoomModifier3D"> + <summary> + The <see cref="T:SciChart.Charting3D.Modifiers.PinchZoomModifier3D" /> provides zooming of the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> with the pinch gesture + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.PinchZoomModifier3D.ZoomScaleSensitivityProperty"> + <summary> + Defines the ZoomScaleSensitivityProperty DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.PinchZoomModifier3D.ZoomScaleSensitivity"> + <summary> + Adjusts the sensitivity of zoom scaling, e.g. 1.0f is the default, 2.0f means twice as sensitive, 0.5f means half as sensitive etc... + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.PinchZoomModifier3D.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLines"> + <summary> + Defines the class which is used only to expose style for the crosshair lines and used in the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity" /></summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLines.ProjectionModeProperty"> + <summary> + Defines the ProjectionMode dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLines.CrosshairOverlayStyleProperty"> + <summary> + Defines the CrosshairOverlayStyle dependency property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLines.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection" /> class + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLines.ProjectionMode"> + <summary> + Gets or sets the <see cref="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.Lines" /> projection mode. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLines.CrosshairOverlayStyle"> + <summary> + Gets or sets the style applied to the modifier overlays (TargetType=Line) + </summary> + <value>The crosshair's style.</value> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection"> + <summary> + Defines the class which is used only to expose style for the crosshair lines projection and used in the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity" /></summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.ShowXyProperty"> + <summary> + Defines the ShowXy dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.XyLineStyleProperty"> + <summary> + Defines the XyLineStyle dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.ShowXzProperty"> + <summary> + Defines the ShowXz dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.XzLineStyleProperty"> + <summary> + Defines the XzLineStyle dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.ShowYzProperty"> + <summary> + Defines the ShowYz dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.YzLineStyleProperty"> + <summary> + Defines the YzLineStyle dependency property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection" /> class + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.ShowXy"> + <summary> + Gets or sets value, indicates whether show crosshair projection on the XY plane or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.XyLineStyle"> + <summary> + Gets or sets the style applied to the crosshair projection on the XY plane (TargetType=Line) + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.ShowXz"> + <summary> + Gets or sets value, indicates whether show crosshair projection on the XZ plane or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.XzLineStyle"> + <summary> + Gets or sets the style applied to the crosshair projection on the XZ plane (TargetType=Line) + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.ShowYz"> + <summary> + Gets or sets value, indicates whether show crosshair projection on the YZ plane or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection.YzLineStyle"> + <summary> + Gets or sets the style applied to the crosshair projection on the YZ plane (TargetType=Line) + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity"> + <summary> + Defines an entity which renders the Crosshair in the <see cref="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.Lines" /> mode and it's projections on the planes + </summary> + See also the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesProjection" /> + See also the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /></member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity.#ctor(SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity" /> class + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity.UpdateHitVertex(SciChart.Charting3D.Vector3)"> + <summary> + Updates last hit vertex on <see cref="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.UpdateOverlays(SciChart.Charting3D.Model.ChartData.SeriesInfo3D)" /> method + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity.RenderScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode"> + <summary> + Defines constants for different cursor modes. See <see cref="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairMode" />. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.None"> + <summary> + Crosshair does not appear. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.Lines"> + <summary> + Crosshair appears at the cursor point, consisting of the three lines which protrude from the corresponding walls of the viewport box. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.Planes"> + <summary> + Crosshair appears at the cursor point, consisting of two intersecting planes. + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairPlanesSceneEntity"> + <summary> + Defines an entity which renders the Crosshair in the <see cref="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.Planes" /> mode and it's projections on the planes + </summary> + See also the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> + See also the <see cref="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairPlanesFillProperty" /></member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairPlanesSceneEntity.#ctor(SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity" /> class + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairPlanesSceneEntity.UpdateHitVertex(SciChart.Charting3D.Vector3)"> + <summary> + Updates last hit vertex on <see cref="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.UpdateOverlays(SciChart.Charting3D.Model.ChartData.SeriesInfo3D)" /> method + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairPlanesSceneEntity.RenderScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.ICrosshairSceneEntity"> + <summary> + Defines the interface for <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairLinesSceneEntity" /> and <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairPlanesSceneEntity" /> classes + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.ICrosshairSceneEntity.UpdateHitVertex(SciChart.Charting3D.Vector3)"> + <summary> + Updates last hit vertex on <see cref="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.UpdateOverlays(SciChart.Charting3D.Model.ChartData.SeriesInfo3D)" /> method + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.ProjectionMode"> + <summary> + Defines constants for different line Projection modes <see cref="F:SciChart.Charting3D.Modifiers.Tooltip3D.CrosshairMode.Lines" />. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.ProjectionMode.None"> + <summary> + Crosshair projection does not appear. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.ProjectionMode.Crosshair"> + <summary> + Draws the full crosshair as the 3D crosshair projection on the planes. + Draws the vertical and horizontal line with the center in the mouse point projected on the plane + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.ProjectionMode.Angular"> + <summary> + Draws the actual 3D crosshair projection on the planes. + Draws the lines from the mouse point projected on the plane to the axes. + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D"> + <summary> + The <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> provides a mouse-over tooltip to a chart, outputting a single <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> object to bind to which updates as the mouse moves over data-points. + Add to a <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> and set IsEnabled to true to enable this behaviour + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.TooltipProperty"> + <summary> + Defines the Tooltip attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.SetTooltip(System.Windows.DependencyObject,SciChart.Charting.Visuals.RenderableSeries.TooltipControl)"> + <summary> + Sets the Tooltip attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.GetTooltip(System.Windows.DependencyObject)"> + <summary> + Gets the Tooltip attached property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.TooltipTemplateProperty"> + <summary> + Defines the TooltipTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.SetTooltipTemplate(System.Windows.DependencyObject,System.Windows.DataTemplate)"> + <summary> + Sets the TooltipTemplate attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.GetTooltipTemplate(System.Windows.DependencyObject)"> + <summary> + Gets the TooltipTemplate attached property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.TooltipContainerStyleProperty"> + <summary> + Defines the TooltipStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.SetTooltipContainerStyle(System.Windows.DependencyObject,System.Windows.Style)"> + <summary> + Sets the TooltipStyle attached property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.GetTooltipContainerStyle(System.Windows.DependencyObject)"> + <summary> + Gets the TooltipStyle attached property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.IncludeSeriesProperty"> + <summary> + Defines the IncludeSeries attached Property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets whether <paramref name="series" /> can be inspected by <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets whether <paramref name="series" /> can be inspected by <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" />. + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.ShowTooltipOnProperty"> + <summary> + Defines the ShowTooltipOn dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairModeProperty"> + <summary> + Defines the CrosshairMode dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairProjectionStyleProperty"> + <summary> + Defines the CrosshairProjectionStyle dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.ShowAxisLabelsProperty"> + <summary> + Defines the ShowAxisLabels dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.HoverDelayProperty"> + <summary> + Defines the HoverDelay dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.TooltipLabelDataContextSelectorProperty"> + <summary> + Defines the TooltipLabelDataContext dependency property + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairPlanesFillProperty"> + <summary> + Defines the CrosshairPlanesFill dependency property + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.ShowTooltipOn"> + <summary> + Gets or sets when to show tooltips + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairMode"> + <summary> + Gets or sets the mode of the Crosshairs + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairProjectionStyle"> + <summary> + Gets or sets the style applied to the modifier lines overlay projections (TargetType=Crosshair) + </summary> + <value>The crosshairs projection style.</value> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.ShowAxisLabels"> + <summary> + Gets or sets value, indicates whether show labels on axes or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.HoverDelay"> + <summary> + Gets or sets delay for showing of tooltips in milliseconds + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.TooltipLabelDataContextSelector"> + <summary> + Gets or sets the function which is called internally to get a DataContext for a particular data point + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CrosshairPlanesFill"> + <summary> + Gets or sets the color in which is used to fill intersecting planes + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.OnAttached"> + <summary> + Called when the element is attached to the Chart Surface + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.OnDetached"> + <summary> + Called immediately before the element is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CreateCrosshairSceneEntity"> + <summary> + Creates a new <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.ICrosshairSceneEntity" /> for adding to the scene at the mouse point + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="args">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.ClearAll"> + <summary> + When overriden in a derived class, this method should clear all markers and tooltips from the <see cref="P:SciChart.Charting.Visuals.SciChartSurfaceBase.ModifierSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.HandleMasterMouseEvent(System.Windows.Point)"> + <summary> + When overriden in a derived class, called to handle the Master <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> MouseMove event + </summary> + <param name="mousePoint">The current Mouse-point</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="args">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.OnIsEnabledChanged"> + <summary> + Called when the IsEnabled property changes on this <see cref="T:SciChart.Charting.ChartModifiers.ChartModifierBase" /> instance + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.IsHitPointValid(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + When overridden in derived classes, indicates whether <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> result of hit-test should be returned from the <see cref="M:SciChart.Charting3D.Modifiers.InspectSeriesModifierBase3D.GetSeriesInfoAt(System.Windows.Point)" /> method. + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.HasToShowTooltip"> + <summary> + Checks <see cref="P:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.ShowTooltipOn" /> property and returns value, indicating whether the tooltip has to be shown + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D.CreateFromTemplate``1(System.Windows.DataTemplate,System.Object)"> + <summary> + Creates instances of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.TemplatableControl" /></summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D"> + <summary> + <para>The VertexSelectionModifier3D provides the behaviour of mouse selection of vertices on a 3D chart</para> + <para>It can be enabled by setting an VertexSelectionModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property</para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.IncludeSeriesProperty"> + <summary> + Defines the IncludeSeries Attached Property. When set to True on a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, + the series will be included in vertex selection. When false, the series will be excluded + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.DragReticuleStyleProperty"> + <summary> + Defined DragReticuleStyle dependencyProperty. This is the style (TargetType=Rectangle) which is applied to the drag rectangle + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.MinDragSensitivityProperty"> + <summary> + Defines the MinDragSensitivity DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.StartPoint"> + <summary> + Gets the StartPoint for the drag operation + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.DragReticuleStyle"> + <summary> + Gets or sets the style to apply to the Drag Rectangle. TargetType is System.Windows.Shapes.Rectangle + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.MinDragSensitivity"> + <summary> + Gets or sets the drag sensitivity - rectangles dragged smaller than this size in the diagonal will be ignored when selecting. Default is 10 pixels + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.GetIncludeSeries(System.Windows.DependencyObject)"> + <summary> + Gets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.SetIncludeSeries(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the include Series or not + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse move operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.ClearAll"> + <summary> + Clears all drag reticules from the chart surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.VertexSelectionModifier3D.UpdateReticulePosition(System.Windows.Point,System.Windows.Point)"> + <summary> + Updates the drag reticule position. + </summary> + <param name="startPoint">The start point.</param> + <param name="endPoint">The end point.</param> + </member> + <member name="T:SciChart.Charting3D.Modifiers.XyzGizmoModifier3D"> + <summary> + WORK IN PROGRESS: Intended to display the XYZ Axis gizmo in the bottom left of the screen. + </summary> + <remarks>Currently this behaviour is done in the C++ 3D Engine. This must be pulled up to C#</remarks> + </member> + <member name="M:SciChart.Charting3D.Modifiers.XyzGizmoModifier3D.OnAttached"> + <summary> + Called when the Chart Modifier is attached to the Chart Surface + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.XyzGizmoModifier3D.OnDetached"> + <summary> + Called immediately before the Chart Modifier is detached from the Chart Surface + </summary> + </member> + <member name="T:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D"> + <summary> + <para>The ZoomExtentsModifier3D provides the behaviour of zoom camera to fit on mouse double click on a 3D chart</para> + <para>It can be enabled by setting an ZoomExtentsModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property</para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetPositionProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetPosition" /> dependency property</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetTargetProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetTarget" /> dependency property</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AnimateDurationMsProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AnimateDurationMs" /> dependency property</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.PositionLerpProperty"> + <summary>Defines the <see cref="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.PositionLerpProperty" /> dependency property</summary> + </member> + <member name="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AutoFitRadiusProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AutoFitRadius" /> dependency property</summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.#ctor"> + <summary> + <para>Initializes a new instance of the <see cref="T:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D" /> class.</para> + <para>The ZoomExtentsModifier3D provides the behaviour of zoom camera to fit on mouse double click on a 3D chart</para> + <para>It can be enabled by setting an ZoomExtentsModifier3D on the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property</para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetPosition"> + <summary> + <para>Gets or sets the reset position. This is the <see cref="T:System.Windows.Media.Media3D.Vector3D" /> in 3D world coordinates where the <see cref="P:SciChart.Charting3D.SciChart3DSurface.Camera" /> Position is moved to on double-click of the mouse.</para> + <para>NOTE: This option is only used when <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AutoFitRadius" /> is false</para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetTarget"> + <summary> + <para>Gets or sets the reset target. This is the <see cref="T:System.Windows.Media.Media3D.Vector3D" /> in 3D world coordinates where the <see cref="P:SciChart.Charting3D.SciChart3DSurface.Camera" /> Target is moved to on double-click of the mouse</para> + <para>NOTE: This option is only used when <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AutoFitRadius" /> is false</para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AnimateDurationMs"> + <summary> + Gets or sets the animation duration in milliseconds for any zoom operations + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.AutoFitRadius"> + <summary> + When true, attempts to auto-fit the camera radius to fit the scene. When false, uses the <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetPosition" /> and <see cref="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ResetTarget" /> instead + </summary> + </member> + <member name="P:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.ZoomExtentsCommand"> + <summary> + Gets a Command which can be bound to. Invokes the ZoomExtents operation + </summary> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs on the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="e">Arguments detailing the mouse button operation</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.OnPositionLerpChanged(System.Double)"> + <summary> + Called when the <see cref="F:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.PositionLerpProperty" /> dependency property changes + </summary> + <param name="newValue">The interpolation value 0.0 to 1.0</param> + </member> + <member name="M:SciChart.Charting3D.Modifiers.ZoomExtentsModifier3D.UpdatePosition(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Updates camera position and target + </summary> + <param name="position">The position.</param> + <param name="target">The target.</param> + </member> + <member name="T:SciChart.Charting3D.Properties.Resources"> + <summary> + A strongly-typed resource class, for looking up localized strings, etc. + </summary> + </member> + <member name="P:SciChart.Charting3D.Properties.Resources.ResourceManager"> + <summary> + Returns the cached ResourceManager instance used by this class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Properties.Resources.Culture"> + <summary> + Overrides the current thread's CurrentUICulture property for all + resource lookups using this strongly typed resource class. + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartDirectXVersion.D3D9"> + <summary> + Forces DirectX9 + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartDirectXVersion.D3D1011"> + <summary> + Forces DirectX10/11. WARNING! May cause crashes on computers without DirectX10 or 11 GPU Capabilities + </summary> + </member> + <member name="T:SciChart.Charting3D.SCRTDllLoader"> + <summary> + Loads unmanaged DLLs, dynamically choosing 32 or 64 bit depending on the current platform architecture + </summary> + </member> + <member name="M:SciChart.Charting3D.SCRTDllLoader.InitNativeLibs"> + <summary> + Initializes the native libraries + </summary> + </member> + <member name="P:SciChart.Charting3D.SCRTDllLoader.ForceDirectXVersion"> + <summary> + Allows forcing DirectX Version. Must be called once before SciChart3D is loaded in the application + </summary> + </member> + <member name="T:SciChart.Charting3D.Interop.Vectori.VectoriEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.Vectorui.VectoruiEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.Vectorul.VectorulEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.Vectord.VectordEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.Vectorf.VectorfEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.Vectorstr.VectorstrEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.Vectorwstr.VectorwstrEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.VectorScrtEntity.VectorScrtEntityEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.VectorSelectionInfo.VectorSelectionInfoEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting3D.Interop.sIMVector2"> + <summary> + Vector2 structure for interop with C++ layer + </summary> + </member> + <member name="T:SciChart.Charting3D.Interop.sIMVector3"> + <summary> + Vector3 structure for interop with C++ layer + </summary> + </member> + <member name="T:SciChart.Charting3D.Interop.sIMVector4"> + <summary> + Vector4 structure for interop with C++ layer + </summary> + </member> + <member name="T:SciChart.Charting3D.Interop.sIMVertex"> + <summary> + the immediate mode vertex for interop with C++ layer + </summary> + </member> + <member name="T:SciChart.Charting3D.Interop.sIMLineVertex"> + <summary> + the immediate mode lines vertex for interop with C++ layer + </summary> + </member> + <member name="T:SciChart.Charting3D.Annotations.FpsPresenter"> + <summary> + Presents Frames Per Second on screen. + </summary> + </member> + <member name="T:SciChart.Charting3D.Annotations.XyzAxisDebug3D"> + <summary> + Defines an entity which draws an X-Y-Z line in Red Green Blue at the centre of the axis cube. Used to debug + </summary> + </member> + <member name="M:SciChart.Charting3D.Annotations.XyzAxisDebug3D.#ctor(SciChart.Charting3D.Vector3,System.Single)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Annotations.XyzAxisDebug3D" /> class. + </summary> + <param name="worldDimensions">The world dimensions.</param> + <param name="strokeThickness">The stroke thickness.</param> + </member> + <member name="M:SciChart.Charting3D.Annotations.XyzAxisDebug3D.RenderScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="T:SciChart.Charting3D.Annotations.XyzGizmo"> + <summary> + Draws the XYZ Gizmo in the bottom left of the screen + </summary> + </member> + <member name="P:SciChart.Charting3D.Annotations.XyzGizmo.AxisLength"> + <summary> + Gets or sets + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChartTextureTemplate"> + <summary> + Keys for pre-packaged Textures + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartTextureTemplate.Default"> + <summary> + The default texture (blank) + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartTextureTemplate.Circle"> + <summary> + The Circle texture + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartTextureTemplate.Square"> + <summary> + The Square/Quad texture + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartTextureTemplate.Triangle"> + <summary> + The Triangle texture + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChartMeshTemplate"> + <summary> + Keys for pre-packaged 3D meshes + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartMeshTemplate.Cube"> + <summary> + The cube 3D mesh + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartMeshTemplate.Sphere"> + <summary> + The sphere 3D mesh + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartMeshTemplate.Pyramid"> + <summary> + The pyramid 3D mesh + </summary> + </member> + <member name="F:SciChart.Charting3D.SciChartMeshTemplate.Cylinder"> + <summary> + The cylinder 3D mesh + </summary> + </member> + <member name="T:SciChart.Charting3D.AssetManager"> + <summary> + Wraps pre-packaged assets such as <see cref="T:SciChart.Charting3D.Texture2D" /> and <see cref="!:IndexedMesh3D" /> used as point-markers + </summary> + </member> + <member name="M:SciChart.Charting3D.AssetManager.GetTexture(SciChart.Charting3D.SciChartTextureTemplate)"> + <summary> + Gets the pre-packaged <see cref="T:SciChart.Charting3D.Texture2D" /> keyed by <see cref="!:SciChartTexture" /> enum value + </summary> + </member> + <member name="M:SciChart.Charting3D.AssetManager.GetMesh(SciChart.Charting3D.SciChartMeshTemplate)"> + <summary> + Gets the pre-packaged <see cref="!:IndexedMesh3D" /> keyed by <see cref="!:SciChartMesh" /> enum value + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.Axis3D"> + <summary> + Enumeration constants to define the 3D axis X, Y or Z. + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.Axis3D.XAxis"> + <summary> + X axis. + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.Axis3D.YAxis"> + <summary> + Y axis. + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.Axis3D.ZAxis"> + <summary> + Z axis. + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.AxisBase3D"> + <summary> + Provides an abstract base class for 3D Axis in the SciChart3D Project + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.TickLabelAlignmentProperty"> + <summary> + Defines the TickLabelAlignment DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.PositiveSideClippingProperty"> + <summary> + Defines the PositiveSideClipping DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.NegativeSideClippingProperty"> + <summary> + Defines the NegativeSideClipping DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.PlaneBorderThicknessProperty"> + <summary> + Defines the PlaneBorderThickness DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.PlaneBorderColorProperty"> + <summary> + Defines the PlaneBorderColor DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.AxisPlaneBackgroundFillProperty"> + <summary> + Defines the AxisPlaneBackgroundFill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.LabelDepthTestEnabledProperty"> + <summary> + Defines the DrawLabels DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.SmoothLabelOverlapAvoidanceProperty"> + <summary> + Defines the SmoothLabelOverlapAvoidance DependencyProperty. + Excluded from public API for now, since it requires amending. + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisBase3D.IsLabelCullingEnabledProperty"> + <summary> + Defines the IsLabelCullingEnabled DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.HasChanges"> + <summary> + Gets whether this instance has changes. When true, caches will be invalidated and the entire series drawn afresh. When false, where possible vertices will be cached + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Axis is associated with + </summary> + <value>The parent surface.</value> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.IsYAxis"> + <summary> + Gets whether the current axis is an Y-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.IsZAxis"> + <summary> + Gets whether the current axis is an Y-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.AxisPlaneBackgroundFill"> + <summary> + Gets or sets the Fill of the Axis Background. Defaults to Transparent. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.LabelDepthTestEnabled"> + <summary> + If true : labels text is always on top + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.PositiveSideClipping"> + <summary> + Gets or sets a value determining how Renderable Series is clipped by axis at its positive side. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.NegativeSideClipping"> + <summary> + Gets or sets a value determining how Renderable Series is clipped by axis at its negative side. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.TickLabelAlignment"> + <summary> + Gets or sets the TextAlignment of tick labels for the axis drawn in the 3D Viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.PlaneBorderThickness"> + <summary> + Gets or sets a thickness of the axis plane border. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.PlaneBorderColor"> + <summary> + Gets or sets a color of the axis plane border. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.SmoothLabelOverlapAvoidance"> + <summary> + Gets or sets value determining whether Label Overlap Avoidance Algorithm works smoothly, + avoiding flickering effect while the 3D Camera changes its position. + </summary> + <remarks>Excluded from the public API, because this property causes issues with labels on axes. + This behavior should be amended.</remarks> + </member> + <member name="P:SciChart.Charting3D.Axis.AxisBase3D.IsLabelCullingEnabled"> + <summary> + Gets or sets a value indicating whether Label Culling is enabled (when labels overlap) on this AxisPanel3D instance + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.InvalidateParent(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Provides a DependencyProperty callback which invalidates the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <param name="d"></param> + <param name="e"></param> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.OnDependencyPropertyChanged"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.InvalidateParentSurface"> + <summary> + Invalidates the parent surface, asynchronously triggerring a redraw. Only works if the Axis is currently attached (check ParentSurface property != null) + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.GetMaximumRange"> + <summary> + Gets the maximum range. + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.GetAxisSize"> + <summary> + Gets the size of the axis in the Viewport + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.GetAxisOffset"> + <summary> + Returns the offset of the Axis + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.GetCurrentCoordinateCalculator"> + <summary> + Gets the current <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> for this Axis, based on current Visible Range and axis type + </summary> + <returns></returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.ToAxisDescriptor"> + <summary> + CALLED INTERNALLY BY SCICHART: Performs computation before drawing (such as computing axis tick intervals, labels) and converts to an <see cref="T:SciChart.Charting3D.Primitives.IAxisDescriptor" /> instance which is passed to the 3D renderer + </summary> + <returns></returns> + <exception cref="T:System.InvalidOperationException">The Axis requires a LabelProvider to format text labels. Please set the AxisBase3D.LabelProvider property to a valid LabelProvider</exception> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisBase3D.OnTickOrGridLineStyleChanged"> + <summary> + Called when a dependency property or Major/Minor Tick or Grid Lien Style changes changes that requires the parent surface redraws + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.AxisCubeEntity"> + <summary> + Defines an entity which renders an Axis Cube in the 3D scene + </summary> + <remarks>Except it doesn't. Currently the Axis Cube is rendered in C++. + Here is a TODO to pull it up to the C# layer</remarks> + </member> + <member name="M:SciChart.Charting3D.Axis.AxisCubeEntity.UpdateScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw. + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="T:SciChart.Charting3D.Axis.AxisSideClipping"> + <summary> + Enumerates possible kinds of Renderable Series clipping by a particular side of the 3D axis + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisSideClipping.Default"> + <summary> + Default clipping is <see cref="F:SciChart.Charting3D.Axis.AxisSideClipping.VisibleRange" /> for X and Z Axis, and <see cref="F:SciChart.Charting3D.Axis.AxisSideClipping.None" /> for Y Axis + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisSideClipping.None"> + <summary> + Clipping is disabled + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.AxisSideClipping.VisibleRange"> + <summary> + Renderable Series is clipped by visible range + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.DateTimeAxis3D"> + <summary> + Provides a Linear, Value DateTime Axis, capable of rendering DateTime ticks on the X-Axis of a + <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. + </summary> + <remarks> + <para> + All <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis + text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom + <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. + </para> + <para> + In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or + again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. + </para> + <para> + All axis types have many properties to define how they operate. These include + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. + </para> + <para> + Finally, all axis components can be styled. Please see the examples suite, the XAML Styling examples to see + how to use XAML to style axis elements. + </para> + </remarks> + <seealso cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting3D.Axis.NumericAxis3D" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting3D.Axis.TimeSpanAxis3D" /> + </member> + <member name="F:SciChart.Charting3D.Axis.DateTimeAxis3D.SubDayTextFormattingProperty"> + <summary> + Defines the SubDayTextFormatting DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.DateTimeAxis3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> class. + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Axis.DateTimeAxis3D.SubDayTextFormatting"> + <summary> + Gets or sets the Text Formatting String used for Axis Tick Labels when the range of the axis is sub-day + </summary> + <value>The text formatting.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Axis.DateTimeAxis3D.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Axis.DateTimeLabelProvider3D"> + <summary> + The DateTimeLabelProvider3D is a pass-through which uses the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> properties + to format axis and cursor label texts. It also uses the <see cref="P:SciChart.Charting3D.Axis.DateTimeAxis3D.SubDayTextFormatting" /> property to alter text-formatting when the date-range + switches to intra-day + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.DateTimeLabelProvider3D.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting3D.Axis.DateTimeLabelProvider3D.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + <exception cref="T:System.InvalidOperationException">The DateTimeLabelFormatter is only valid on instances of DateTimeAxis</exception> + </member> + <member name="T:SciChart.Charting3D.Axis.IAxis3D"> + <summary> + Defines the base interface to an <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> used throughout Scichart + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.HasChanges"> + <summary> + Gets whether this instance has changes. When true, caches will be invalidated and the entire series drawn afresh. When false, where possible vertices will be cached + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.ParentSurface"> + <summary> + Gets or sets the ParentSurface that this Axis is associated with + </summary> + <value>The parent surface.</value> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.IsYAxis"> + <summary> + Gets whether the current axis is an Y-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.IsZAxis"> + <summary> + Gets whether the current axis is an Z-Axis or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.TickLabelAlignment"> + <summary> + Gets or sets the TextAlignment of tick labels for the axis drawn in the 3D Viewport + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.IAxis3D.ToAxisDescriptor"> + <summary> + CALLED INTERNALLY BY SCICHART: Performs computation before drawing (such as computing axis tick intervals, labels) and converts to an <see cref="T:SciChart.Charting3D.Primitives.IAxisDescriptor" /> instance which is passed to the 3D renderer + </summary> + <returns></returns> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.FontFamily"> + <summary> + Gets or sets the FontFamily for the Axis + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.FontSize"> + <summary> + Gets or sets the FontSize for the axis + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.PositiveSideClipping"> + <summary> + Gets or sets a value determining how Renderable Series is clipped by axis at its positive side. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.NegativeSideClipping"> + <summary> + Gets or sets a value determining how Renderable Series is clipped by axis at its negative side. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.IAxis3D.LabelProvider"> + <summary> + Gets or sets a <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> instance, which may be used to override the formatting of text and cursor labels. + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.TextAlignment3D"> + <summary> + Enumeration constants to define alignment of Text in 3D space + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.TextAlignment3D.Default"> + <summary> + Default alignment + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.TextAlignment3D.Camera"> + <summary> + Align (billboard) to camera + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.TextAlignment3D.ScreenHorizontal"> + <summary> + 2D text + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.TextAlignment3D.ScreenAutoRotated"> + <summary> + 2D text, rotated with alignment to corresponding object ( i.e. tick ) + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.ILogarithmicAxis3D"> + <summary> + Defines the interface to a logarithmic axis, the value axis which uses a logarithmic scale. + The <see cref="P:SciChart.Charting3D.Axis.ILogarithmicAxis3D.LogarithmicBase" /> property determines which base is used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.ILogarithmicAxis3D.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.ILogarithmicAxis3D.ScientificNotation"> + <summary> + Gets or sets used number format. + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D"> + <summary> + Provides a Logarithmic, Value Numeric Axis 3D, capable of rendering double, int, short, byte, long ticks on the X, Y or Z-Axis of a <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />. + The <see cref="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.LogarithmicBase" /> property determines which base is used for the logarithm. + </summary> + <remarks> + <para>All <see cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. </para> + <para>In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. </para> + <para>All axis types have many properties to define how they operate. These include <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. </para> + <para>Finally, all axis components can be styled. Please see the examples suite, the XAML Styling example to see how to use XAML to style axis elements.</para> + </remarks> + <seealso cref="T:SciChart.Charting.Visuals.Axes.AxisBase" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.NumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /> + </member> + <member name="F:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.LogarithmicBaseProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.LogarithmicBase" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.ScientificNotationProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.ScientificNotation" /> DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.LogarithmicBase"> + <summary> + Gets or sets the value which determines the base used for the logarithm. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.IsLogarithmicAxis"> + <summary> + Gets a value indicating whether this instance is a logarithmic axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.ScientificNotation"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.ScientificNotation" /> to use when rendering axis labels + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.GetAxis3DParams"> + <summary> + Gets an <see cref="T:SciChart.Charting.Visuals.Axes.AxisParams" /> struct with info about the current axis setup + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.IsVisibleRangeConstrained(SciChart.Data.Model.IRange)"> + <summary> + Checks whether the current <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.VisibleRange" /> meets <see cref="P:SciChart.Charting3D.Axis.NumericAxis3D.MinimalZoomConstrain" />. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.IsValidRange(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is valid visible range for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.ToAxisDescriptor"> + <summary> + CALLED INTERNALLY BY SCICHART: Performs computation before drawing (such as computing axis tick intervals, labels) and converts to an <see cref="T:SciChart.Charting3D.Primitives.IAxisDescriptor" /> instance which is passed to the 3D renderer + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of Axis Gridlines, Ticks and Labels. + When overridden in a derived class (e.g. <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" />, the implementation of GetTickCalculator() changes to + allow calculations specific to that axis type + </summary> + <returns> + An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance + </returns> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.CalculateTicks"> + <summary> + Overridden by derived types, called internal to calculate MinorTicks, MajorTicks before Axis drawing + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.LogarithmicNumericAxis3D.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Axis.LogarithmicNumericLabelProvider3D"> + <summary> + LogarithmicNumericLabelProvider3D class for LogarithmicNumericAxis3D + </summary> + </member> + <member name="T:SciChart.Charting3D.Axis.NumericAxis3D"> + <summary> + The NumericAxis3D provides a 3D axis type which supports numeric (Double, Single, Long, Int) values + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Axis.NumericAxis3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Axis.NumericAxis3D.MajorDelta"> + <summary> + Gets or sets the major delta. + </summary> + <value>The major delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Axis.NumericAxis3D.MinorDelta"> + <summary> + Gets or sets the minor delta. + </summary> + <value>The minor delta.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.Axis.NumericAxis3D.MinimalZoomConstrain"> + <summary> + Gets or sets the MinimalZoomConstrain of the Axis. This is used to set minimum distance between Min and Max of the VisibleRange + </summary> + <value>The minimum distance between Min and Max of the VisibleRange</value> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.OnIdChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + <param name="args"></param> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of Axis Gridlines, Ticks and Labels. + When overridden in a derived class (e.g. <see cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" />, the implementation of GetTickCalculator() changes to + allow calculations specific to that axis type + </summary> + <returns>An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance</returns> + </member> + <member name="M:SciChart.Charting3D.Axis.NumericAxis3D.CalculateDelta"> + <summary> + Calcuates the delta's for use in this render pass + </summary> + <remarks></remarks> + </member> + <member name="T:SciChart.Charting3D.Axis.TimeSpanAxis3D"> + <summary> + Provides a Linear, Value TimeSpan Axis, capable of rendering TimeSpan ticks on the X,Y or Z-Axis of a + <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. + </summary> + <remarks> + <para> + All <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> derived types have a <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> property to define axis + text labels, however a more advanced + way of defining axis label text is via the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.LabelProvider" /> property - expecting a custom + <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" /> derived type. + </para> + <para> + In order to separately format cursor labels please see the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> or + again implement a customer <see cref="T:SciChart.Charting.Visuals.Axes.LabelProviders.ILabelProvider" />. + </para> + <para> + All axis types have many properties to define how they operate. These include + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorGridLines" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorGridLines" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorTicks" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMinorTicks" />, + <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawMajorBands" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.DrawLabels" />. + </para> + <para> + Finally, all axis components can be styled. Please see the examples suite, the XAML Styling examples to see + how to use XAML to style axis elements. + </para> + </remarks> + <seealso cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.IAxis" /> + <seealso cref="T:SciChart.Charting3D.Axis.NumericAxis3D" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.LogarithmicAxis.LogarithmicNumericAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> + <seealso cref="T:SciChart.Charting.Visuals.Axes.CategoryDateTimeAxis" /> + <seealso cref="T:SciChart.Charting3D.Axis.DateTimeAxis3D" /> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3D.GetMaximumRange"> + <summary> + Gets the Maximum Range of the axis, which is equal to the DataRange including any GrowBy factor applied + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.Axis.TimeSpanAxis3DBase"> + <summary> + A common base class for <see cref="T:SciChart.Charting.Visuals.Axes.DateTimeAxis" /> and <see cref="T:SciChart.Charting.Visuals.Axes.TimeSpanAxis" /></summary> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3DBase.GetUndefinedRange"> + <summary> + Returns an undefined <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3DBase.GetDefaultNonZeroRange"> + <summary> + Returns an default non zero <see cref="T:SciChart.Data.Model.IRange" />, called internally by SciChart to reset the VisibleRange of an axis to an undefined state + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3DBase.IsOfValidType(SciChart.Data.Model.IRange)"> + <summary> + Checks whether <paramref name="range" /> is not Null and is of valid type for this axis + </summary> + <param name="range"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3DBase.OnIdChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when a dependency property changes that requires the parent surface redraws + </summary> + <param name="args"></param> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3DBase.CalculateDelta"> + <summary> + Calcuates the delta's for use in this render pass + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanAxis3DBase.GetDeltaCalculator"> + <summary> + Returns an instance of an <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> which is used to compute the data-values of <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MajorDelta" />, <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.MinorDelta" />. + Overridden by derived types to allow calculations specific to that axis type. + </summary> + <returns> + An <see cref="T:SciChart.Charting.Numerics.DeltaCalculators.IDeltaCalculator" /> instance + </returns> + </member> + <member name="T:SciChart.Charting3D.Axis.TimeSpanLabelProvider3D"> + <summary> + The TimeSpanLabelProvider3D is a pass-through which uses the <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.TextFormatting" /> and <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.CursorTextFormatting" /> properties + to format axis and cursor label texts from TimeSpan data types. Used by the <see cref="T:SciChart.Charting3D.Axis.TimeSpanAxis3D" /> type. + </summary> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanLabelProvider3D.FormatCursorLabel(System.IComparable)"> + <summary> + Formats a label for the cursor, from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted cursor label string + </returns> + </member> + <member name="M:SciChart.Charting3D.Axis.TimeSpanLabelProvider3D.FormatLabel(System.IComparable)"> + <summary> + Formats a label for the axis from the specified data-value passed in + </summary> + <param name="dataValue">The data-value to format</param> + <returns> + The formatted label string + </returns> + <exception cref="T:System.InvalidOperationException">The DateTimeLabelFormatter is only valid on instances of DateTimeAxis</exception> + </member> + <member name="T:SciChart.Charting3D.Camera3D"> + <summary> + <para>Defines a FrameworkElement-based implementation of <see cref="T:SciChart.Charting3D.ICameraController" />, which may be constructed in XAML and properties may be bound to as they are DependencyProperties</para> + <para>You can set Position, Target as Vectors in world coordinates, Field of View, Aspect ratio etc...</para> + <para>A camera can be switched from prespective to orthogonal, or rotated around it's target.</para> + <para>Cameras may be attached to the <see cref="P:SciChart.Charting3D.SciChart3DSurface.Camera" /> property and there are several implementations for MVVM or XAML based construction</para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.CameraIdProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.CameraId" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.PositionProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.Position" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.TargetProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.Target" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.FieldOfViewProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.FieldOfView" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.NearClipProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.NearClip" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.FarClipProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.FarClip" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.OrbitalPitchProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.OrbitalPitch" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.OrbitalYawProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.OrbitalYaw" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.RadiusProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.Radius" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.AspectRatioProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.AspectRatio" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.ProjectionModeProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.ProjectionMode" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.OrthoWidthProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.OrthoWidth" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.OrthoHeightProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.OrthoHeight" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.Camera3D.ZoomToFitOnAttachProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.Camera3D.ZoomToFitOnAttach" /> DependencyProperty</summary> + </member> + <member name="M:SciChart.Charting3D.Camera3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Camera3D" /> class. + </summary> + </member> + <member name="E:SciChart.Charting3D.Camera3D.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="E:SciChart.Charting3D.Camera3D.CameraUpdated"> + <summary> + Event raised whenever the Camera properties are updated and the parent requires a redraw + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.ZoomToFitOnAttach"> + <summary> + When true, the Camera is zoomed to fit the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> scene bounds on attached + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.CameraId"> + <summary> + Gets or sets the Name or ID of the camera. Does not need to be unique, but can be used by the user to identify a camera + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.Position"> + <summary> + Gets or sets the Position of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.Target"> + <summary> + Gets or sets the Target of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.FieldOfView"> + <summary> + Gets or sets the Field of View Angle of the Camera in Degrees + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.NearClip"> + <summary> + Gets or sets the Near Clipping distance of the camera. Objects closer than this distance will be invisible to the camera + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.FarClip"> + <summary> + Gets or sets the Far Clipping distance of the camera. Objects farther than this distance will be invisible to the camera + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.OrbitalPitch"> + <summary> + Gets or sets the Pitch angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.OrbitalYaw"> + <summary> + Gets or sets the Yaw angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.Radius"> + <summary> + Calculated Property: Gets or sets the Radius distance of the camera to target in World Units. This property may be manipulated to change the camera position + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.AspectRatio"> + <summary> + Gets or sets the Aspect Ratio of the viewport, e.g. 1.333f suggests width is 1.333 * height + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.OrthoHeight"> + <summary> + Gets or sets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.OrthoWidth"> + <summary> + Gets or sets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.ProjectionMode"> + <summary> + Gets or sets the Camera projection mode, e.g. perspective or orthogonal + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.Up"> + <summary> + Calculated Property: Gets the Normalized Up Vector of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.UpGlobal"> + <summary> + Calculated Property: Gets the Normalized Global Up Vector equal to Vector3(0,1,0) in LH Coordinate system + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.Side"> + <summary> + Calculated Property: Gets the Normalized Side Vector of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.Forward"> + <summary> + Calculated Property: Gets the Normalized Forward (direction) Vector of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.Camera3D.IsAttached"> + <summary> + INTERNAL USE ONLY: Gets or sets whether this camera is attached to the viewport + </summary> + </member> + <member name="M:SciChart.Charting3D.Camera3D.ToOrthogonal"> + <summary> + Switches the camera to Orthogonal mode + </summary> + </member> + <member name="M:SciChart.Charting3D.Camera3D.ToPerspective"> + <summary> + Switches the camera to Perspective mode + </summary> + </member> + <member name="M:SciChart.Charting3D.Camera3D.ResetToDefaults"> + <summary> + Resets the camera to default position, target and orientation + </summary> + </member> + <member name="M:SciChart.Charting3D.Camera3D.AttachCameraToViewport(SciChart.Charting3D.IViewport3D)"> + <summary> + INTERNAL USE: Attaches the camera to the viewport + </summary> + <param name="viewport"></param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.WorldToScreenSpace(SciChart.Charting3D.Vector3)"> + <summary> + Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices + </summary> + <param name="vertex"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Camera3D.LocalCoordinateToScreenSpace(SciChart.Charting3D.Vector3)"> + <summary> + Converts the Vector3 in local coordinate space to a 2D screen coordinate, using the current View and Projection matrices + </summary> + <param name="vertex"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Camera3D.CalculateRadiusToFit(SciChart.Charting3D.BoundingBox,SciChart.Charting3D.Vector3@,System.Single@)"> + <summary> + Calculates a Camera target and radius that will fit the bounding box completely inside the viewport. + Uses a simple bounding-sphere algorithm + </summary> + <param name="bounds"></param> + <param name="newTarget"></param> + <param name="newRadius"></param> + <example> + <code> + // Given a current position, target (which gives camera direction) + camera.Target = new Vector3(0,0,0); + camera.Position = new Vector3(100,100,100); + // Calculate optimum radius to fit the bounding box + Vector3 newTarget; + float newRadius; + camera.CalculateRadiusToFit(new BoundingBox(/* ... */), out newTarget, out newRadius); + // Update camera target and radius + camera.Target = newTarget; + camear.Radius = newRadius; + </code> + </example> + </member> + <member name="M:SciChart.Charting3D.Camera3D.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting3D.Camera3D.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnCameraIdDependencyPropertyChanged(System.String,System.String)"> + <summary> + Called when the CameraId DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnPositionDependencyPropertyChanged(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Called when the Position DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnTargetDependencyPropertyChanged(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Called when the Target DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnFieldOfViewDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the FieldOfView DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnNearClipDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the NearClip DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnFarClipDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the FarClip DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnOrbitalPitchDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the OrbitalPitch DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnOrbitalYawDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the OrbitalYaw DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnRadiusDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the Radius DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnAspectRatioDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the AspectRatio DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnProjectionModeDependencyPropertyChanged(SciChart.Charting3D.CameraProjectionMode,SciChart.Charting3D.CameraProjectionMode)"> + <summary> + Called when the ProjectionMode DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnOrthoWidthDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the OrthoWidth DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.Camera3D.OnOrthoHeightDependencyPropertyChanged(System.Single,System.Single)"> + <summary> + Called when the OrthoHeight DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="T:SciChart.Charting3D.CameraProjectionMode"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.ICameraController.ProjectionMode" /> enum values + </summary> + </member> + <member name="F:SciChart.Charting3D.CameraProjectionMode.Perspective"> + <summary> + The camera renders in perspective mode + </summary> + </member> + <member name="F:SciChart.Charting3D.CameraProjectionMode.Orthogonal"> + <summary> + The camera renders in Orthogonal mode + </summary> + </member> + <member name="T:SciChart.Charting3D.ICameraController"> + <summary> + <para>Defines the interface to a Camera in the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> scene</para> + <para>You can set Position, Target as Vectors in world coordinates, Field of View, Aspect ratio etc...</para> + <para>A camera can be switched from prespective to orthogonal, or rotated around it's target.</para> + <para>Cameras may be attached to the <see cref="P:SciChart.Charting3D.SciChart3DSurface.Camera" /> property and there are several implementations for MVVM or XAML based construction</para> + </summary> + </member> + <member name="E:SciChart.Charting3D.ICameraController.CameraUpdated"> + <summary>Event raised whenever the Camera properties are updated and the parent requires a redraw</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.CameraId"> + <summary>Gets or sets the Name or ID of the camera. Does not need to be unique, but can be used by the user to identify a camera</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.Position"> + <summary>Gets or sets the Position of the Camera as an XYZ Vector3 in World Coordinates</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.Target"> + <summary>Gets or sets the Target of the Camera as an XYZ Vector3 in World Coordinates</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.Up"> + <summary>Calculated Property: Gets the Normalized Up Vector of the Camera as an XYZ Vector3 in World Coordinates</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.Forward"> + <summary>Calculated Property: Gets the Normalized Forward (direction) Vector of the Camera as an XYZ Vector3 in World Coordinates</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.Side"> + <summary>Calculated Property: Gets the Normalized Side Vector of the Camera as an XYZ Vector3 in World Coordinates</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.UpGlobal"> + <summary>Calculated Property: Gets the Normalized Global Up Vector equal to Vector3(0,1,0) in LH Coordinate system</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.FieldOfView"> + <summary>Gets or sets the Field of View Angle of the Camera in Degrees</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.NearClip"> + <summary>Gets or sets the Near Clipping distance of the camera. Objects closer than this distance will be invisible to the camera</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.FarClip"> + <summary>Gets or sets the Far Clipping distance of the camera. Objects farther than this distance will be invisible to the camera</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.OrbitalYaw"> + <summary>Gets or sets the Yaw angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.OrbitalPitch"> + <summary>Gets or sets the Pitch angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.Radius"> + <summary>Calculated Property: Gets or sets the Radius distance of the camera to target in World Units. This property may be manipulated to change the camera position</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.AspectRatio"> + <summary>Gets or sets the Aspect Ratio of the viewport, e.g. 1.333f suggests width is 1.333 * height</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.IsAttached"> + <summary>INTERNAL USE ONLY: Gets or sets whether this camera is attached to the viewport</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.ProjectionMode"> + <summary>Gets or sets the Camera projection mode, e.g. perspective or orthogonal</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.OrthoWidth"> + <summary>Gets or sets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.OrthoHeight"> + <summary>Gets or sets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal</summary> + </member> + <member name="P:SciChart.Charting3D.ICameraController.ZoomToFitOnAttach"> + <summary> + When true, the Camera is zoomed to fit the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> scene bounds on attached + </summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.ToOrthogonal"> + <summary> + Switches the camera to Orthogonal mode + </summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.ToPerspective"> + <summary> + Switches the camera to Perspective mode + </summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.ResetToDefaults"> + <summary>Resets the camera to default position, target and orientation</summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.AttachCameraToViewport(SciChart.Charting3D.IViewport3D)"> + <summary>INTERNAL USE: Attaches the camera to the viewport</summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.WorldToScreenSpace(SciChart.Charting3D.Vector3)"> + <summary>Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices</summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.LocalCoordinateToScreenSpace(SciChart.Charting3D.Vector3)"> + <summary>Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices</summary> + </member> + <member name="M:SciChart.Charting3D.ICameraController.CalculateRadiusToFit(SciChart.Charting3D.BoundingBox,SciChart.Charting3D.Vector3@,System.Single@)"> + <summary> + Calculates a Camera target and radius that will fit the bounding box completely inside the viewport. + + Uses a simple bounding-sphere algorithm + </summary> + <example> + <code> + // Given a current position, target (which gives camera direction) + camera.Target = new Vector3(0,0,0); + camera.Position = new Vector3(100,100,100); + + // Calculate optimum radius to fit the bounding box + Vector3 newTarget; + float newRadius; + camera.CalculateRadiusToFit(new BoundingBox(/* ... */), out newTarget, out newRadius); + + // Update camera target and radius + camera.Target = newTarget; + camear.Radius = newRadius; + </code> + </example> + </member> + <member name="T:SciChart.Charting3D.CameraController"> + <summary> + <para>Defines a simple bindable (non FrameworkElement) implementation of <see cref="T:SciChart.Charting3D.ICameraController" /></para> + <para>You can set Position, Target as Vectors in world coordinates, Field of View, Aspect ratio etc...</para> + <para>A camera can be switched from prespective to orthogonal, or rotated around it's target.</para> + <para>Cameras may be attached to the <see cref="P:SciChart.Charting3D.SciChart3DSurface.Camera" /> property and there are several implementations for MVVM or XAML based construction</para> + </summary> + </member> + <member name="E:SciChart.Charting3D.CameraController.CameraUpdated"> + <summary> + Event raised whenever the Camera properties are updated and the parent requires a redraw + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.CameraController" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.ParentViewport3D"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.IViewport3D" /> where this camera is attached + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.CameraId"> + <summary> + Gets or sets the Name or ID of the camera. Does not need to be unique, but can be used by the user to identify a camera + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.OrthoHeight"> + <summary> + Gets or sets the Camera Orthogonal Viewport height, used when ProjectionMode is Orthogonal + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.OrthoWidth"> + <summary> + Gets or sets the Camera Orthogonal Viewport width, used when ProjectionMode is Orthogonal + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.ProjectionMode"> + <summary> + Gets or sets the Camera projection mode, e.g. perspective or orthogonal + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.AspectRatio"> + <summary> + Gets or sets the Aspect Ratio of the viewport, e.g. 1.333f suggests width is 1.333 * height + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.IsAttached"> + <summary> + INTERNAL USE ONLY: Gets or sets whether this camera is attached to the viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.Radius"> + <summary> + Calculated Property: Gets or sets the Radius distance of the camera to target in World Units. This property may be manipulated to change the camera position + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.OrbitalPitch"> + <summary> + Gets or sets the Pitch angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.OrbitalYaw"> + <summary> + Gets or sets the Yaw angle of the camera position relative to the target in DEGREES. This property may be manipulated to change the camera position + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.FarClip"> + <summary> + Gets or sets the Far Clipping distance of the camera. Objects farther than this distance will be invisible to the camera + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.NearClip"> + <summary> + Gets or sets the Near Clipping distance of the camera. Objects closer than this distance will be invisible to the camera + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.FieldOfView"> + <summary> + Gets or sets the Field of View Angle of the Camera in Degrees + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.UpGlobal"> + <summary> + Calculated Property: Gets the Normalized Global Up Vector equal to Vector3(0,1,0) in LH Coordinate system + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.Side"> + <summary> + Calculated Property: Gets the Normalized Side Vector of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.Forward"> + <summary> + Calculated Property: Gets the Normalized Forward (direction) Vector of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.Up"> + <summary> + Calculated Property: Gets the Normalized Up Vector of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.Target"> + <summary> + Gets or sets the Target of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.Position"> + <summary> + Gets or sets the Position of the Camera as an XYZ Vector3 in World Coordinates + </summary> + </member> + <member name="P:SciChart.Charting3D.CameraController.ZoomToFitOnAttach"> + <summary> + When true, the Camera is zoomed to fit the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> scene bounds on attached + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting3D.CameraController.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="M:SciChart.Charting3D.CameraController.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.ToOrthogonal"> + <summary> + Switches the camera to Orthogonal mode + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.ToPerspective"> + <summary> + Switches the camera to Perspective mode + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.ResetToDefaults"> + <summary> + Resets the camera to default position, target and orientation + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.AttachCameraToViewport(SciChart.Charting3D.IViewport3D)"> + <summary> + INTERNAL USE: Attaches the camera to the viewport + </summary> + <param name="viewport"></param> + </member> + <member name="M:SciChart.Charting3D.CameraController.WorldToScreenSpace(SciChart.Charting3D.Vector3)"> + <summary> + Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices + </summary> + <param name="vertex">The position in world space</param> + <returns>The point on the screen</returns> + </member> + <member name="M:SciChart.Charting3D.CameraController.LocalCoordinateToScreenSpace(SciChart.Charting3D.Vector3)"> + <summary> + Converts the Vector3 in world space to a 2D screen coordinate, using the current View and Projection matrices + </summary> + <param name="vertex">The position in world space</param> + <returns>The point on the screen</returns> + </member> + <member name="M:SciChart.Charting3D.CameraController.ScreenToWorldSpace(System.Windows.Point,System.Double)"> + <summary> + Converts a point in Screen space to a <see cref="T:SciChart.Charting3D.Vector3" /> in world space, given the specified distance from the screen + </summary> + <param name="pt">The Screen point.</param> + <param name="distance">The distance.</param> + <returns>The <see cref="T:SciChart.Charting3D.Vector3" /> world coordinate</returns> + </member> + <member name="M:SciChart.Charting3D.CameraController.CalculateRadiusToFit(SciChart.Charting3D.BoundingBox,SciChart.Charting3D.Vector3@,System.Single@)"> + <summary> + Calculates a Camera target and radius that will fit the bounding box completely inside the viewport. + Uses a simple bounding-sphere algorithm + </summary> + <param name="bounds"></param> + <param name="newTarget"></param> + <param name="newRadius"></param> + <example> + <code> + // Given a current position, target (which gives camera direction) + camera.Target = new Vector3(0,0,0); + camera.Position = new Vector3(100,100,100); + // Calculate optimum radius to fit the bounding box + Vector3 newTarget; + float newRadius; + camera.CalculateRadiusToFit(new BoundingBox(/* ... */), out newTarget, out newRadius); + // Update camera target and radius + camera.Target = newTarget; + camear.Radius = newRadius; + </code> + </example> + </member> + <member name="M:SciChart.Charting3D.CameraController.Update"> + <summary> + Updates the internal camera used by the 3D scene + </summary> + </member> + <member name="M:SciChart.Charting3D.CameraController.OnCameraUpdated"> + <summary> + Raises the <see cref="E:SciChart.Charting3D.CameraController.CameraUpdated" /> event + </summary> + </member> + <member name="T:SciChart.Charting3D.DefaultViewportManager3D"> + <summary> + <para>Defines the default implementation of a Viewportmanager, assigned to <see cref="P:SciChart.Charting3D.SciChart3DSurface.ViewportManager" /> property.</para> + <para>The ViewportManager allows control over the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> and allows you to override X,Y,Z AutoRanging algorithms</para> + <para>See derived types <seealso cref="T:SciChart.Charting3D.ViewportManager3DBase" /> and <seealso cref="T:SciChart.Charting3D.DefaultViewportManager3D" /> for concrete implementations</para> + </summary> + </member> + <member name="M:SciChart.Charting3D.DefaultViewportManager3D.OnCalculateNewXRange(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> requests the XAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="xAxis">The XAxis</param> + <returns> + The new VisibleRange for the XAxis + </returns> + </member> + <member name="M:SciChart.Charting3D.DefaultViewportManager3D.OnCalculateNewYRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> requests a YAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="yAxis">The YAxis</param> + <param name="renderPassInfo">The render pass info.</param> + <returns> + The new VisibleRange for the YAxis + </returns> + </member> + <member name="M:SciChart.Charting3D.DefaultViewportManager3D.OnCalculateNewZRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> requests a ZAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="zAxis">The ZAxis</param> + <param name="renderPassInfo">The render pass info.</param> + <returns> + The new VisibleRange for the ZAxis + </returns> + </member> + <member name="T:SciChart.Charting3D.ISciChart3DRenderSurface"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting3D.SciChart3DRenderSurface" />, which hosts a DirectX enabled viewport which is used to render a 3D scene + </summary> + <seealso cref="T:SciChart.Charting3D.SciChart3DRenderSurface" /> + <seealso cref="P:SciChart.Charting3D.ISciChart3DRenderSurface.Viewport3D" /> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DRenderSurface.Viewport3D"> + <summary> + Gets the 3D Viewport + </summary> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DRenderSurface.AddSeries(System.Collections.Generic.IEnumerable{SciChart.Charting3D.RenderableSeries.IRenderableSeries3D})"> + <summary> + Adds the collection of <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instances to the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /></summary> + <param name="renderableSeries">The renderable series.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DRenderSurface.ChildSeries"> + <summary> + Gets the child RenderableSeries in this <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /> instance + </summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DRenderSurface.ParentSurface"> + <summary> + Gets or sets the Parent <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DRenderSurface.ContainsSeries(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Returns True if the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /> contains the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance + </summary> + <param name="renderableSeries">the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance</param> + <returns> + <c>true</c> if the specified renderable series contains series; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DRenderSurface.AddSeries(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Adds the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance to the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /></summary> + <param name="renderableSeries">The renderable series.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DRenderSurface.RemoveSeries(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Removes the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> from the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /></summary> + <param name="renderableSeries">The renderable series.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DRenderSurface.AttachCamera(SciChart.Charting3D.ICameraController)"> + <summary> + Attaches the camera to the RenderSurface + </summary> + <param name="camera">The camera.</param> + </member> + <member name="T:SciChart.Charting3D.ISciChart3DSurface"> + <summary> + <para>Defines the interface to a <see cref="T:SciChart.Charting3D.SciChart3DSurface" />: a high performance DirectX powered 3D chart surface.</para> + <para>Multiple multiple <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D">Renderable Series</see> are drawn over an Axis Cube, which contains the visual representation of X,Y and Z <see cref="T:SciChart.Charting3D.Axis.IAxis3D" /> instances.</para> + <para>Each <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D">Renderable Series</see> has a <see cref="T:SciChart.Charting3D.Model.IDataSeries3D">Data Series</see>, which provides the data-source either in code or via MVVM bindings.</para> + <para>The <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> supports one or more <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> derived types via the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property. These are used to + affect behaviour such as zooming, panning and tooltips.</para> + <para>Finally, a <see cref="T:SciChart.Charting3D.ICameraController" /> instance is applied to the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> to define the view into the 3D scene</para> + </summary> + <seealso cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + <seealso cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> + <seealso cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> + <seealso cref="P:SciChart.Charting3D.ISciChart3DSurface.Viewport3D" /> + <seealso cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.RenderableSeries"> + <summary> + Gets the collection of RenderableSeries that this SciChartSurface draws. + </summary> + <remarks>A <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> is bound to an <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> derived type. + If a RenderableSeries.IsEnabled=false, then this series is skipped when evaluating the series to draw</remarks> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.Viewport3D"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.IViewport3D" /> which hosts the 3D Scene. This may be null if the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> has not yet loaded or initialized + </summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.RootGrid"> + <summary> + Gets the Root Grid that hosts the SciChart3DSurface components all child controls + </summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.ZAxis"> + <summary> + Gets or sets the ZAxis on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.YAxis"> + <summary> + Gets or sets the YAxis on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.XAxis"> + <summary> + Gets or sets the XAxis on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.ChartModifier"> + <summary> + Gets or sets the ChartModifier on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.Camera"> + <summary> + Gets or sets the Camera on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.ViewportManager"> + <summary> + Gets or sets the ViewportManager instance on the chart, which handles behavior of the viewport on render + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.ISciChart3DSurface.WorldDimensions"> + <summary> + Gets or sets the World Dimensions as a <see cref="T:SciChart.Charting3D.Vector3" />. + </summary> + <remarks> + The default is Z,Y,Z = 100,100,100. + The extents of the X,Y,Z world ranges from -DimX/2 to +DimX/2, -DimY/2 to +DimY/2, -DimZ/2 to +DimZ/2 + </remarks> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DSurface.OnArrangeSciChart"> + <summary> + Preparations for a render pass, called internally, returns the viewport size + </summary> + <returns>The required Viewport Size</returns> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DSurface.CaptureMouse"> + <summary> + Captures the mouse in the WPF Context + </summary> + <returns>True, if mouse was captured</returns> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DSurface.ReleaseMouseCapture"> + <summary> + Releases the mouse capture. + </summary> + </member> + <member name="T:SciChart.Charting3D.ISciChartController3D"> + <summary> + An interface to a subset of methods on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.ISciChartController3D.ZoomExtentsZ"> + <summary> + Zooms the chart to the extents of the data in the Z-Direction, accounting for the current data in view in the X-Y direction + </summary> + </member> + <member name="M:SciChart.Charting3D.ISciChartController3D.AnimateZoomExtentsZ(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the Z-Direction, accounting for the current data in view in the X-Y direction + </summary> + </member> + <member name="T:SciChart.Charting3D.IViewportManager3D"> + <summary> + Defines the interface to a Viewportmanager, assigned to <see cref="P:SciChart.Charting3D.SciChart3DSurface.ViewportManager" /> property. + The ViewportManager allows control over the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> and allows you to override X,Y,Z AutoRanging algorithms. + See derived types <seealso cref="T:SciChart.Charting3D.ViewportManager3DBase" /> and <seealso cref="T:SciChart.Charting3D.DefaultViewportManager3D" /> for concrete implementations. + </summary> + </member> + <member name="P:SciChart.Charting3D.IViewportManager3D.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" />, <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting3D.IViewportManager3D.IsAttached"> + <summary> + Returns <value>True</value> when a <see cref="T:SciChart.Charting3D.ViewportManager3DBase" /> has the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> attached to. + </summary> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.OnVisibleRangeChanged(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> changes for an axis. Override in derived types to get a notification of this occurring. + </summary> + <param name="axis">The <see cref="T:SciChart.Charting3D.Axis.IAxis3D" />instance</param> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.CalculateAutoRange(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to perform autoranging. Override in derived types to return a custom value. + </summary> + <param name="axis">The axis to calculate for</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis. + </returns> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.CalculateNewXAxisRange(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to calculate the new XAxis VisibleRange. Override in derived types to return a custom value. + </summary> + <param name="xAxis">The XAxis to calculate for</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis. + </returns> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.CalculateNewYAxisRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to calculate the new YAxis VisibleRange. Override in derived types to return a custom value. + </summary> + <param name="yAxis">The YAxis to calculate for</param> + <param name="renderPassInfo">The current <see cref="T:SciChart.Charting3D.Primitives.RenderPassInfo3D" /> containing render data</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis. + </returns> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.CalculateNewZAxisRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to calculate the new ZAxis VisibleRange. Override in derived types to return a custom value. + </summary> + <param name="zAxis">The ZAxis to calculate for</param> + <param name="renderPassInfo">The current <see cref="T:SciChart.Charting3D.Primitives.RenderPassInfo3D" /> containing render data</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis. + </returns> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.OnParentSurfaceRendered(SciChart.Charting3D.ISciChart3DSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /> is rendered. + </summary> + <param name="sciChartSurface">The SciChart3DSurface instance</param> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.AttachSciChartSurface(SciChart.Charting3D.ISciChart3DSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> is attached to a ViewportManager. May be overridden to get notification of attachment. + </summary> + <param name="scs">The <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> instance</param> + </member> + <member name="M:SciChart.Charting3D.IViewportManager3D.DetachSciChartSurface"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> is detached from a ViewportManager. May be overridden to get notification of detachment. + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D"> + <summary> + <para>Defines the base-class for a <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> which renders a 3D model at each point. </para> + <para>Use in combination with the <see cref="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D" /> to render a point-cloud</para> + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D.PointsMesh"> + <summary> + Gets the <see cref="!:IndexedMesh3D" /> which is the 3D model repeated at each data-point + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D.MarkerType"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D.MarkerType" /></summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.MarkerType"> + <summary> + Defines the <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> Marker Type. + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.MarkerType.Pixel"> + <summary> + The pixel point marker type. + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.MarkerType.TexturedQuad"> + <summary> + The textured quad. + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.MarkerType.InstancedMesh"> + <summary> + The instanced mesh. + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D"> + <summary> + The base-class for Pointmarkers in SciChart 3D. This is used to repeat a texture or a 3D model at data-points in certain renderable series + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.BasePointMarker3D.PointMarkerTemplateProperty"> + <summary> + Defines the PointMarkerTemplate DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.BasePointMarker3D.FillProperty"> + <summary> + Defines the Fill DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.BasePointMarker3D.SizeProperty"> + <summary> + Defines the Size DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.BasePointMarker3D.SelectedFillProperty"> + <summary> + Defines the SelectedFill DependencyProperty. + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.MarkerType"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.MarkerType" /></summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.PointMarkerTemplate"> + <summary> + Gets or sets the PointMarker ControlTemplate, which defines the point-marker Visual to be rendered on each datapoint of the series. + </summary> + <remarks>The ControlTemplate is used to template the visuals only for a blank control, creating a new instance per <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></remarks>. + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Fill"> + <summary> + Gets or sets the fill. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.SelectedFill"> + <summary> + Gets or sets the fill when selected + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Size"> + <summary> + Gets or sets the size of the PointMarker + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.RenderableSeries"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> which this <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> instance is associated with. + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Attach(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Called when a <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> instance is attached to an <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />. + </summary> + <param name="series">The <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> which this <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> instance is associated with.</param> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Detach"> + <summary> + Called when a <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> instance is detached from an <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />. + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.BaseTexturePointMarker3D"> + <summary> + <para>Defines the base-class for a <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> which renders a flat texture at each point. </para> + <para>Use in combination with the <see cref="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D" /> to render a point-cloud</para> + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.BaseTexturePointMarker3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BaseTexturePointMarker3D.PointTexture"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Texture2D" /> instance which is repeated across data-points + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.BaseTexturePointMarker3D.MarkerType"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.PointMarkers.BaseTexturePointMarker3D.MarkerType" /></summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.SpherePointMarker3D"> + <summary> + Defines a Sphere Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.SpherePointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.SpherePointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.SpherePointMarker3D.PointsMesh"> + <summary> + Gets the <see cref="!:IndexedMesh3D" /> which is the 3D model repeated at each data-point + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.CubePointMarker3D"> + <summary> + Defines a Cube Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.CubePointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.CubePointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.CubePointMarker3D.PointsMesh"> + <summary> + Gets the <see cref="!:IndexedMesh3D" /> which is the 3D model repeated at each data-point + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.PyramidPointMarker3D"> + <summary> + Defines a Pyramid Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.PyramidPointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.PyramidPointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.PyramidPointMarker3D.PointsMesh"> + <summary> + Gets the <see cref="!:IndexedMesh3D" /> which is the 3D model repeated at each data-point + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.CylinderPointMarker3D"> + <summary> + Defines a Cylinder Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.CylinderPointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.CylinderPointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.CylinderPointMarker3D.PointsMesh"> + <summary> + Gets the <see cref="!:IndexedMesh3D" /> which is the 3D model repeated at each data-point + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.PixelPointMarker3D"> + <summary> + Defines a Pixel Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.PixelPointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.PixelPointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.PixelPointMarker3D.MarkerType"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.PointMarkers.PixelPointMarker3D.MarkerType" /></summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.PixelPointMarker3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.QuadPointMarker3D"> + <summary> + Defines a Quad (flat texture) Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.QuadPointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.QuadPointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.QuadPointMarker3D.PointTexture"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Texture2D" /> instance which is repeated across data-points + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.EllipsePointMarker3D"> + <summary> + Defines an Ellipse (flat texture) Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.EllipsePointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.EllipsePointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.EllipsePointMarker3D.PointTexture"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Texture2D" /> instance which is repeated across data-points + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.TrianglePointMarker3D"> + <summary> + Defines a Triangle (flat texture) Point-marker for used with 3D RenderableSeries + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.TrianglePointMarker3D.#ctor"> + <summary> + Initializes the instance of <see cref="T:SciChart.Charting3D.PointMarkers.TrianglePointMarker3D" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.TrianglePointMarker3D.PointTexture"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Texture2D" /> instance which is repeated across data-points + </summary> + </member> + <member name="T:SciChart.Charting3D.PointMarkers.CustomPointMarker3D"> + <summary> + Defines a Custom texture Point-marker for used with 3D RenderableSeries. Accepts a <see cref="P:SciChart.Charting3D.PointMarkers.CustomPointMarker3D.Brush" />, e.g. try <see cref="T:System.Windows.Media.VisualBrush" /> or <see cref="T:System.Windows.Media.ImageBrush" /></summary> + </member> + <member name="F:SciChart.Charting3D.PointMarkers.CustomPointMarker3D.BrushProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.PointMarkers.CustomPointMarker3D.Brush" /> DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.PointMarkers.CustomPointMarker3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.PointMarkers.CustomPointMarker3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.PointMarkers.CustomPointMarker3D.Brush"> + <summary> + Gets or sets the brush to create color-palette from. + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.IAxisCubeDescriptor"> + <summary> + The AxisCubeDescriptpr passes information from WPF about the 3D Axis Cube to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.Dimensions"> + <summary> + Gets or sets the World-dimensions of the Axis Cube. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.XAxisDescriptor"> + <summary> + Gets or sets the x axis descriptor. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.YAxisDescriptor"> + <summary> + Gets or sets the y axis descriptor. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.ZAxisDescriptor"> + <summary> + Gets or sets the z axis descriptor. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.IsVisible"> + <summary> + Gets or sets whether the Axis Cube is visible or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.PlaneVisibilityMode"> + <summary> + Gets or sets the axis Plane Visibility Mode + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.ZxPlaneDrawLabelsMode"> + <summary> + Gets or sets the axis Draw Labels Mode for ZX plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.XyPlaneDrawLabelsMode"> + <summary> + Gets or sets the axis Draw Labels Mode for XY plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisCubeDescriptor.ZyPlaneDrawLabelsMode"> + <summary> + Gets or sets the axis Draw Labels Mode for ZY plane + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.AxisCubeDescriptor"> + <summary> + The AxisCubeDescriptpr passes information from WPF about the 3D Axis Cube to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.Dimensions"> + <summary> + Gets or sets the World-dimensions of the Axis Cube. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.XAxisDescriptor"> + <summary> + Gets or sets the x axis descriptor. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.YAxisDescriptor"> + <summary> + Gets or sets the y axis descriptor. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.ZAxisDescriptor"> + <summary> + Gets or sets the z axis descriptor. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.IsVisible"> + <summary> + Gets or sets whether the Axis Cube is visible or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.PlaneVisibilityMode"> + <summary> + Gets or sets the axis Plane Visibility Mode + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.ZxPlaneDrawLabelsMode"> + <summary> + Gets or sets the axis Draw Labels Mode for ZX plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.XyPlaneDrawLabelsMode"> + <summary> + Gets or sets the axis Draw Labels Mode for XY plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisCubeDescriptor.ZyPlaneDrawLabelsMode"> + <summary> + Gets or sets the axis Draw Labels Mode for ZY plane + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.IAxisDescriptor"> + <summary> + Defines the interface to an <see cref="T:SciChart.Charting3D.Primitives.AxisDescriptor" />, a class which passes information from WPF to the 3D Engine about how to render a 3D Axis + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.AxisTitle"> + <summary> + Gets or sets the axis title text + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.AxisSize"> + <summary> + Gets or sets the axis title text font size + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.MajorCoordinates"> + <summary> + Gets or sets the world-coordinates for major gridlines and labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.MinorCoordinates"> + <summary> + Gets or sets the world-coordinates for minor gridlines and labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.TickLabels"> + <summary> + Gets or sets the tick labels to draw at each major coordinate + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.ExponentialTickLabels"> + <summary> + Gets or sets the tick labels to draw at each major coordinate + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.MajorLineStyle"> + <summary> + Gets or sets the style to apply to major grid lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.MajorTickStyle"> + <summary> + Gets or sets the style to apply to major tick lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.MinorLineStyle"> + <summary> + Gets or sets the style to apply to minor grid lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.MinorTickStyle"> + <summary> + Gets or sets the style to apply to minor tick lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.TitleStyle"> + <summary> + Gets or sets the style to apply to title text + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.LabelStyle"> + <summary> + Gets or sets the style to apply to axis labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.DrawMajorGridLines"> + <summary> + Gets or sets whether to draw Major Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.DrawMinorGridLines"> + <summary> + Gets or sets whether to draw Minor Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.DrawMajorTicks"> + <summary> + Gets or sets whether to draw Major Tick Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.DrawMinorTicks"> + <summary> + Gets or sets whether to draw Minor Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.DrawBands"> + <summary> + Gets or sets whether to draw Bands between Major Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.DrawLabels"> + <summary> + Gets or sets whether to draw Labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.BandColor"> + <summary> + Gets or sets the Color for Major Bands + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.BackgroundColor"> + <summary> + Gets or sets the color of the background of the axis plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.IsVisible"> + <summary> + Gets or sets whether The axis is visible + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.BorderThickness"> + <summary> + Gets or sets a thickness of border + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.LabelDepthTestEnabled"> + <summary> + Gets or sets if labels text is ignoring depth or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.BorderColor"> + <summary> + Gets or sets a Color of the border + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.TitleOffset"> + <summary> + Gets or sets title text offset from the axis plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.TickLabelsOffset"> + <summary> + Gets or sets tick labels offset from the axis plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.SmoothLabelOverlapAvoidance"> + <summary> + Gets or sets value determining whether Label Overlap Avoidance Algorithm works smoothly, + avoiding flickering effect while the 3D Camera changes its position. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IAxisDescriptor.IsLabelCullingEnabled"> + <summary> + Gets or sets a value indicating whether Label Culling is enabled (when labels overlap). + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.AxisDescriptor"> + <summary> + A class which passes information from WPF to the 3D Engine about how to render a 3D Axis + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.AxisDescriptor.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.AxisDescriptor" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.AxisTitle"> + <summary> + Gets or sets the axis title text + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.AxisSize"> + <summary> + Gets or sets the axis title text font size + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.MajorCoordinates"> + <summary> + Gets or sets the world-coordinates for major gridlines and labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.MinorCoordinates"> + <summary> + Gets or sets the world-coordinates for minor gridlines and labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.TickLabels"> + <summary> + Gets or sets the tick labels to draw at each major coordinate + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.ExponentialTickLabels"> + <summary> + Gets or sets the tick labels to draw at each major coordinate + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.MajorLineStyle"> + <summary> + Gets or sets the style to apply to major grid lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.MajorTickStyle"> + <summary> + Gets or sets the style to apply to major tick lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.MinorLineStyle"> + <summary> + Gets or sets the style to apply to minor grid lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.MinorTickStyle"> + <summary> + Gets or sets the style to apply to minor tick lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.TitleStyle"> + <summary> + Gets or sets the style to apply to title text + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.LabelStyle"> + <summary> + Gets or sets the style to apply to axis labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.DrawMajorGridLines"> + <summary> + Gets or sets whether to draw Major Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.DrawMinorGridLines"> + <summary> + Gets or sets whether to draw Minor Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.DrawMajorTicks"> + <summary> + Gets or sets whether to draw Major Tick Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.LabelDepthTestEnabled"> + <summary> + Gets or sets if labels text is ignoring depth or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.DrawMinorTicks"> + <summary> + Gets or sets whether to draw Minor Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.DrawBands"> + <summary> + Gets or sets whether to draw Bands between Major Grid Lines + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.DrawLabels"> + <summary> + Gets or sets whether to draw Labels + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.BandColor"> + <summary> + Gets or sets the Color for Major Bands + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.BackgroundColor"> + <summary> + Gets or sets the color of the background of the axis plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.IsVisible"> + <summary> + Gets or sets whether The axis is visible + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.BorderThickness"> + <summary> + Gets or sets a thickness of the plane. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.BorderColor"> + <summary> + Gets or sets a Color of the border + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.TickLabelsOffset"> + <summary> + Gets or sets tick labels offset from the axis plane + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.SmoothLabelOverlapAvoidance"> + <summary> + Gets or sets value determining whether Label Overlap Avoidance Algorithm works smoothly, + avoiding flickering effect while the 3D Camera changes its position. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.IsLabelCullingEnabled"> + <summary> + Gets or sets a value indicating whether Label Culling is enabled (when labels overlap). + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.AxisDescriptor.TitleOffset"> + <summary> + Gets or sets title text offset from the axis plane + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.HeightMapIndex"> + <summary> + Structure which contains the Z,X Index of a heightmap + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.HeightMapIndex.ZIndex"> + <summary> + The z index + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.HeightMapIndex.XIndex"> + <summary> + The x index + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.HeightMapIndex.#ctor"> + <summary> + Default constructor + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.HeightMapIndex.#ctor(System.Int32,System.Int32)"> + <summary> + Creates instance with calculated values + </summary> + <param name="vertexId">Vertex ID value from selection buffer</param> + <param name="countX">Count of X points</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.IBaseSceneEntity"> + <summary> + Defines the interface to an Entity in the 3D Scene. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.Children"> + <summary> + Gets the collection of children for this entity + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.EntityId"> + <summary> + Gets or sets a unique <see cref="T:System.UInt32" /> identifier for this entity. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.Viewport3D"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.IViewport3D" /> instance that hosts this root entity + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.EntityIdProvider"> + <summary> + <para>Gets or sets an <see cref="T:SciChart.Charting3D.Primitives.IEntityIdProvider" /> which encodes and decodes <see cref="T:SciChart.Charting3D.Primitives.VertexId" />s</para> + <para>VertexIds consist of MeshID (object ID) and vertex ID. </para> + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.IsVisible"> + <summary> + Gets or sets whether this entity is visible or not + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.IsDirty"> + <summary> + When true, meshes need to be recreated on the next Render Pass + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.Parent"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" /></summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IBaseSceneEntity.RootSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.IRootSceneEntity" /> at the root of the + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.Update"> + <summary> + Updates this entity with the current scene time + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.Render"> + <summary> + Renders this entity with the current scene and render pass data + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.VisitEntities(System.Action{SciChart.Charting3D.Primitives.IBaseSceneEntity})"> + <summary> + <para>Implements the Visitor Pattern, visiting all Child entities (and their children) performing the operation on each one.</para> + <para>Use this when you want to set a property on all entities in the scene, or perform a certain function on all entities</para> + </summary> + <param name="operation">The operation.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.SetRenderPassData(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Sets the current <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" />, which contains the data needed for this render pass + </summary> + <param name="e">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" />.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.PerformSelection(System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection on this entity, setting the IsSelected flag to True or False on the specified <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="isSelected">if set to <c>true</c> the vertices become .</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.GetEntity``1"> + <summary> + Gets the first child entity of type <typeparamref name="T" /></summary> + <typeparam name="T">The type of entity to search for</typeparam> + <returns>The entity instance, or default{T}</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.GetSelectionId(System.Windows.Point,System.UInt32@,System.UInt32@)"> + <summary> + Gets the selection identifier under the mouse point. Use <see cref="T:SciChart.Charting3D.Primitives.IEntityIdProvider" /> to decode into mesh and vertex Ids + </summary> + <param name="mousePoint">The mouse point.</param> + <param name="entityId">When method returns, contains selected entity ID.</param> + <param name="vertexId">When method returns, contains selected vertex ID.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.GetSelectionId(System.Windows.Point,System.UInt32@,SciChart.Charting3D.Primitives.HeightMapIndex@)"> + <summary> + Gets the selection identifier under the mouse point. Use <see cref="T:SciChart.Charting3D.Primitives.IEntityIdProvider" /> to decode into mesh and vertex Ids + </summary> + <param name="mousePoint">The mouse point.</param> + <param name="entityId">When method returns, contains selected entity ID.</param> + <param name="heightMapIndex">When method returns, contains selected height map index.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.OnAttached"> + <summary> + Called immediately after an entity is attached to a parent + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.OnDetached"> + <summary> + Called immediate before an entity is detached from a parent + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IBaseSceneEntity.OnEngineRestart"> + <summary> + Called when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.BaseSceneEntity`1"> + <summary> + Defines an Entity in the 3D Scene. All types inheriting from <see cref="T:SciChart.Charting3D.Primitives.BaseSceneEntity`1" /> have the abilty to be postioned and rendered using geometry and primitives defined in the 3D engine + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting3D.Primitives.BaseSceneEntity`1" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.#ctor(`0)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.BaseSceneEntity`1" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Viewport3D"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.IViewport3D" /> instance that hosts this root entity + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Parent"> + <summary> + Gets or sets the parent <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" /></summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Children"> + <summary> + Gets the collection of children for this entity. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.EntityId"> + <summary> + Gets or sets a unique <see cref="T:System.UInt32" /> identifier for this entity. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.IsVisible"> + <summary> + Gets or sets whether this entity is visible or not. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.IsDisposed"> + <summary> + Gets value determining whether the instance has already been disposed. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.IsFinalized"> + <summary> + Gets value determining whether the instance has already been finalized. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.RequiresSelectionId"> + <summary> + <para>Gets a value indicating whether this entity requires a SelectionID.</para> + <para>If TRUE (default), then the <see cref="M:SciChart.Charting3D.Primitives.IEntityIdProvider.GetEntityId" /> method will be called on setting <see cref="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.EntityIdProvider" />. This selection ID is passed through to the + 3D Graphics engine to enable selection, tooltips on the entity.</para> + <para>If FALSE, then no entity ID will be set. It will be the default value of <see cref="F:System.UInt32.MaxValue" />. The item will be considered ignored for selection and tooltips.</para> + </summary> + <value> + <c>true</c> if [requires selection identifier]; otherwise, <c>false</c>. + </value> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.EntityIdProvider"> + <summary> + <para>Gets or sets an <see cref="T:SciChart.Charting3D.Primitives.IEntityIdProvider" /> which encodes and decodes <see cref="T:SciChart.Charting3D.Primitives.VertexId" />s</para> + <para>VertexIds consist of MeshID (object ID) and vertex ID. </para> + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Update(System.Single)"> + <summary> + Updates this entity with the current scene time + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.RootSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.IRootSceneEntity" /> at the root of the + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.IsDirty"> + <summary> + When true, meshes need to be recreated on the next Render Pass + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Update"> + <summary> + Called when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.UpdateScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw. + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Render"> + <summary> + Renders this entity with the current scene and render pass data + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.OnEngineRestart"> + <summary> + Called when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.RenderScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.BeginMesh(SciChart.Charting3D.Primitives.TSRRenderMode)"> + <summary> + Begins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts <see cref="T:SciChart.Charting3D.Primitives.TSRRenderMode" /> which defines the DirectX primitive type + </summary> + <param name="renderMode">The render mode.</param> + <returns>The <see cref="T:SciChart.Charting3D.Primitives.IImmediateMeshContext" /> which can be used for creating dynamic 3D meshes on the fly</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.BeginLitMesh(SciChart.Charting3D.Primitives.TSRRenderMode)"> + <summary> + Begins an Immediate Mesh, which can be used to draw dynamic 3D meshes on the fly. Accepts <see cref="T:SciChart.Charting3D.Primitives.TSRRenderMode" /> which defines the DirectX primitive type + </summary> + <param name="renderMode">The render mode.</param> + <returns>The <see cref="T:SciChart.Charting3D.Primitives.IImmediateMeshContext" /> which can be used for creating dynamic 3D meshes on the fly</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.BeginLines(System.Single,System.Boolean)"> + <summary> + <para>Begins an Immediate Lines Mesh, which can be used to draw dynamic continuous (Poly) 3D lines on the fly.</para> + <para>Accepts <see cref="T:System.Single" /> StrokeThickness which defines the stroke thickness in world coordinates for the line</para> + </summary> + <param name="isAntialiased">When true, lines are antialised</param> + <param name="strokeThickness">The StrokeThickness.</param> + <returns>The <see cref="T:SciChart.Charting3D.Primitives.ILinesMesh" /> which can be used for creating dynamic 3D lines on the fly</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.BeginLineStrips(System.Single,System.Boolean)"> + <summary> + <para>Begins an Immediate Lines Mesh, which can be used to draw dynamic disjointed (discontinuous) 3D lines on the fly. </para> + <para>Accepts <see cref="T:System.Single" /> StrokeThickness which defines the stroke thickness in world coordinates for the line</para> + </summary> + <param name="strokeThickness">The StrokeThickness.</param> + <param name="isAntialiased">When true, lines are antialised</param> + <returns>The <see cref="T:SciChart.Charting3D.Primitives.ILinesMesh" /> which can be used for creating dynamic 3D lines on the fly</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.BeginPoints(System.Single,SciChart.Charting3D.PointMarkers.BasePointMarker3D)"> + <summary> + <para>Begins an Immediate Points Mesh, which can be used to draw dynamic points (as textures, pixels or 3D models) on the fly. </para> + <para>Accepts <paramref cref="T:System.Single" /> PointSize which defines the default size of the 3D point in world coordinates</para> + <para>Accepts <paramref cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> pointMarker which defines the geometry of the 3D point</para> + </summary> + <param name="pointSize">The Point Size.</param> + <param name="pointMarker">The Point Marker to draw at each XYZ point</param> + <returns>The <see cref="T:SciChart.Charting3D.Primitives.IPointsMesh" /> which can be used for creating dynamic 3D points on the fly</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.BeginSolidMesh(System.Boolean)"> + <summary> + <para>Begins an Immediate Solid Mesh, which can be used to draw dynamic 3D planes on the fly.</para> + </summary> + <returns>The <see cref="T:SciChart.Charting3D.Visuals.Primitives.ISolidMesh" /> which can be used for creating dynamic 3D planes on the fly.</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.SetRenderPassData(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Sets the current <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" />, which contains the data needed for this render pass. + </summary> + <param name="e">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" />.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.GetEntity``1"> + <summary> + Gets the first child entity of type <typeparamref name="T" /></summary> + <typeparam name="T">The type of entity to search for</typeparam> + <returns>The entity instance, or default{T}</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.PerformSelection(System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection on this entity, setting the IsSelected flag to True or False on the specified <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="isSelected">if set to <c>true</c> the vertices become .</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.GetKind"> + <summary> + Gets Scene Entity Kind that determines rendering pass during which scene entity has to be rendered. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Dispose"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.InvalidateScene"> + <summary> + Forces the entire scene to redraw + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.OnAttached"> + <summary> + Called immediately after an entity is attached to a parent + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.OnDetached"> + <summary> + Called immediately before an entity is detached from a parent + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.AttachChild(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Attaches a <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" /> to the <see cref="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Children" /> collection. + </summary> + <param name="entity">The entity.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.DetachChild(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Detaches a <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" /> and removes from the <see cref="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Children" /> collection + </summary> + <param name="entity">The entity.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.VisitEntities(System.Action{SciChart.Charting3D.Primitives.IBaseSceneEntity})"> + <summary> + <para>Implements the Visitor Pattern, visiting all Child entities (and their children) performing the operation on each one.</para> + <para>Use this when you want to set a property on all entities in the scene, or perform a certain function on all entities</para> + </summary> + <param name="operation">The operation.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.BaseSceneEntity`1.OnChildEntitiesCollectionChanged(System.Object,System.Collections.Specialized.NotifyCollectionChangedEventArgs)"> + <summary> + Called when the <see cref="P:SciChart.Charting3D.Primitives.BaseSceneEntity`1.Children" /> child entities collection changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Collections.Specialized.NotifyCollectionChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.BlendStates"> + <summary> + Provides Blend State options to the 3D renderer + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BlendStates.Default"> + <summary> + The Default Depth Stencil State: Alpha Blend is disabled + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BlendStates.AlphaBlendState"> + <summary> + The Alpha Blend State: Alpha Blend is enabled + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BlendStates.HudAlphaBlendState"> + <summary> + The HUD Alpha Blend State: Alpha Blend is enabled for first render target only ( preserves hit-test ) + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.BlendStates.TSRBlendState"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.Primitives.BlendStates.TSRBlendState" /> - the wrapper object sent to 3D Engine + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.DefaultEntityIdProvider"> + <summary> + <para>An <see cref="T:SciChart.Charting3D.Primitives.IEntityIdProvider" /> encodes into a single <see cref="T:System.UInt32" /> a unique ID to identify a mesh and a vertex.</para> + <para>This means there is a maximum count of 4 Billion vertices in the scene, but the UInt32 must be split into two parts <see cref="T:System.UInt32" /> VertexID and <see cref="T:System.UInt32" /> Entity (Mesh ID).</para> + <para>The EntityIdprovider accepts integer entity/vertex ID and encodes into a single <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> struct. It can also decode from <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> back into Mesh and Vertex ID.</para> + <para>The <see cref="T:SciChart.Charting3D.Primitives.DefaultEntityIdProvider" /> encodes with a schema of 10-bits for EntityId and 22-bits for VertexId. This means the 3D scene can have a maximum of 1024 meshes, and each mesh can have a maximum of 4 million vertices</para> + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.MaxBitsCount"> + <summary> + Maximal allowed number of bits in an ID. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.DefaultEntityIdProvider" /> class. + </summary> + <param name="meshBits">The mesh bits (number of bits out of 32 used to encode Entity ID).</param> + <param name="vertexBits">The vertex bits (number of bits out of 32 used to encode Vertex ID).</param> + <exception cref="T:System.ArgumentException">MeshBits + VertexBits must be positive and add up to 32bits, e.g. MeshBits=10, VertexBits=22. Please choose how many bits in the unsigned integer (32bit) to assign to MeshID and how many to VertexId</exception> + </member> + <member name="P:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.MaxMeshId"> + <summary> + Gets the maximum mesh ID. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.MaxVertexId"> + <summary> + Gets the maximum vertex ID + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.GetEntityId"> + <summary> + Gets the next available Entity ID + </summary> + <returns></returns> + <exception cref="T:System.InvalidOperationException">The Maximum Mesh ID has been exceeded. Please see www.scichart.com/maximum-mesh-id</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.EncodeVertexId(System.UInt32,System.UInt32)"> + <summary> + Encodes the vertex identifier. + </summary> + <param name="entityId">The entity identifier.</param> + <param name="vertexId">The vertex identifier.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.DefaultEntityIdProvider.DecodeVertexId(SciChart.Charting3D.Primitives.VertexId,System.UInt32@,System.UInt32@)"> + <summary> + Encodes a 32-bit <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> into <see cref="T:System.UInt32">Entity ID</see> and <see cref="T:System.UInt32">Vertex ID</see> according to the schema that this EntityIdProvider uses + </summary> + <param name="vertexId">The VertexId</param> + <param name="entity">The entity Id.</param> + <param name="vertex">The vertex Id.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.DepthStencilStates"> + <summary> + Provides Depth Stencil options to the 3D renderer + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.DepthStencilStates.Default"> + <summary> + The Default Depth Stencil State: Depth test is enabled + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.DepthStencilStates.DepthTestDisabledState"> + <summary> + The Disabled Depth Stencil State: Depth test is disabled + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.DepthStencilStates.DepthWriteDisabledState"> + <summary> + The Disabled Depth Stencil State: Depth write is disabled + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.DepthStencilStates.TSRDepthStencilState"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.Primitives.DepthStencilStates.TSRDepthStencilState" /> - the wrapper object sent to 3D Engine + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.VertexId"> + <summary> + VertexId is a single 32-bit struct to store encoded vertex and entity IDs + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.VertexId.Id"> + <summary> + The identifier - an encoded 32-bit Id which combines vertex and mesh ID + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.EntityVertexId"> + <summary> + EntityVertexId is a 64-bit struct to store decoded vertex and entity IDs + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.EntityVertexId.EntityId"> + <summary> + The entity identifier + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.EntityVertexId.VertexId"> + <summary> + The vertex identifier + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.IEntityIdProvider"> + <summary> + <para>An EntityIdProvider encodes into a single <see cref="T:System.UInt32" /> a unique ID to identify a mesh and a vertex.</para> + <para>This means there is a maximum count of 4 Billion vertices in the scene, but the UInt32 must be split into two parts <see cref="T:System.UInt32" /> VertexID and <see cref="T:System.UInt32" /> Entity (Mesh ID).</para> + <para>The EntityIdprovider accepts integer entity/vertex ID and encodes into a single <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> struct. It can also decode from <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> back into Mesh and Vertex ID.</para> + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IEntityIdProvider.GetEntityId"> + <summary> + Gets the next available Entity ID. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IEntityIdProvider.ReleaseEntityId(System.UInt32)"> + <summary> + Releases the <paramref name="id" /> and puts it back into an <see cref="T:SciChart.Core.ObjectPool`1" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IEntityIdProvider.EncodeVertexId(System.UInt32,System.UInt32)"> + <summary> + Encodes a <see cref="T:System.UInt32">Entity ID</see> and <see cref="T:System.UInt32">Vertex ID</see> into a single 32-bit <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> struct according to the schema that this EntityIdProvider uses. + </summary> + <param name="entity">The entity Id.</param> + <param name="vertex">The vertex Id.</param> + <returns>The encoded VertexId</returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.IEntityIdProvider.DecodeVertexId(SciChart.Charting3D.Primitives.VertexId,System.UInt32@,System.UInt32@)"> + <summary> + Encodes a 32-bit <see cref="T:SciChart.Charting3D.Primitives.VertexId" /> into <see cref="T:System.UInt32">Entity ID</see> and <see cref="T:System.UInt32">Vertex ID</see> according to the schema that this EntityIdProvider uses. + </summary> + <param name="vertexId">The VertexId</param> + <param name="entity">The entity Id.</param> + <param name="vertex">The vertex Id.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.IImmediateLineContext"> + <summary> + Defines a drawing context which draws dynamic lines in 3D space + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.ImmediateLineContext"> + <summary> + Defines a drawing context which draws dynamic lines in 3D space + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLineContext.#ctor(System.Single)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.ImmediateLineContext" /> class. + </summary> + <param name="strokeThickness">The stroke thickness of the line.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLineContext.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLineContext.SetVertexColor(System.UInt32)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="colorArgb">32-bit representation of ARGB color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLineContext.SetVertex3(System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z position of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLineContext.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.IMeshBase"> + <summary> + Defines the interface to a Mesh, a re-usable 3D model which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IMeshBase.Freeze"> + <summary> + Freezes this instance. No further drawing may be done + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IMeshBase.Draw"> + <summary> + Draws this instance. + </summary> + <exception cref="T:System.InvalidOperationException">Must call ImmediatePointsContext.Freeze() to complete the vertices before calling Draw()</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.IMeshBase.SetVertex4(System.Single,System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z,W value of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + <param name="w">The w parameter, often the size.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IMeshBase.SetSelectionId(System.UInt64)"> + <summary> + Sets the selection identifier for the current vertex + </summary> + <param name="selectionId">The selection identifier.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IMeshBase.SetOpacity(System.Single)"> + <summary> + Sets the opacity for the current vertex + </summary> + <param name="opacity">The opacity.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.IImmediateDrawContext"> + <summary> + Defines the interface to a Draw Context in 3D + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateDrawContext.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateDrawContext.SetVertexColor(System.UInt32)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="colorArgb">32-bit representation of ARGB color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateDrawContext.SetVertex3(System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z position of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.IImmediateLitMeshContext"> + <summary> + Defines the interface to a Drawing Context which draws 3D Meshes dynamically on the fly + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateLitMeshContext.TexCoord2(System.Single,System.Single)"> + <summary> + Sets the Texture Coordinate for the current vertex + </summary> + <param name="u">The u coord.</param> + <param name="v">The v coord.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateLitMeshContext.Normal3(System.Single,System.Single,System.Single)"> + <summary> + Sets the Normal for the current vertex + </summary> + <param name="nx">The normal x coord.</param> + <param name="ny">The normal y coord.</param> + <param name="nz">The normal z coord.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateLitMeshContext.SetSelectionId(System.UInt64)"> + <summary> + Sets the selection identifier for the current vertex + </summary> + <param name="selectionId">The selection identifier.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.ImmediateLitMeshContext"> + <summary> + Defines a Drawing Context which draws 3D Meshes dynamically on the fly + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.#ctor(SciChart.Charting3D.Primitives.TSRRenderMode)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.ImmediateMeshContext" /> class. + </summary> + <param name="renderMode">The render mode.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.#ctor(SciChart.Charting3D.Primitives.TSRRenderMode,SciChart.Charting3D.Interop.TSRShaderEffect)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.ImmediateMeshContext" /> class. + </summary> + <param name="renderMode">The render mode.</param> + <param name="pShaderEffect">The p shader effect.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.SetVertexColor(System.UInt32)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="colorArgb">32-bit representation of ARGB color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.SetVertex3(System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z position of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.TexCoord2(System.Single,System.Single)"> + <summary> + Sets the Texture Coordinate for the current vertex + </summary> + <param name="u">The u coord.</param> + <param name="v">The v coord.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.Normal3(System.Single,System.Single,System.Single)"> + <summary> + Sets the Normal for the current vertex + </summary> + <param name="nx">The normal x coord.</param> + <param name="ny">The normal y coord.</param> + <param name="nz">The normal z coord.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateLitMeshContext.SetSelectionId(System.UInt64)"> + <summary> + Sets the selection identifier for the current vertex + </summary> + <param name="selectionId">The selection identifier.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.TSRRenderMode"> + <summary> + Mapping enumeration constants for the DirectX Primitive Type + </summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.TRIANGLES"> + <summary>Renders meshes as Triangles</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.TRIANGLEFAN"> + <summary>Renders meshes as TriangleFan</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.TRIANGLESTRIP"> + <summary>Renders meshes as Triangle Strip</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.LINESTRIP"> + <summary>Renders meshes as LineStrip</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.LINELIST"> + <summary>Renders meshes as LineList</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.POINTS"> + <summary>Renders meshes as Points</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.LINEPATCHLIST"> + <summary>Renders meshes as LinePatchList</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.TRIPATCHLIST"> + <summary>Renders meshes as TrianglePatchList</summary> + </member> + <member name="F:SciChart.Charting3D.Primitives.TSRRenderMode.QUADPATCHLIST"> + <summary>Renders meshes as QuadPatchList</summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.IImmediateMeshContext"> + <summary> + Defines the interface to a Drawing Context which draws 3D Meshes dynamically on the fly + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.IImmediateMeshContext.TexCoord2(System.Single,System.Single)"> + <summary> + Sets the Texture Coordinate for the current vertex + </summary> + <param name="u">The u coord.</param> + <param name="v">The v coord.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.ImmediateMeshContext"> + <summary> + Defines a Drawing Context which draws 3D Meshes dynamically on the fly + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.#ctor(SciChart.Charting3D.Primitives.TSRRenderMode)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.ImmediateMeshContext" /> class. + </summary> + <param name="renderMode">The render mode.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.#ctor(SciChart.Charting3D.Primitives.TSRRenderMode,SciChart.Charting3D.Interop.TSRShaderEffect)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.ImmediateMeshContext" /> class. + </summary> + <param name="renderMode">The render mode.</param> + <param name="pShaderEffect">The p shader effect.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.SetVertexColor(System.UInt32)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="colorArgb">32-bit representation of ARGB color.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.SetVertex3(System.Single,System.Single,System.Single)"> + <summary> + Sets the X,Y,Z position of the current vertex + </summary> + <param name="x">The x.</param> + <param name="y">The y.</param> + <param name="z">The z.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ImmediateMeshContext.TexCoord2(System.Single,System.Single)"> + <summary> + Sets the Texture Coordinate for the current vertex + </summary> + <param name="u">The u coord.</param> + <param name="v">The v coord.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.ILinesMesh"> + <summary> + Defines the interface to a LinesMesh, a re-usable 3D model consisting of lines which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.ILinesMesh.SetVertex3(SciChart.Charting3D.Vector3)"> + <summary> + Sets a position of the current vertex. + </summary> + <param name="xyzVector">The <see cref="T:SciChart.Charting3D.Vector3" /> which defines the position.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ILinesMesh.SetVertices(SciChart.Charting3D.Interop.sIMLineVertex[],System.Int32,System.Boolean)"> + <summary> + Sets raw vertices on the lines mesh. the vertex format is <see cref="T:SciChart.Charting3D.Interop.sIMLineVertex" /> and each 1 vertex represents a line segment, with start and end position + </summary> + <param name="vertices">The vertices.</param> + <param name="vertCount">The vertex count.</param> + <param name="hasTransparentColors">if set to true, then one or more vertex has semi-transparent colours. This determines whether alpha blending is used.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ILinesMesh.SetData(System.UInt32,System.Double[],System.Double[],System.Double[],System.UInt32[],System.Int32,System.Boolean)"> + <summary> + Sets the data on the Lines Mesh, which causes the mesh to calculate <see cref="T:SciChart.Charting3D.Interop.sIMLineVertex" /> line vertices. + </summary> + <param name="entityId">The entity identifier.</param> + <param name="xCoordinates">The x coordinates in world space.</param> + <param name="yCoordinates">The y coordinates in world space.</param> + <param name="zCoordinates">The z coordinates in world space.</param> + <param name="colors">The colors as ARGB.</param> + <param name="pointCount">The point count.</param> + <param name="hasTransparentColors">if set to true, then one or more vertex has semi-transparent colours. This determines whether alpha blending is used.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.ILinesMesh.SetData(System.UInt32,System.Double[],System.Double[],System.Double[],System.UInt32,System.Int32,System.Boolean)"> + <summary> + Sets the data on the Lines Mesh, which causes the mesh to calculate <see cref="T:SciChart.Charting3D.Interop.sIMLineVertex" /> line vertices. + </summary> + <param name="entityId">The entity identifier.</param> + <param name="xCoordinates">The x coordinates in world space.</param> + <param name="yCoordinates">The y coordinates in world space.</param> + <param name="zCoordinates">The z coordinates in world space.</param> + <param name="color">The constant line color as ARGB.</param> + <param name="pointCount">The point count.</param> + <param name="hasTransparentColors">if set to true, then one or more vertex has semi-transparent colours. This determines whether alpha blending is used.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.LinesMesh"> + <summary> + Defines a re-usable 3D model consisting of lines which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.LinesMesh.#ctor(System.Single,System.Boolean,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.LinesMesh" /> class. + </summary> + <param name="lineThickness">The line thickness.</param> + <param name="isStrips">if set to <c>true</c> lines are drawn as discontinuous strips.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.LinesMesh.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.LinesMesh.SetVertex3(SciChart.Charting3D.Vector3)"> + <summary> + Sets a position of the current vertex. + </summary> + <param name="xyzVector">The <see cref="T:SciChart.Charting3D.Vector3" /> which defines the position.</param> + </member> + <member name="T:SciChart.Charting3D.Primitives.PointsInstancesMesh"> + <summary> + Defines a re-usable 3D model consisting of Instance based (3D mesh) points which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.PointsInstancesMesh.#ctor(System.Single,SciChart.Charting3D.PointMarkers.BasePointMarker3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.PointsMesh" /> class. + </summary> + <param name="pointSize">Size of the point.</param> + <param name="pointMarker">The point marker.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.PointsInstancesMesh.Draw"> + <summary> + Draws this instance. + </summary> + <exception cref="T:System.InvalidOperationException">Must call ImmediatePointsContext.Freeze() to complete the vertices before calling Draw()</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.PointsInstancesMesh.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="T:SciChart.Charting3D.Primitives.IPointsMesh"> + <summary> + Defines the interface to a PointsMesh, a re-usable 3D model consisting of points which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.PointsMesh"> + <summary> + Defines a re-usable 3D model consisting of Texture based (flat) points which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.PointsMesh.#ctor(System.Single,SciChart.Charting3D.PointMarkers.BasePointMarker3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Primitives.PointsMesh" /> class. + </summary> + <param name="pointSize">Size of the point.</param> + <param name="pointMarker">The point marker.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.PointsMesh.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="T:SciChart.Charting3D.Primitives.PointsPixelsMesh"> + <summary> + Defines a re-usable 3D model consisting of pixel points which may be dynamically created, frozen, and repeatedly drawn + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.PointsPixelsMesh.SetVertexColor(System.Windows.Media.Color)"> + <summary> + Sets the Vertex Color of the current vertex + </summary> + <param name="color">The color.</param> + <exception cref="T:System.InvalidOperationException">This instance is frozen and no further modifications may be made</exception> + </member> + <member name="T:SciChart.Charting3D.Primitives.RasterizerStates"> + <summary> + Provides Blend State options to the 3D renderer + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RasterizerStates.Default"> + <summary> + The Default Rasterizer Stencil State: filling double side + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RasterizerStates.CullBackFacesState"> + <summary> + The cull back face state + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RasterizerStates.WireframeState"> + <summary> + The wire frame state + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RasterizerStates.CoplanarLinesState"> + <summary> + coplanar lines state + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RasterizerStates.TSRRasterizerState"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Interop.TSRBlendState" /> - the wrapper object sent to 3D Engine + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D"> + <summary> + Defines constants and parameters for the current render pass + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.XCalc"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.SciChart3DSurface.XAxis" /> CoordinateCalculator, + which transforms data-coordinates to world coordinates in the 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.YCalc"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.SciChart3DSurface.YAxis" /> CoordinateCalculator, + which transforms data-coordinates to world coordinates in the 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.ZCalc"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ZAxis" /> CoordinateCalculator, + which transforms data-coordinates to world coordinates in the 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.HasChanges"> + <summary> + Gets or sets a value indicating whether the scene has changes, requiring a re-build of geometry + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.Warnings"> + <summary> + Gets or sets a list of warnings outputted during render + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.WorldDimensions"> + <summary> + Gets or sets the WorldDimensions on the parent SciChart3DSurface + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.WorldClipPlanes"> + <summary> + Gets or sets clip planes on the parent SciChart3DSurface + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.IRenderPassInfo3D.SceneDescriptor"> + <summary> + Gets or sets the SceneDescriptor, which contains information for the current scene to be drawn + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.RenderPassInfo3D"> + <summary> + Defines constants and parameters for the current render pass + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.XCalc"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.SciChart3DSurface.XAxis" /> CoordinateCalculator, + which transforms data-coordinates to world coordinates in the 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.YCalc"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.SciChart3DSurface.YAxis" /> CoordinateCalculator, + which transforms data-coordinates to world coordinates in the 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.ZCalc"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ZAxis" /> CoordinateCalculator, + which transforms data-coordinates to world coordinates in the 3D scene + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.HasChanges"> + <summary> + Gets or sets a value indicating whether the scene has changes, requiring a re-build of geometry + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.Warnings"> + <summary> + Gets or sets a list of warnings outputted during render + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.WorldDimensions"> + <summary> + Gets or sets the WorldDimensions on the parent SciChart3DSurface + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.WorldClipPlanes"> + <summary> + Gets or sets clip planes on the parent SciChart3DSurface + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.RenderPassInfo3D.SceneDescriptor"> + <summary> + Gets or sets the SceneDescriptor, which contains information for the current scene to be drawn + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.ISceneDescriptor"> + <summary> + The SceneDescriptor passes information from WPF about the scene to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ISceneDescriptor.DrawFps"> + <summary> + When True, draw the FPS Counter in the bottom left of the Viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ISceneDescriptor.DrawXyzGizmo"> + <summary> + When True, draw the XYZ Orientation Gizmo in the bottom left of the Viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ISceneDescriptor.AxisCubeDescriptor"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Primitives.IAxisCubeDescriptor" />, which passes information from WPF about the Axis Cube to the 3D Engine + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.SceneDescriptor"> + <summary> + The SceneDescriptor passes information from WPF about the scene to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.SceneDescriptor.DrawFps"> + <summary> + When True, draw the FPS Counter in the bottom left of the Viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.SceneDescriptor.DrawXyzGizmo"> + <summary> + When True, draw the XYZ Orientation Gizmo in the bottom left of the Viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.SceneDescriptor.AxisCubeDescriptor"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Primitives.IAxisCubeDescriptor" />, which passes information from WPF about the Axis Cube to the 3D Engine + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.SceneEntityCollection"> + <summary> + Facade type for the SCRTObservableCollection^ IBaseSceneEntity* ^ native type. + Type is designed for ease of use of the Children collection property of a XXXSceneEntity type in the WPF environment. + Note, this type is thread unsafe and it doesn't collation modification during iterations ( doesn't throw InvalidOperationException: Collection Was Modified ) + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.SceneEntityCollection.UnresolvedResolvedPair"> + <summary> + Type down-casting unresolved / resolved pair of same native instance. + Used for holding string reference to unresolved SWIG generated type, + to avoid unnecessary GC collection of it after each query to the native collection. + </summary> + </member> + <member name="E:SciChart.Charting3D.Primitives.SceneEntityCollection.CollectionChanged"> + <summary> + Occurs when the collection changes. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.SceneEntityCollection.Count"> + <summary> + Gets the number of elements contained in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />. + </summary> + <returns>The number of elements contained in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</returns> + </member> + <member name="P:SciChart.Charting3D.Primitives.SceneEntityCollection.IsReadOnly"> + <summary> + Gets a value indicating whether the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only. + </summary> + <returns>true if the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only; otherwise, false.</returns> + </member> + <member name="P:SciChart.Charting3D.Primitives.SceneEntityCollection.Item(System.Int32)"> + <summary>Gets or sets the element at the specified index.</summary> + <returns>The element at the specified index.</returns> + <param name="index">The zero-based index of the element to get or set.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index" /> is not a valid index in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</exception> + <exception cref="T:System.NotSupportedException">The property is set and the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only.</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.GetItemEntityID(System.Int32)"> + <summary> + get the entity id of an item in the collection using its index + this works if the entities are totoally on c++ side + </summary> + <param name="index"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.GetEnumerator"> + <summary>Returns an enumerator that iterates through the collection.</summary> + <returns>A <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> that can be used to iterate through the collection.</returns> + <filterpriority>1</filterpriority> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.System#Collections#IEnumerable#GetEnumerator"> + <summary>Returns an enumerator that iterates through a collection.</summary> + <returns>An <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> object that can be used to iterate through the collection.</returns> + <filterpriority>2</filterpriority> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Add(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Adds an item to the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />. + </summary> + <param name="item">The object to add to the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</param> + <exception cref="T:System.NotSupportedException">The <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only.</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Clear"> + <summary> + Removes all items from the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />. + </summary> + <exception cref="T:System.NotSupportedException">The <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only. </exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Contains(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary>Determines whether the <see cref="T:SceneEntityCollection" /> contains a specific value.</summary> + <returns>true if <paramref name="item" /> is found in the <see cref="T:SceneEntityCollection" />; otherwise, false.</returns> + <param name="item">The object to locate in the <see cref="T:SceneEntityCollection" />.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.ContainsById(System.UInt32)"> + <summary>Determines whether the <see cref="T:SceneEntityCollection" /> contains a scene entity by the specified ID.</summary> + <returns>true if an item" is found in the <see cref="T:SceneEntityCollection" />; otherwise, false.</returns> + <param name="id">ID of the object to locate in the <see cref="T:SceneEntityCollection" />.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.CopyTo(SciChart.Charting3D.Primitives.IBaseSceneEntity[],System.Int32)"> + <summary>Copies the elements of the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> to an <see cref="T:System.Array" />, starting at a particular <see cref="T:System.Array" /> index.</summary> + <param name="array">The one-dimensional <see cref="T:System.Array" /> that is the destination of the elements copied from <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />. The <see cref="T:System.Array" /> must have zero-based indexing.</param> + <param name="offset">The zero-based index in <paramref name="array" /> at which copying begins.</param> + <exception cref="T:System.ArgumentNullException"> + <paramref name="array" /> is null.</exception> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="offset" /> is less than 0.</exception> + <exception cref="T:System.ArgumentException">The number of elements in the source <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is greater than the available space from <paramref name="offset" /> to the end of the destination <paramref name="array" />.</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Remove(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary>Removes the first occurrence of a specific object from the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</summary> + <returns>true if <paramref name="item" /> was successfully removed from the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />; otherwise, false. This method also returns false if <paramref name="item" /> is not found in the original <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</returns> + <param name="item">The object to remove from the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</param> + <exception cref="T:System.NotSupportedException">The <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only.</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.IndexOf(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Determines the index of a specific item in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />. + </summary> + <returns>The index of <paramref name="item" /> if found in the list; otherwise, -1.</returns> + <param name="item">The object to locate in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Insert(System.Int32,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary>Inserts an item to the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> at the specified index.</summary> + <param name="index">The zero-based index at which <paramref name="item" /> should be inserted.</param> + <param name="item">The object to insert into the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index" /> is not a valid index in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</exception> + <exception cref="T:System.NotSupportedException">The <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only.</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.RemoveAt(System.Int32)"> + <summary>Removes the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> item at the specified index.</summary> + <param name="index">The zero-based index of the item to remove.</param> + <exception cref="T:System.ArgumentOutOfRangeException"> + <paramref name="index" /> is not a valid index in the <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" />.</exception> + <exception cref="T:System.NotSupportedException">The <see cref="T:SciChart.Charting3D.Primitives.SceneEntityCollection" /> is read-only.</exception> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Dispose"> + <inheritdoc /> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.Dispose(System.Boolean)"> + <summary> + This method is defined in regards to basic implementation of the Dispose Pattern + </summary> + <param name="disposing">Disposing if true; otherwise finalizing.</param> + </member> + <member name="M:SciChart.Charting3D.Primitives.SceneEntityCollection.ContainsManagedRef(SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Determines if internal managed references map contains passed reference. + </summary> + <param name="item">Reference to check whether is contained.</param> + <returns> + <c>ture</c> if contains; otherwise <c>false</c>.</returns> + </member> + <member name="T:SciChart.Charting3D.Primitives.TextAlignment"> + <summary> + Enumarates possible types of text alignment. + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.ITextStyle"> + <summary> + Defines the interface to a class which passes Text Style information from WPF to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ITextStyle.FontFamily"> + <summary> + Gets or sets the font family. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ITextStyle.FontSize"> + <summary> + Gets or sets the font size. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ITextStyle.Foreground"> + <summary> + Gets or sets the font color. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ITextStyle.Alignment"> + <summary> + Gets or sets a type of the text aligned. + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.TextStyle"> + <summary> + A class which passes Text Style information from WPF to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.TextStyle.FontFamily"> + <summary> + Gets or sets the font family. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.TextStyle.FontSize"> + <summary> + Gets or sets the font size. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.TextStyle.DpiScaling"> + <summary> + Gets or sets the DPI Scaling factor, e.g. 1.0f = normal 96 DPI. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.TextStyle.Foreground"> + <summary> + Gets or sets the font color. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.TextStyle.Alignment"> + <summary> + Gets or sets a type of the text aligned. + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.ILineStyle"> + <summary> + Defines the interface to a class which passes Line Style information from WPF to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ILineStyle.Stroke"> + <summary> + Gets or sets the stroke. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ILineStyle.StrokeThickness"> + <summary> + Gets or sets the stroke thickness. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ILineStyle.X1"> + <summary> + Gets or sets the x1 position of the line (e.g. when drawing ticks, x1, x2 specify the tick length) + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ILineStyle.X2"> + <summary> + Gets or sets the x2 position of the line (e.g. when drawing ticks, x1, x2 specify the tick length) + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.ILineStyle.StrokeDashArray"> + <summary> + Gets or sets the stroke dash array. + </summary> + </member> + <member name="T:SciChart.Charting3D.Primitives.LineStyle"> + <summary> + A class which passes Line Style information from WPF to the 3D Engine + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.LineStyle.Stroke"> + <summary> + Gets or sets the stroke. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.LineStyle.StrokeThickness"> + <summary> + Gets or sets the stroke thickness. + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.LineStyle.X1"> + <summary> + Gets or sets the x1 position of the line (e.g. when drawing ticks, x1, x2 specify the tick length) + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.LineStyle.X2"> + <summary> + Gets or sets the x2 position of the line (e.g. when drawing ticks, x1, x2 specify the tick length) + </summary> + </member> + <member name="P:SciChart.Charting3D.Primitives.LineStyle.StrokeDashArray"> + <summary> + Gets or sets the stroke dash array. + </summary> + </member> + <member name="M:SciChart.Charting3D.Primitives.LineStyle.FromStyle(System.Windows.Shapes.Line,SciChart.Charting3D.Primitives.LineStyle,System.Windows.Style,System.String)"> + <summary> + Converts a <see cref="T:System.Windows.Style" /> with TargetType Line to <see cref="T:SciChart.Charting3D.Primitives.LineStyle" /></summary> + <param name="style">The style.</param> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2"> + <summary> + A base class for a <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" /> which uses <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`3" /> data as input, and transforms + into scene geometry + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.PerformSelection(SciChart.Charting3D.Model.IDataSeries3D,System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection, setting the <paramref name="isSelected" /> flag to true or false on the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> for the given list of <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="dataSeries">The data series.</param> + <param name="isSelected">if set to <c>true</c> [is selected].</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.GetXyzDataValue(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the hit data value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid + Vector3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.GetMetadata(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the Metadata value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <param name="hitTestInfo">The hit test information.</param> + <param name="lastPointSeries"></param> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid or if metadata not supported on this series type. + IPointMetadata3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.ToPointSeries(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D)"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IGridPointSeries3D" /> derived type, for use during the render pass + </summary> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.GetPoints3DData(`0,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,`1@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.GetPoints3DHeightmapData(`0,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.HeightmapData@)"> + <summary> + Transforms data from an IPointSeries3D into <see cref="T:SciChart.Charting3D.RenderableSeries.HeightmapData" /> type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseGridMeshSceneEntityHelper`2.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,System.Windows.Media.Media3D.Vector3D},System.Func{System.Windows.Media.Media3D.Vector3D,SciChart.Charting3D.Vector3},System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D"> + <summary> + Defines the Base class for all BaseRenderableSeries3D within SciChart3D. + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> data-source, + and provides configuration properties to draw a series or surface type onto a specific <see cref="T:SciChart.Charting3D.SciChart3DSurface" />. + A given <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> may have 0..N <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, each of which may map to, or share a <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /></remarks> + <seealso cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DataSeriesProperty"> + <summary> + Defines the DataSeries DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.IsSelectedProperty"> + <summary> + Defines the IsSelected DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.StrokeProperty"> + <summary> + Defines the Stroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DiffuseColorProperty"> + <summary> + Defines the diffuse color property + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.SpecularColorProperty"> + <summary> + Defines the specular color property + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PaletteProviderProperty"> + <summary> + Defines the PaletteProvider DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.IsVisibleProperty"> + <summary> + Defines the IsVisible DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.LegendMarkerTemplateProperty"> + <summary> + Defines the LegendMarkerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PointMarkerTemplateProperty"> + <summary> + Defines the PointMarkerTemplate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PointMarkerProperty"> + <summary> + Defines the PointMarker DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.ShininessProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Shininess" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.SpecularStrengthProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.SpecularStrength" /> DependencyProperty + </summary> + </member> + <member name="E:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.IsVisibleChanged"> + <summary> + Event raised whenever IsVisible property changed + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DataSeries"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> associated with this <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.HasChanges"> + <summary> + Gets or whether this instance has changes. When true, caches will be invalidated and the entire series drawn afresh. When false, where possible vertices will be cached + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.IsVisible"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. ServiceContainers are created one per + <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> instance, and shared between peripheral components such as <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" />, <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, <see cref="T:SciChart.Charting3D.Modifiers.IChartModifier3D" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.IsSelected"> + <summary> + Gets or sets the IsSelectedProperty. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Stroke"> + <summary> + Gets or sets the Stroke + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DiffuseColor"> + <summary> + Gets or sets the material diffuse color + </summary> + </member> + <!-- Badly formed XML comment ignored for member "P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.SpecularColor" --> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PaletteProvider"> + <summary> + Gets or sets an optional <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance, which may be used to colour vertices or points on the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />. + For more information, please see the derived types of <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" />, which are specific per renderable series type + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.LegendMarkerTemplate"> + <summary> + Gets or sets the DataTemplate, which defines how the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> is rendered on the <see cref="T:SciChart.Charting.Visuals.SciChartLegend" /> as a series marker. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PointMarkerTemplate"> + <summary> + <para>Gets or sets the point marker template. </para> + <para>NOTE: This is for instantiating <see cref="T:SciChart.Charting3D.PointMarkers.BasePointMarker3D" /> types in a template fashion only. It does not respond to WPF ControlTemplates</para> + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PointMarker"> + <summary> + Gets or sets the point marker which may be rendered at points on the 3D series. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Shininess"> + <summary> + Gets or sets a shininees from 0.0f - 1024.0f which defines how much the surface material is shining + small values tend to have more shines overall the entire surface, think like rubber + higher values will mean more focused shines, like plastic + a default value of 64.0 is used + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.SpecularStrength"> + <summary> + Gets or sets a specular strength which defines how bright and visible is the shining spot + + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.OnVisibilityChanged"> + <summary> + Called when the Visibility Changes + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.OnDependencyPropertyChanged(System.Boolean)"> + <summary> + Causes the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> to invalidate, setting the HasChanges flag + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.InvalidateWithHasChanges(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Causes the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> to invalidate (redraw) with the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.HasChanges" /> flag set, which triggers a slower update and regeneration of geometry + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.InvalidateWithoutHasChanges(System.Windows.DependencyObject,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Causes the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> to invalidate (redraw) without the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.HasChanges" /> flag set, which triggers a faster update without regeneration of geometry + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.OnDataContextChanged(System.Object,System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the DataContext property changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.GetParentSurface"> + <summary> + Gets the parent <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /> for this <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.OnBeforeDraw"> + <summary> + Called immediately before draw, to setup any constants or data for rendering + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.InvalidateParent"> + <summary> + Passes a message up to the parent that a property has changed and the scene needs invalidating (redrawing) + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.GetXRange"> + <summary> + Returns the data range of the <see cref="T:SciChart.Charting.Visuals.RenderableSeries.IRenderableSeriesBase" /> by querying the associated DataSeries. + Individual RenderableSeries implementations may override this method to provide custom ranging on a per-series basis + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.HitTest(System.Windows.Point)"> + <summary> + Performs a HitTest operation on the series, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + <param name="screenPoint">The screen point (X,Y Pixel coordinates in 2D screen space).</param> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + TODO should not be virtual + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.OnPaletteProviderAttached(SciChart.Charting3D.RenderableSeries.IPaletteProvider3D,SciChart.Charting3D.RenderableSeries.IPaletteProvider3D)"> + <summary> + Called when a new <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance is attached to a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.AssertPaletteProviderType``1(SciChart.Charting3D.RenderableSeries.IPaletteProvider3D)"> + <summary> + Asserts the type of the palette provider <paramref name="p" /> is TPaletteProvider. Throw an exception if not + </summary> + <typeparam name="TPaletteProvider">The type of the palette provider.</typeparam> + <param name="p">The p.</param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.AssertDataSeriesType"> + <summary> + Asserts whether the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DataSeries" /> is of type <see cref="T:SciChart.Charting3D.Model.IXyzDataSeries3D" />. + Throw an exception if not, or if DataSeries is null. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.AssertDataSeriesType``1"> + <summary> + Asserts whether the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.DataSeries" /> is of type T. Throw an exception if not, or if DataSeries is null + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.AttachDataSeries(SciChart.Charting3D.Model.IDataSeries3D)"> + <summary> + Attaches listeners for DataSeries.DataSeriesChanged + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D"> + <summary> + <para>Defines an entity for <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> to draw the series in the 3D Scene.</para> + <para>All types inheriting from <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> have the ability to be positioned and rendered using geometry and primitives defined in the 3D engine</para> + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D.HitTest(System.Windows.Point)"> + <summary> + Performs a HitTest operation on the series, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + <param name="screenPoint">The screen point (X,Y Pixel coordinates in 2D screen space).</param> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Converts a <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> struct, containing information about a Hit-Test operation, into a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />, which is a viewmodel for tooltips, legends in the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> library + </summary> + <param name="hitTestInfo">The hit test information.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D.GetVertexCoords(System.Windows.Media.Media3D.Vector3D)"> + <summary> + Gets the X,Y,Z Vertex coordinate in world-coordinates nearest the Hit-test site specified by <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /></summary> + <returns>The X,Y,Z Vertex in world-coordinates</returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3"> + <summary> + <para>Defines an entity for <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> to draw the series in the 3D Scene.</para> + <para>All types inheriting from <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> have the ability to be positioned and + rendered using geometry and primitives defined in the 3D engine</para> + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3._renderableSeries"> + <summary> + The wrapped <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> instance that we are drawing + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.Helper"> + <summary> + The strategy for dealing with 3D Geometry in the scene for different data schemas + </summary> + </member> + <member name="E:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.EngineRestarted"> + <summary> + Occurs when the D3DEngine has been restarted + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.#ctor(`0,`2)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3" /> class. + </summary> + <param name="renderableSeries">The renderable series.</param> + <param name="nativeEntity">Instance of the corresponding native scene entity.</param> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.IsVisible"> + <summary> + Gets or sets whether this entity is visible or not. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.GetVertexAt(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Gets the X,Y,Z Vertex in world-coordinates nearest the Hit-test site specified by <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /></summary> + <param name="hitTestInfo">The hit test information.</param> + <returns>The X,Y,Z Vertex in world-coordinates</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.GetVertexCoords(System.Windows.Media.Media3D.Vector3D)"> + <summary> + Gets the X,Y,Z Vertex coordinate in world-coordinates nearest the Hit-test site specified by <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /></summary> + <returns>The X,Y,Z Vertex in world-coordinates</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.PerformSelection(System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection on this entity, setting the IsSelected flag to True or False on the specified <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="isSelected">if set to <c>true</c> the vertices become .</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.UpdateScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to update the geometry in this element. This is where we need to cache geometry before draw. + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.ChangeHelper(SciChart.Charting3D.RenderableSeries.ISceneEntityHelper{`0,`1})"> + <summary> + Changes the Scene Entity Helper: a strategy for dealing with 3D Geometry in the scene for different data schemas + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.HitTest(System.Windows.Point)"> + <summary> + Performs a HitTest operation, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + <param name="screenPoint">The screen point (X,Y Pixel coordinates in 2D screen space).</param> + <returns> The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Converts a <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> struct, containing information about a Hit-Test operation, into a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />, which is a viewmodel for tooltips, legends in the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> library + </summary> + <param name="hitTestInfo">The hit test information.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.OnEngineRestart"> + <summary> + Called when the D3DEngine Restarts. Meshes and DirectX related objects should be recreated + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,`1)"> + <summary> + Re-creates all the native 3D meshes from Data + </summary> + <param name="rpi">Actual render pass info.</param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.GetTexture(System.Windows.Media.Brush,System.Int32,System.Int32)"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.Texture2D" /> with the given dimensions and fills it using the <paramref name="brush" />. + </summary> + <param name="brush">A Brush to fill a texture with.</param> + <param name="width">The desired width of a texture.</param> + <param name="height">The desired height of a texture.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.GetBitmap(System.Windows.Media.Brush,System.Int32,System.Int32)"> + <summary> + Creates a <see cref="T:System.Windows.Media.Imaging.WriteableBitmap" /> with the given dimensions and fills it using the <paramref name="brush" />. + </summary> + <param name="brush">A Brush to fill a texture with.</param> + <param name="width">The desired width of a texture.</param> + <param name="height">The desired height of a texture.</param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseRenderableSeriesSceneEntity3D`3.GetHeightMapIndex(System.Int32)"> + <summary> + Gets Height Map Index by specified vertex ID value from selection buffer. + </summary> + <param name="vertexId">Vertex ID value from selection buffer</param> + <returns>Height Map Index</returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1"> + <summary> + A base class for a <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" /> which uses <see cref="T:SciChart.Charting.Model.DataSeries.XyzDataSeries`1" /> data as input, and transforms + into scene geometry + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.PerformSelection(SciChart.Charting3D.Model.IDataSeries3D,System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection, setting the <paramref name="isSelected" /> flag to true or false on the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> for the given list of <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="dataSeries">The data series.</param> + <param name="isSelected">if set to <c>true</c> [is selected].</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.GetXyzDataValue(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the hit data value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid + Vector3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.GetMetadata(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the Metadata value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <param name="hitTestInfo">The hit test information.</param> + <param name="lastPointSeries"></param> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid or if metadata not supported on this series type. + IPointMetadata3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.ToPointSeries(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D)"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IXyzPointSeries3D" /> derived type, for use during the render pass + </summary> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.ArgumentNullException"></exception> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.GetPoints3DData(`0,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BaseXyzSceneEntityHelper`1.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,System.Windows.Media.Media3D.Vector3D},System.Func{System.Windows.Media.Media3D.Vector3D,SciChart.Charting3D.Vector3},System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColorMapPoint"> + <summary> + Specifies a point in a <see cref="T:SciChart.Charting3D.RenderableSeries.LinearColorMap" /></summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColorMapPoint.Color"> + <summary> + The color + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColorMapPoint.Offset"> + <summary> + The offset + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColorMapPoint.ScaleFactor"> + <summary> + The scale factor + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColorMapMode"> + <summary> + Specifies a Color Map mode + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColorMapMode.Interpolated"> + <summary> + Gradient stops are interpolated + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColorMapMode.Stepped"> + <summary> + Gradient stops are Stepped + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.LinearColorMap"> + <summary> + Specifies a Linear Gradient color map + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.LinearColorMap.Mode"> + <summary> + Gets or sets the ColorMapMode + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.LinearColorMap.GradientStops"> + <summary> + The gradient stops + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.LinearColorMap.Minimum"> + <summary> + The minimum + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.LinearColorMap.Maximum"> + <summary> + The maximum + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.LinearColorMap.ScaleFactor"> + <summary> + The scale factor + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.LinearColorMap.InitializeConstants"> + <summary> + Initializes the constants. + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColorUtil"> + <summary> + ColorUtil converts to and from <see cref="T:System.Windows.Media.Color" /> structs and <see cref="T:System.UInt32" /> for use in the 3D renderer + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.ToUInt(System.Windows.Media.Color)"> + <summary> + Converts a <see cref="T:System.Windows.Media.Color" /> struct to <see cref="T:System.UInt32" /></summary> + <param name="color">The color.</param> + <returns>The UInt32 equivalent</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.FromUInt(System.UInt32)"> + <summary> + Converts a <see cref="T:System.UInt32" /> to <see cref="T:System.Windows.Media.Color" /></summary> + <param name="color">The color as UInt32.</param> + <returns>The Color equivalent</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.FromRgb(System.Byte,System.Byte,System.Byte)"> + <summary> + Creates a <see cref="T:System.UInt32" /> Color from R G B values + </summary> + <param name="red">The red value (0-255).</param> + <param name="green">The green value (0-255).</param> + <param name="blue">The blue value (0-255).</param> + <returns> + The UInt32 equivalent + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.FromArgb(System.Byte,System.Byte,System.Byte,System.Byte)"> + <summary> + Creates a <see cref="T:System.UInt32" /> Color from A R G B values + </summary> + <param name="alpha">The alpha value (0-255).</param> + <param name="red">The red value (0-255).</param> + <param name="green">The green value (0-255).</param> + <param name="blue">The blue value (0-255).</param> + <returns> + The UInt32 equivalent + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.Lerp(System.Windows.Media.Color,System.Windows.Media.Color,System.Single)"> + <summary> + Linearly interpolates between two colors based on the ratio passed in. E.g. Ratio = 0.0f returns From color, ratio = 1.0f returns To Color. Ratio = 0.5f returns a mix of the two + </summary> + <param name="from">The From color</param> + <param name="to">The Two color</param> + <param name="ratio">The ratio of the two colors to mix</param> + <returns>A new color formed by (ratio * from) + ((1.0-ratio) * to)</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.Lerp(System.UInt32,System.UInt32,System.Single)"> + <summary> + Linearly interpolates between two colors based on the ratio passed in. E.g. Ratio = 0.0f returns From color, ratio = 1.0f returns To Color. Ratio = 0.5f returns a mix of the two + </summary> + <param name="from">The From color</param> + <param name="to">The Two color</param> + <param name="ratio">The ratio of the two colors to mix</param> + <returns>A new color formed by (ratio * from) + ((1.0-ratio) * to)</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColorUtil.Lerp(SciChart.Charting3D.RenderableSeries.LinearColorMap,System.Double)"> + <summary> + Linearly interpolates a data-value in a <see cref="T:SciChart.Charting3D.RenderableSeries.LinearColorMap" />, which specifies Gradient Stops, Data Minimum and Maximum and color stepping mode + </summary> + <paramref name="colorMap">The LinearColorMap</paramref> + <paramref name="dataValue">The data-value</paramref> + <returns>A linear intepolated color</returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D"> + <summary> + Provides 3D Columns series rendering + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IXyzPointSeries3D" /> or <see cref="T:SciChart.Charting3D.Model.IGridPointSeries3D" /> data-source. + </remarks> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.FillProperty"> + <summary> + Defines the Fill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.SelectedDataPointFillProperty"> + <summary> + Defines the SelectedDataPointFill DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.ColumnShapeProperty"> + <summary> + Defines the ColumnShape DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidthProperty"> + <summary> + Defines the DataPointWidth DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidthXProperty"> + <summary> + Defines the DataPointWidthX DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidthZProperty"> + <summary> + Defines the DataPointWidthZ DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.ColumnSpacingModeProperty"> + <summary> + Defines the ColumnSizeCalculationMode DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.CoulmnFixedSizeProperty"> + <summary> + Defines the FixedSizeCoulmnValue DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.Fill"> + <summary> + Gets or sets the Fill Color for columns + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.SelectedDataPointFill"> + <summary> + Gets or sets the Fill Color for selected data points + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.ColumnShape"> + <summary> + Gets or sets the Shape of the colums. Should be of <see cref="T:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D" /> type + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidth"> + <summary> + Gets or sets the DataPointWidth, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X and Z dimension + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidthX"> + <summary> + Gets or sets the DataPointWidthX, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in X dimension. + This property overrides value from <see cref="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidth" /> property in case it contains less value. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidthZ"> + <summary> + Gets or sets the DataPointWidthZ, a value between 0.0 and 1.0 which defines the fraction of available space each column should occupy in Z dimension + This property overrides value from <see cref="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.DataPointWidth" /> property in case it contains less value. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.ColumnSpacingMode"> + <summary> + Gets or sets value determining how column size and spacing between them is calculated. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.CoulmnFixedSize"> + <summary> + Gets or sets size of column used in Fixed size mode of <see cref="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.ColumnSpacingMode" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.MeshPointMarker3D"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.PointMarkers.BaseMeshPointMarker3D" /> which is defines the columns shape + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity" /> that represent this <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" />. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns>The <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity" /> instance which draws this <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /></returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D.AttachDataSeries(SciChart.Charting3D.Model.IDataSeries3D)"> + <summary> + Attaches listeners for DataSeries.DataSeriesChanged + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity"> + <summary> + A SceneEntity added to the 3D Scene which draws a Column Chart. + See also the <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi"></param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColumnSpacingMode"> + <summary> + Enumerates possible column spacing modes. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnSpacingMode.MaxNonOverlapping"> + <summary> + Max possible column size where columns don't overlap each other in regards to series data points. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ColumnSpacingMode.FixedSize"> + <summary> + Fixed size column mode. + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper"> + <summary> + Defines the interface to a Columns <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" />, which is basically a strategy for dealing with + 3D Geometry in <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /> for different data schemas + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.GetDataPointWidth(SciChart.Charting3D.RenderableSeries.Point3DXyzData,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Double,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Double,System.Int32)"> + <summary> + Gets the width of a Data-Point, depending on data and coordinate transformation + </summary> + <param name="data">Data values.</param> + <param name="xCalc">Coordinate calculator of the X Axis.</param> + <param name="xWidthFraction">The data point width in X.</param> + <param name="zCalc">Coordinate calculator of the Z Axis.</param> + <param name="zWidthFraction">The data point width in Z.</param> + <param name="gridStride"></param> + <returns>the width of a Data-Point, depending on data and coordinate transformation </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.PerformSelection(SciChart.Charting3D.Model.IDataSeries3D,System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection, setting the <paramref name="isSelected" /> flag to true or false on the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> for the given list of <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="dataSeries">The data series.</param> + <param name="isSelected">if set to <c>true</c> [is selected].</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.GetXyzDataValue(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the hit data value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid + Vector3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.GetMetadata(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the Metadata value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <param name="hitTestInfo">The hit test information.</param> + <param name="lastPointSeries"></param> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid or if metadata not supported on this series type. + IPointMetadata3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.ToPointSeries(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D)"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.ArgumentNullException"></exception> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnUniformGridSceneEntityHelper.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,System.Windows.Media.Media3D.Vector3D},System.Func{System.Windows.Media.Media3D.Vector3D,SciChart.Charting3D.Vector3},System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ColumnXyzSceneEntityHelper"> + <summary> + Defines the interface to a Columns <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" />, which is basically a strategy for dealing with + 3D Geometry in <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /> for different data schemas + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnXyzSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData@)"> + <summary> + Transforms data from an IPointSeries3D into a list of data-values (Vector3D) and PointMetadata3D. Used to create the mesh + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ColumnXyzSceneEntityHelper.GetDataPointWidth(SciChart.Charting3D.RenderableSeries.Point3DXyzData,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Double,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Double,System.Int32)"> + <summary> + Gets the width of a Data-Point, depending on data and coordinate transformation + </summary> + <param name="data">Data values.</param> + <param name="xCalc">Coordinate calculator of the X Axis.</param> + <param name="xWidthFraction">The data point width in X.</param> + <param name="zCalc">Coordinate calculator of the Z Axis.</param> + <param name="zWidthFraction">The data point width in Z.</param> + <param name="gridStride"></param> + <returns>the width of a Data-Point, depending on data and coordinate transformation </returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IColumnSceneEntityHelper"> + <summary> + Defines the interface to a Columns <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" />, which is basically a strategy for dealing with + 3D Geometry in <see cref="T:SciChart.Charting3D.RenderableSeries.ColumnRenderableSeries3D" /> for different data schemas + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IColumnSceneEntityHelper.GetDataPointWidth(SciChart.Charting3D.RenderableSeries.Point3DXyzData,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Double,SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double},System.Double,System.Int32)"> + <summary> + Gets the width of a Data-Point, depending on data and coordinate transformation + </summary> + <param name="data">Data values.</param> + <param name="xCalc">Coordinate calculator of the X Axis.</param> + <param name="xWidthFraction">The data point width in X.</param> + <param name="zCalc">Coordinate calculator of the Z Axis.</param> + <param name="zWidthFraction">The data point width in Z.</param> + <param name="gridStride"></param> + <returns>the width of a Data-Point, depending on data and coordinate transformation </returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.FreeSurfacePaletteMinMaxMode"> + <summary> + Enumerates possible mode of a palette of the Free Surface. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfacePaletteMinMaxMode.Relative"> + <summary> + <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinimum" /> and <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximum" /> values + are defined relatively to the offset of the free surface. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfacePaletteMinMaxMode.Absolute"> + <summary> + <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinimum" /> and <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximum" /> values + are defined as absolute X/Y/Z values of the 3D Axis. + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D"> + <summary> + Provides Surface series rendering + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IFreeSurfaceDataSeries3D" /> data-source. + </remarks> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawMeshAsProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawMeshAs" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.StrokeThicknessProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.StrokeThickness" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshColorPaletteProperty"> + <summary> + Defines the <see cref="T:System.Drawing.Imaging.ColorPalette" /> DependencyProperty. Setting this property will overwrite the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture" /> property + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinMaxModeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinMaxMode" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinimumProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinimum" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximumProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximum" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteRadialFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteRadialFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteAxialFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteAxialFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteAzimuthalFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteAzimuthalFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PalettePolarFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PalettePolarFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshPaletteModeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshPaletteMode" /> DependencyProperty, which defines how the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture" /> is applied to the surface geometry + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTextureProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTextureSizeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTextureSize" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.CellHardnessFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.CellHardnessFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourStrokeThicknessProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourStrokeThickness" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourAxisProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourInterval" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourIntervalProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourInterval" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourOffsetProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourOffset" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourStrokeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourStroke" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.HighlightProperty"> + <summary> + Defines the Highlight DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.LightingFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.LightingFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawBackSideProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawBackSide" /> DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourStroke"> + <summary> + Gets or sets the contour <see cref="T:System.Windows.Media.Color" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourOffset"> + <summary> + Gets or sets the contour offset. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourAxis"> + <summary> + Gets or sets a value determining by which 3D axis the contour is calculated. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourInterval"> + <summary> + Gets or sets the contour interval. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ContourStrokeThickness"> + <summary> + Gets or sets contour thickness. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.CellHardnessFactor"> + <summary> + Gets or sets a factor from 0.0f - 1.0f which defines how hard a Cell looks. e.g. 0.0f = smooth and 1.0f = hard faces + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.StrokeThickness"> + <summary> + Gets or sets the stroke thickness to apply to the wireframe. Used when <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawMeshAs" /> is WireFrame or SolidWireFrame + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawMeshAs"> + <summary> + Gets or sets how to draw the mesh + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshColorPalette"> + <summary> + Gets or sets the MeshColorPalette which is used to calculate color from data value + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinMaxMode"> + <summary> + Gets or sets the mode of <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximum" /> and <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximum" /> values. + For more information see: <see cref="T:SciChart.Charting3D.RenderableSeries.FreeSurfacePaletteMinMaxMode" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMinimum"> + <summary> + Gets or sets palette minimum color in regards to X, Y and Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteMaximum"> + <summary> + Gets or sets palette maximum color in regards to X, Y and Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteRadialFactor"> + <summary> + Gets or sets palette color intensity in regards to surface distance from origin. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteAxialFactor"> + <summary> + Gets or sets palette color intensity in regards to X, Y and Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PaletteAzimuthalFactor"> + <summary> + Gets or sets palette color intensity in regards to surface orientation in azimuthal space. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.PalettePolarFactor"> + <summary> + Gets or sets palette color intensity in regards to surface orientation in polar space. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshPaletteMode"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshPaletteMode" />, which defines how to apply the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture" /></summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture"> + <summary> + Gets or sets the ColorMapTexture generated when the <see cref="T:System.Drawing.Imaging.ColorPalette" /> property changes. Alternatively, this property may be set by the user if a custom texture is required. + Also see <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshPaletteMode" />, which defines how the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture" /> is applied to the surface geometry + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTextureSize"> + <summary> + Gets or sets the Size of the texture to create when the <see cref="T:System.Drawing.Imaging.ColorPalette" /> property is set. If the user sets the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.ColorMapTexture" /> directly, this property is ignored + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.Highlight"> + <summary> + Gets or sets value in range 0...1 that defines how much the surface is highlighted its in low lit parts. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.DrawBackSide"> + <summary> + Gets or sets value determining if back side of chart should be drawn. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.LightingFactor"> + <summary> + Gets or sets a factor from 0.0f - 1.0f which defines how much lighting is used on cells, 0.0f = no lighting and 1.0f = fully lit + a default value of 0.8 is used + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.OnPaletteProviderAttached(SciChart.Charting3D.RenderableSeries.IPaletteProvider3D,SciChart.Charting3D.RenderableSeries.IPaletteProvider3D)"> + <summary> + Called when a new <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance is attached to a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.OnColorPaletteChanged(System.Object,System.EventArgs)"> + <summary> + Called when the <see cref="P:SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D.MeshColorPalette" /> property changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity"> + <summary> + A SceneEntity added to the 3D Scene which draws a Surface Chart. See also the <see cref="T:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity.RenderScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity.SetColorTexture(SciChart.Charting3D.Texture2D)"> + <summary> + Sets the color texture in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.Point3DXyzDisplacementData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi">Actual render pass info.</param> + <param name="pointSeries">Point Series</param> + <param name="data">The data values.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper"> + <summary> + A base class for a <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" /> which uses <see cref="T:SciChart.Charting3D.Model.FreeSurfaceDataSeries3D`3" /> data as input, and transforms + into scene geometry + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.PerformSelection(SciChart.Charting3D.Model.IDataSeries3D,System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection, setting the <paramref name="isSelected" /> flag to true or false on the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> for the given list of <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="dataSeries">The data series.</param> + <param name="isSelected">if set to <c>true</c> [is selected].</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.GetXyzDataValue(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the hit data value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid + Vector3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.GetMetadata(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the Metadata value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <param name="hitTestInfo">The hit test information.</param> + <param name="lastPointSeries"></param> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid or if metadata not supported on this series type. + IPointMetadata3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.ToPointSeries(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D)"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IFreeSurfacePointSeries3D" /> derived type, for use during the render pass + </summary> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.FreeSurfaceRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzDisplacementData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.FreeSurfaceSceneEntityHelper.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,System.Windows.Media.Media3D.Vector3D},System.Func{System.Windows.Media.Media3D.Vector3D,SciChart.Charting3D.Vector3},System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D"> + <summary> + Provides information on a series hit test operation, see <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> HitTest method for more information. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.Empty"> + <summary> + Gets special value which represents a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> instance without data + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.IsHit"> + <summary> + Gets or sets whether the HitTest operation was a hit or not + </summary> + <remarks>Defined as the input point being within a small distance of the output hittest point</remarks> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.VertexId"> + <summary> + Gets or sets the VertexID for the vertex which has been hit (ignore if <see cref="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.IsHit" /> is false) + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.EntityId"> + <summary> + Gets or sets the EntityId for the <see cref="T:SciChart.Charting3D.Primitives.BaseSceneEntity`1" /> which has been hit (ignore if <see cref="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.IsHit" /> is false) + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.IjIndices"> + <summary> + Gets or sets the I,J Indices for the 2d entity which has been hit (ignore if <see cref="P:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.IsHit" /> is false) + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.HitTestInfo3D.IsEmpty"> + <summary> + Returns the value, indicating whether current instance of <see cref="T:SciChart.Charting.Visuals.RenderableSeries.HitTestInfo" /> is empty + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D"> + <summary> + Provides 3D Impulse series rendering + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IXyzPointSeries3D" /> or <see cref="T:SciChart.Charting3D.Model.IGridPointSeries3D" /> data-source. + </remarks> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.SelectedDataPointStrokeProperty"> + <summary> + Defines the SelectedDataPointStroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.SelectedDataPointStroke"> + <summary> + Gets or sets the Stroke Color for selected data points + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the lines. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity" /> that represent this <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D" />. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns>The <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity" /> instance which draws this <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D" /></returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D.AttachDataSeries(SciChart.Charting3D.Model.IDataSeries3D)"> + <summary> + Attaches listeners for DataSeries.DataSeriesChanged + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity"> + <summary> + A SceneEntity added to the 3D Scene which draws a 3D Impulse (Stem) Chart. + See also the <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi"></param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ImpulseXyzSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.ImpulseRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData@)"> + <summary> + Transforms data from an IPointSeries3D into a list of data-values (Vector3D) and PointMetadata3D. Used to create the mesh + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D"> + <summary> + A placeholder interface for paletteproviders in SciChart3D, which allow colouring of + <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> vertices or geometry depending on data values + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D.OnAttach(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance is attached to a <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /></summary> + <param name="renderSeries">The render series.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D.OnDetached"> + <summary> + Called when the <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance is detached from a <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISurfaceMeshPaletteProvider3D.OverrideCellColor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.Int32,System.Int32)"> + <summary> + Overrides the color of the outline on the attached <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />. + Return null to keep the default series color. + Return a value to override the series color. + </summary> + <param name="series">The source <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />.</param> + <param name="xIndex">The x index</param> + <param name="zIndex">The z index</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IStrokePaletteProvider3D"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override the stroke color on a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + by setting or binding to the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IStrokePaletteProvider3D.OverrideStrokeColor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.Int32,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Overrides the color of the outline on the attached <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />. + Return null to keep the default series color. + Return a value to override the series color. + </summary> + <param name="series">The source <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />.</param> + <param name="index">The index of the point.</param> + <param name="metadata">The metadata of the point.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IFillPaletteProvider3D"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override the stroke color on a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + by setting or binding to the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IFillPaletteProvider3D.OverrideFillColor(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.Int32,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Overrides the fill brush of the attached <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />. + Return null to keep the default series fill. + Return a value to override the series fill. + </summary> + <param name="series">The source <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />.</param> + <param name="index">The index of the point.</param> + <param name="metadata">The metadata of the point.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IPointMarkerPaletteProvider3D"> + <summary> + Defines the interface to a PaletteProvider. By implementing this interface, you can override the Fill color of <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PointMarker" /> + by setting or binding to the <see cref="P:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D.PaletteProvider" /> property. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IPointMarkerPaletteProvider3D.OverridePointMarker(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.Int32,SciChart.Charting3D.Model.IPointMetadata3D)"> + <summary> + Overrides the color of the PointMarkers on the attached <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />. + Return <value>Null</value> to keep the default <see cref="P:SciChart.Charting3D.PointMarkers.BasePointMarker3D.Fill" />. + </summary> + <param name="series">The source <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" />.</param> + <param name="index">The index of the point.</param> + <param name="metadata">The metadata of the point.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D"> + <summary> + Defines the interface to a <see cref="T:SciChart.Charting.Visuals.RenderableSeries.BaseRenderableSeries" />, which is visual element of the RenderSeries - DataSeries pair in the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <seealso cref="T:SciChart.Charting3D.SciChart3DSurface" /> + <seealso cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.HasChanges"> + <summary> + Gets or sets whether this instance has changes. When true, caches will be invalidated and the entire series drawn afresh. When false, where possible vertices will be cached + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.DataSeries"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> that acts as a datasource for this <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /></summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.Visibility"> + <summary> + Gets or sets whether the series is visible when drawn + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.Stroke"> + <summary> + Gets or sets the Stroke. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.IsSelected"> + <summary> + Gets or sets value, indicates whether this <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> is selected + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns>The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.HitTest(System.Windows.Point)"> + <summary> + Performs a HitTest operation on the series, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + <param name="screenPoint">The screen point (X,Y Pixel coordinates in 2D screen space).</param> + <returns>The <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + <param name="hitTestInfo"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D.ShowsTooltipForModifier(System.Func{SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D,System.Boolean})"> + <summary> + Returns the value indicating whether show tooltip for modifier or not + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2"> + <summary> + Defines the interface to a Scene Entity Helper, which is basically a strategy for dealing with 3D Geometry in the scene for different data schemas + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.PerformSelection(SciChart.Charting3D.Model.IDataSeries3D,System.Boolean,System.Collections.Generic.List{SciChart.Charting3D.Primitives.VertexId})"> + <summary> + Performs selection, setting the <paramref name="isSelected" /> flag to true or false on the <see cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> for the given list of <see cref="T:SciChart.Charting3D.Primitives.VertexId">Vertex Ids</see></summary> + <param name="dataSeries">The data series.</param> + <param name="isSelected">if set to <c>true</c> [is selected].</param> + <param name="vertexIds">The vertex ids.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.GetXyzDataValue(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the hit data value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid + Vector3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.GetMetadata(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Gets the Metadata value from the <paramref name="lastPointSeries" /> based on the <paramref name="hitTestInfo" /></summary> + <param name="hitTestInfo">The hit test information.</param> + <param name="lastPointSeries"></param> + <returns> + null if the <paramref name="hitTestInfo" /> isn't valid or if metadata not supported on this series type. + IPointMetadata3D hit data value if <paramref name="hitTestInfo" /> is valid + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.ToPointSeries(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D)"> + <summary> + Converts a DataSeries to a <see cref="T:SciChart.Charting3D.Model.IPointSeries3D" /> derived type, for use during the render pass + </summary> + <returns> + The PointSeries, which may be used for drawing + </returns> + <exception cref="T:System.ArgumentNullException"></exception> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.GetPoints3DData(`0,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,`1@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.HitTest(System.Windows.Point,SciChart.Charting3D.Primitives.IBaseSceneEntity)"> + <summary> + Performs a HitTest operation on the <paramref name="baseSceneEntity" /> of type <see cref="T:SciChart.Charting3D.Primitives.IBaseSceneEntity" />, returning the <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> containing the result + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.RenderableSeries.IRenderableSeries3D,System.UInt32,System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,System.Windows.Media.Media3D.Vector3D},System.Func{System.Windows.Media.Media3D.Vector3D,SciChart.Charting3D.Vector3},System.Func{SciChart.Charting3D.RenderableSeries.HitTestInfo3D,SciChart.Charting3D.Model.IPointMetadata3D})"> + <summary> + Converts the result of a Hit-Test operation (<see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" />) to a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> class, which may be used as a + ViewModel when outputting series values as bindings. <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" /> is used by the <see cref="T:SciChart.Charting3D.Modifiers.Tooltip3D.TooltipModifier3D" /> class + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PieMeshRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PieMeshRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.PieMeshRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries + </returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D"> + <summary> + Provides 3D Line series rendering + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IXyzPointSeries3D" /> data-source. + </remarks> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.SelectedDataPointStrokeProperty"> + <summary> + Defines the SelectedDataPointStroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.IsLineStripsProperty"> + <summary> + Defines the IsLineStrips DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.IsAntialiasedProperty"> + <summary> + Defines the IsAntialiased DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.SelectedDataPointStroke"> + <summary> + Gets or sets the Stroke Color for selected data points + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.StrokeThickness"> + <summary> + Gets or sets the StrokeThickness of the lines. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.IsLineStrips"> + <summary> + Gets or sets the IsLineStrips + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.IsAntialiased"> + <summary> + Gets or sets whether the Lines are antialiased (default FALSE). + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries + </returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.PointLineSceneEntity"> + <summary> + A SceneEntity added to the 3D Scene which draws a 3D Impulse (Stem) Chart. + See also the <see cref="T:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PointLineSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.PointLineSceneEntity" /> class. + </summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PointLineSceneEntity.ToSeriesInfo(SciChart.Charting3D.RenderableSeries.HitTestInfo3D)"> + <summary> + Converts a <see cref="T:SciChart.Charting3D.RenderableSeries.HitTestInfo3D" /> struct, containing information about a Hit-Test operation, into a <see cref="T:SciChart.Charting3D.Model.ChartData.SeriesInfo3D" />, which is a viewmodel for tooltips, legends in the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> libary + </summary> + <param name="hitTestInfo">The hit test information.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PointLineSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.PointLineSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi"></param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.Lines3DSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.Points3DSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.Lines3DSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.Lines3DSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi"></param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.Points3DSceneEntity"> + <summary> + A SceneEntity added to the 3D Scene which draws a Scatter or Point Cloud from <see cref="T:SciChart.Charting3D.Model.IXyzPointSeries3D" /> data. See also the <see cref="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.Points3DSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.Points3DSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.Points3DSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.Points3DSceneEntity.CreateNativeMeshes(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData)"> + <summary> + When overridden in a derived class, updates all 3D meshes from Data + </summary> + <param name="rpi"></param> + <param name="pointSeries"></param> + <param name="data">The data values.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D"> + <summary> + Provides 3D Scatter series rendering + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IXyzPointSeries3D" /> data-source. + </remarks> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries + </returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ScatterSceneEntityHelper"> + <summary> + Defines the interface to a Point 3D <see cref="T:SciChart.Charting3D.RenderableSeries.ISceneEntityHelper`2" />, which is basically a strategy for dealing with + 3D Geometry in <see cref="T:SciChart.Charting3D.RenderableSeries.ScatterRenderableSeries3D" /> or <see cref="T:SciChart.Charting3D.RenderableSeries.PointLineRenderableSeries3D" /> for different data schema + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.ScatterSceneEntityHelper.LastDataContainsTransparentPoints"> + <summary> + Gets value determining whether last pressed data contained transparent points or not. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.ScatterSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.Point3DXyzData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette"> + <summary> + The <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> provides a color palette converted from <see cref="T:System.Windows.Media.Brush" />. + The palette is to be applied to a <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> e.g. to give a height-map at runtime. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.BrushColorPalette.BrushProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.BrushColorPalette.Brush" /> DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BrushColorPalette.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.BrushColorPalette.Brush"> + <summary> + Gets or sets the brush to create color-palette from. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BrushColorPalette.GetTexture(System.Windows.Size)"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Texture2D" /> to apply to the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" />, given the size passed in. + </summary> + <param name="size">The size.</param> + <returns> + The <see cref="T:SciChart.Charting3D.Texture2D" /> instance to map to the surface + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.BrushColorPalette.GetTexture(System.Windows.Size,System.Windows.Media.Brush)"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.Texture2D" /> based on the input <param name="size" /> and <param name="brush" />. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.Texture2D" /> instance to map to the surface + </returns> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.DrawMeshAs"> + <summary> + Enumeration constants which define how to draw a <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /></summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.DrawMeshAs.SolidWireFrame"> + <summary> + Draw the mesh as solid surface plus wireframe + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.DrawMeshAs.Wireframe"> + <summary> + Draw the mesh as wireframe only + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.DrawMeshAs.SolidMesh"> + <summary> + Draw the mesh as Solid only + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.DrawMeshAs.Contours"> + <summary> + Draw the mesh as Contours only + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.DrawMeshAs.SolidWithContours"> + <summary> + Draw the mesh as Solid plus contours + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.DrawMeshAs.SolidWireframeWithContours"> + <summary> + Draw the mesh as solid surface plus wireframe plus contours + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.GradientColorPalette"> + <summary> + <para>The <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> provides a color palette converted from <see cref="T:System.Windows.Media.GradientStop" /> collection.</para> + <para>The palette is to be applied to a <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> e.g. to give a height-map at runtime. </para> + <para>This allows you to switch between stepped and linear interpolated palettes by changing the <see cref="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.IsStepped" /> property</para> + <para>Also, you can change Contour Stroke with the <see cref="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.ContourColor" /> and <see cref="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.ContourStrokeThickness" /> properties</para> + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.GradientColorPalette.GradientStopsProperty"> + <summary> + Defines the GradientStops DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.GradientColorPalette.IsSteppedProperty"> + <summary> + Defines the IsStepped DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.GradientColorPalette.ContourColorProperty"> + <summary> + Defines the ContourStroke DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.GradientColorPalette.ContourStrokeThicknessProperty"> + <summary> + Defines the ContourStrokeThickness DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.GradientColorPalette.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.GradientColorPalette" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.GradientStops"> + <summary> + Gets or sets the collection of gradient stops + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.IsStepped"> + <summary> + Gets or sets a value indicating whether the palette is stepped (true), or linear interpolated (false) + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.ContourColor"> + <summary> + Gets or sets the optional color of the contour / separator between gradient stops + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.GradientColorPalette.ContourStrokeThickness"> + <summary> + Gets or sets the stroke thickness of the optional contour / separator between gradient stops + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.GradientColorPalette.UpdateBrush"> + <summary> + Updates the brush on property changed + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.MeshColorPalette"> + <summary> + A MeshColorPalette is the base class for palettes for the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> type. + </summary> + </member> + <member name="E:SciChart.Charting3D.RenderableSeries.MeshColorPalette.ColorPaletteChanged"> + <summary> + Occurs when the Color Palette changes and requires updating + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.MeshColorPalette.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.MeshColorPalette" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.MeshColorPalette.GetTexture(System.Windows.Size)"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Texture2D" /> to apply to the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" />, given the size passed in + </summary> + <param name="size">The size.</param> + <returns>The <see cref="T:SciChart.Charting3D.Texture2D" /> instance to map to the surface</returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.MeshColorPalette.OnColorPaletteChanged"> + <summary> + Raises the <see cref="E:SciChart.Charting3D.RenderableSeries.MeshColorPalette.ColorPaletteChanged" /> event + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.MeshPaletteMode"> + <summary> + Enumerable constants which define the Mesh Palette mode. See the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshPaletteMode" /> property for more information + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshPaletteMode.HeightMapInterpolated"> + <summary> + Draw the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPalette" /> as a Height-map with intepolation between cells + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshPaletteMode.HeightMapSolidCells"> + <summary> + Draw the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPalette" /> as a Height-map with solid color stepping between cells + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshPaletteMode.Textured"> + <summary> + Draw the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPalette" /> as a Texture (e.g. ignores height mapping) with interpolation between cells + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshPaletteMode.TexturedSolidCells"> + <summary> + Draw the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPalette" /> as a Texture (e.g. ignores height mapping) with solid color stepping between cells + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette"> + <summary> + The <see cref="T:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette" /> provides a color palette converted from <see cref="T:System.Windows.Media.Color" />. + The palette is to be applied to a <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> e.g. to color the entire mesh a single color at runtime. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette.FillProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette.Fill" /> DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SolidColorBrushPalette.Fill"> + <summary> + Gets or sets solid color Fill to apply to the entire mesh + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.MeshResolution"> + <summary> + Enumeration constants for oversampling the mesh + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshResolution.x1"> + <summary> + 1:1 mesh resolution + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshResolution.x2"> + <summary> + 2:1 oversampling e.g. 2 mesh vertices for every cell + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MeshResolution.x4"> + <summary> + 4:1 oversampling e.g. 4 mesh vertices for every cell + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D"> + <summary> + Provides SurfaceMesh series rendering + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.IGridPointSeries3D" /> data-source. + </remarks> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawMeshAsProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawMeshAs" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.StrokeThicknessProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.StrokeThickness" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawSkirtProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawSkirt" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPaletteProperty"> + <summary> + Defines the <see cref="T:System.Drawing.Imaging.ColorPalette" /> DependencyProperty. Setting this property will overwrite the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture" /> property + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MinimumProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.Minimum" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MaximumProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.Maximum" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshPaletteModeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshPaletteMode" /> DependencyProperty, which defines how the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture" /> is applied to the surface mesh geometry + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTextureProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTextureSizeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTextureSize" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.HeightScaleFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.HeightScaleFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshResolutionProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshResolution" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.YOffsetProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.YOffset" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.CellHardnessFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.CellHardnessFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.LightingFactorProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.LightingFactor" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourStrokeThicknessProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourStrokeThickness" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourIntervalProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourInterval" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourOffsetProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourOffset" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourStrokeProperty"> + <summary> + Defines the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourStroke" /> DependencyProperty + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.HighlightProperty"> + <summary> + Defines the Highlight DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.HeightScaleFactor"> + <summary> + Gets or sets the height scale factor. Default is 1.0f. Value of 0.0f will render a flat Uniform Surface Mesh. Value of 1.0f will use the scaling of the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> YAxis + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourStroke"> + <summary> + Gets or sets the contour <see cref="T:System.Windows.Media.Color" />. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourOffset"> + <summary> + Gets or sets the contour offset. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourInterval"> + <summary> + Gets or sets the contour interval. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ContourStrokeThickness"> + <summary> + Gets or sets contour thickness. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.YOffset"> + <summary> + Gets or sets a Y-Offset in World Coordinates. This offset will change the base position of the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /> on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> YAxis + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.CellHardnessFactor"> + <summary> + Gets or sets a factor from 0.0f - 1.0f which defines how hard a Cell looks. e.g. 0.0f = smooth and 1.0f = hard faces + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.LightingFactor"> + <summary> + Gets or sets a factor from 0.0f - 1.0f which defines how much lighting is used on cells, 0.0f = no lighting and 1.0f = fully lit + a default value of 0.8 is used + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshResolution"> + <summary> + Gets or sets the mesh resolution. By default for each point in the <see cref="T:SciChart.Charting3D.Model.UniformGridDataSeries3D`3" />, there will be one vertex in the resulting mesh. To increase the resolution, use <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshResolution" /> x2 or <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshResolution" /> x4 + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.StrokeThickness"> + <summary> + Gets or sets the stroke thickness to apply to the wireframe. Used when <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawMeshAs" /> is WireFrame or SolidWireFrame + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawMeshAs"> + <summary> + Gets or sets how to draw the mesh + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.DrawSkirt"> + <summary> + Gets or sets whether to draw the skirt (geometry from the edges of the surface mesh to the zero line in Y) + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPalette"> + <summary> + Gets or sets the MeshColorPalette which is used to calculate color from data value + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.Minimum"> + <summary> + Gets or sets value which corresponds to min color + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.Maximum"> + <summary> + Gets or sets value which corresponds to max color + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshPaletteMode"> + <summary> + Gets or sets the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshPaletteMode" />, which defines how to apply the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture" /></summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture"> + <summary> + Gets or sets the ColorMapTexture generated when the <see cref="T:System.Drawing.Imaging.ColorPalette" /> property changes. Alternatively, this property may be set by the user if a custom texture is required. + Also see <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshPaletteMode" />, which defines how the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture" /> is applied to the surface mesh geometry + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTextureSize"> + <summary> + Gets or sets the Size of the texture to create when the <see cref="T:System.Drawing.Imaging.ColorPalette" /> property is set. If the user sets the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.ColorMapTexture" /> directly, this property is ignored + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.Highlight"> + <summary> + Gets or sets value in range [0..1] that defines how much the surface mesh is highlighted at its low lit parts. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.GetSceneEntity"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> that represent this RenderableSeries. This is the entity which will actually do the drawing in the 3D Viewport. + NOTE: The specification requires that subsequent calls to <see cref="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.GetSceneEntity" /> should return the <b>same</b> instance. + </summary> + <returns> + The <see cref="T:SciChart.Charting3D.RenderableSeries.IBaseRenderableSeriesSceneEntity3D" /> instance which draws this RenderableSeries + </returns> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.OnPaletteProviderAttached(SciChart.Charting3D.RenderableSeries.IPaletteProvider3D,SciChart.Charting3D.RenderableSeries.IPaletteProvider3D)"> + <summary> + Called when a new <see cref="T:SciChart.Charting3D.RenderableSeries.IPaletteProvider3D" /> instance is attached to a <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.OnColorPaletteChanged(System.Object,System.EventArgs)"> + <summary> + Called when the <see cref="P:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D.MeshColorPalette" /> property changes + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.EventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshSceneEntity"> + <summary> + A SceneEntity added to the 3D Scene which draws a Surface Mesh Chart. See also the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshSceneEntity.#ctor(SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.RenderableSeries.SurfaceMeshSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshSceneEntity.RenderScene(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Called when the 3D Engine wishes to render this element. This is where geometry must be drawn to the 3D scene + </summary> + <param name="rpi">The <see cref="T:SciChart.Charting3D.Primitives.IRenderPassInfo3D" /> containing parameters for the current render pass.</param> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshSceneEntity.UpdateNativeEntity(SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.Model.IPointSeries3D)"> + <summary> + Updates all the parameters in native entity. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.SurfaceMeshSceneEntityHelper.GetPoints3DData(SciChart.Charting3D.RenderableSeries.SurfaceMeshRenderableSeries3D,SciChart.Charting3D.Model.IPointSeries3D,SciChart.Charting3D.Primitives.IRenderPassInfo3D,SciChart.Charting3D.RenderableSeries.HeightmapOffsetsXZData@)"> + <summary> + Transforms data from an IPointSeries3D into series specific type, + that holds all the necessary data to create mesh. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MountainRenderableSeries3D.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.MountainRenderableSeries3D.FillProperty"> + <summary> + Defines the Fill DependencyProperty. + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.ClipMode"> + <summary> + Defines an enumeration of possible clipping modes for data points in a <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" />. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ClipMode.AboveZero"> + <summary> + All vertices that have Y values greater than zero will be clipped to zero. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ClipMode.BelowZero"> + <summary> + All vertices that have Y values less than zero will be clipped to zero. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.ClipMode.None"> + <summary> + All vertices will appear as they are. This is the default mode. + </summary> + </member> + <member name="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D"> + <summary> + Provides a series type for Waterfall chart rendering. + </summary> + <remarks> + A RenderableSeries has a <see cref="T:SciChart.Charting3D.Model.DataSeries.Waterfall.WaterfallDataSeries3D`1" /> data-source. + </remarks> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.StrokeThicknessProperty"> + <summary> + Defines the StrokeThickness DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.SliceThicknessProperty"> + <summary> + Defines the SliceThickness DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.SelectedColorMappingProperty"> + <summary> + Defines the SelectedColorMapping DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.SelectedStrokeProperty"> + <summary> + Defines the SelectedStroke DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.YColorMappingProperty"> + <summary> + Defines the YColorMapping DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.ZColorMappingProperty"> + <summary> + Defines the ZColorMapping DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.YStrokeColorMappingProperty"> + <summary> + Defines the YStrokeColorMapping DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.ZStrokeColorMappingProperty"> + <summary> + Defines the YStrokeColorMapping DependencyProperty. + </summary> + </member> + <member name="F:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.ClipModeProperty"> + <summary> + Defines the ClipMode DependencyProperty. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.ClipMode"> + <summary> + Gets or sets how a Waterfall Chart renders its data. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.YColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling slices of a waterfall chart. + The slices will be painted along Y axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.ZColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling slices of a waterfall chart. + The slices will be painted along Z axis. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.YStrokeColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling Y stroke of a waterfall chart. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.ZStrokeColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling Z stroke of a waterfall chart. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.SelectedColorMapping"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for filling selected slices of a waterfall chart. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.SelectedStroke"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.RenderableSeries.BrushColorPalette" /> for paining outlines of selected slices of a waterfall chart. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.StrokeThickness"> + <summary> + Gets or sets the stroke thickness of waterfall chart slices. + </summary> + </member> + <member name="P:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.SliceThickness"> + <summary> + Gets or sets the thickness of waterfall chart slices. + Produces volumetric slices if set to a value > 0. + </summary> + </member> + <member name="M:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D.#ctor"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.RenderableSeries.WaterfallRenderableSeries3D" /> instance. + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChart2D3DInitializer"> + <summary> + Applies a runtime license key and initialize 2D & and 3D native libraries asynchronously. + Do not create an instance of a SciChartSurface or SciChart3DSurface until the Task has returned and completed. + If the task faults, inspect the result and contact tech support. + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart2D3DInitializer.Awaiter"> + <summary> + Gets the initialization task so that you can check for completion before instantiating SciChartSurfaces + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart2D3DInitializer.LoadLibrariesAndLicenseAsync(System.String,System.String)"> + <summary> + <para> + Apply the runtime license key and initialize 2D & and 3D native libraries asynchronously. + Do not create an instance of a SciChartSurface until the Task has returned and completed. + If the task faults, inspect the result and contact tech support. + </para> + <para> + If you want to load libraries and license for both 2D & 3D charts, then use the related class SciChart2D3DInitializer instead + </para> + </summary> + <example> + <code> + try + { + // call SciChart2D3DInitializer.LoadLibrariesAndLicenseAsync once before creating a SciChart3DSurface + // and await the result. Do not instantiate a SciChart3DSurface until it returns successfully + + // optionalTempDir allows you to pass in an optional temporary directory for native library loading + await SciChart2D3DInitializer.LoadLibrariesAndLicenseAsync("your-runtime-license-key", optionalTempDir); + + var sciChartSurface = new SciChartSurface(); + // ... use SciChartSurface + } + catch ( Exception caught ) + { + // TODO: Log the exception or report to tech support + throw; + } + </code> + </example> + <param name="runtimeLicenseKey">The license key string, or null = don't set license (just initialize libraries)</param> + <param name="tempFilesDirectory">A temporary directory used to write native dependencies before loading or null = default. Make sure your application has write permission to this directory and AntiVirus is not blocking access to this directory.</param> + <seealso cref="M:SciChart.Charting.Visuals.SciChart2DInitializer.LoadLibrariesAndLicenseAsync(System.String,System.String)" /> + </member> + <member name="T:SciChart.Charting3D.ISciChart3DRenderer"> + <summary> + Defines the interface to the <see cref="T:SciChart.Charting3D.SciChart3DRenderer" />, which handles the render pass on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="M:SciChart.Charting3D.ISciChart3DRenderer.RenderLoop"> + <summary> + Executes a single render pass + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChart3DRenderer"> + <summary> + Handles the render pass on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderer.#ctor(SciChart.Charting3D.SciChart3DSurface)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.SciChart3DRenderer" /> class. + </summary> + <param name="sciChart3DSurface">The sci chart3 d surface.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderer.RenderLoop"> + <summary> + Executes a single render pass + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderer.OnLayoutSciChart(SciChart.Charting3D.ISciChart3DSurface)"> + <summary> + Step 1, perform layout, resize components + </summary> + <param name="scs"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderer.TryPerformAutoRangeOn(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.ISciChart3DSurface)"> + <summary> + // Set a default range prior to layout if one doesn't exist + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChart3DRenderSurface"> + <summary> + Provides a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> implementation that uses a DirectX engine, capable of 3D rendering + This requires DirectX10 hardware or later to run. Newer GPUs will have superior performance. + </summary> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.SciChart3DRenderSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.RecreateSurface"> + <summary> + this is called when window is created or resized + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.OnRenderSurfaceBaseLoaded(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is loaded into the visual tree + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.RoutedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.GetRenderContext"> + <summary> + When overridden in a derived class, returns a RenderContext valid for the current render pass + </summary> + <returns></returns> + <exception cref="T:System.NotSupportedException">The SciChart3DRenderSurface does not support 2D drawing operations</exception> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.DisposeUnmanagedResources"> + <summary> + Derived classes may override this method to be notified when to dispose of unmanaged resources. Called when the + <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is disposed + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DRenderSurface.Viewport3D"> + <summary> + Gets the 3D Viewport + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.AddSeries(System.Collections.Generic.IEnumerable{SciChart.Charting3D.RenderableSeries.IRenderableSeries3D})"> + <summary> + Adds the collection of <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instances to the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /></summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.AddSeries(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Adds the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance to the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /></summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="P:SciChart.Charting3D.SciChart3DRenderSurface.SciChart#Charting3D#ISciChart3DRenderSurface#ChildSeries"> + <summary> + Gets the child RenderableSeries in this <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> instance + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.ContainsSeries(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Returns True if the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /> contains the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance + </summary> + <param name="renderableSeries">the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> instance</param> + <returns> + <c>true</c> if the specified renderable series contains series; otherwise, <c>false</c>. + </returns> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.RemoveSeries(SciChart.Charting3D.RenderableSeries.IRenderableSeries3D)"> + <summary> + Removes the <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> from the <see cref="T:SciChart.Charting3D.ISciChart3DRenderSurface" /></summary> + <param name="renderableSeries">The renderable series.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRenderSurface.AttachCamera(SciChart.Charting3D.ICameraController)"> + <summary> + Attaches the camera to the RenderSurface + </summary> + <param name="camera">The camera.</param> + </member> + <member name="T:SciChart.Charting3D.IRootSceneEntity"> + <summary> + <para>Defines the interface to a <see cref="!:BaseSceneEntity" /> which is at the root of a <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> 3D Scene.</para> + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChart3DRootSceneEntity"> + <summary> + <para>A <see cref="!:BaseSceneEntity" /> which is at the root of a <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> 3D Scene.</para> + <para>Contains an <see cref="T:SciChart.Charting3D.Axis.AxisCubeEntity" />, <see cref="!:RenderableSeries3DEntity" /> which is the parent for <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /></para> + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRootSceneEntity.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.SciChart3DRootSceneEntity" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DRootSceneEntity.#ctor(SciChart.Charting3D.Axis.AxisCubeEntity)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.SciChart3DRootSceneEntity" /> class with predefined child entities + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DRootSceneEntity.AxisCube"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.Axis.AxisCubeEntity" />, which draws the 3D Axis + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DRootSceneEntity.XyzGizmo"> + <summary> + Gets XYZ Gizmo entity. + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DRootSceneEntity.FpsPresenter"> + <summary> + Gets FPS Presenter entity. + </summary> + </member> + <member name="T:SciChart.Charting3D.CoordinateSystem3D"> + <summary> + Enumeration constants to define the Coordinate System (e.g. LHS, RHS) on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="F:SciChart.Charting3D.CoordinateSystem3D.LeftHanded"> + <summary> + The left handed coordinate system (Default) which matches DirectX + </summary> + </member> + <member name="F:SciChart.Charting3D.CoordinateSystem3D.RightHanded"> + <summary> + The right handed coordinate system, matches OpenGL + </summary> + </member> + <member name="T:SciChart.Charting3D.SciChart3DSurface"> + <summary> + <para>Provides a high performance DirectX powered 3D chart surface.</para> + <para>Multiple multiple <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D">Renderable Series</see> are drawn over an Axis Cube, which contains the visual representation of X,Y and Z <see cref="T:SciChart.Charting3D.Axis.IAxis3D" /> instances.</para> + <para>Each <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D">Renderable Series</see> has a <see cref="T:SciChart.Charting3D.Model.IDataSeries3D">Data Series</see>, which provides the data-source either in code or via MVVM bindings.</para> + <para>The <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> supports one or more <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> derived types via the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> property. These are used to + affect behaviour such as zooming, panning and tooltips.</para> + <para>Finally, a <see cref="T:SciChart.Charting3D.ICameraController" /> instance is applied to the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> to define the view into the 3D scene</para> + </summary> + <seealso cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" /> + <seealso cref="T:SciChart.Charting3D.Model.IDataSeries3D" /> + <seealso cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> + <seealso cref="P:SciChart.Charting3D.SciChart3DSurface.Viewport3D" /> + <seealso cref="T:SciChart.Charting3D.Axis.AxisBase3D" /> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.ChartModifierProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.RenderableSeriesProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.RenderableSeries" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.XAxisProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.XAxis" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.YAxisProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.YAxis" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.ZAxisProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ZAxis" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.CameraProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.Camera" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.WorldDimensionsProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.WorldDimensions" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.ViewportManagerProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.ViewportManager" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.IsAxisCubeVisibleProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.IsAxisCubeVisible" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.AxisPlaneVisibilityModeProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.AxisPlaneVisibilityMode" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.IsFpsCounterVisibleProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.IsFpsCounterVisible" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.IsXyzGizmoVisibleProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.IsXyzGizmoVisible" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.CoordinateSystemProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.CoordinateSystem" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.RootSceneEntityProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.RootSceneEntity" /> DependencyProperty</summary> + </member> + <member name="F:SciChart.Charting3D.SciChart3DSurface.SceneObjectsProperty"> + <summary>Defines the <see cref="P:SciChart.Charting3D.SciChart3DSurface.SceneObjects" /> DependencyProperty</summary> + </member> + <member name="E:SciChart.Charting3D.SciChart3DSurface.RenderableSeriesChanged"> + <summary> + Event raised when <see cref="P:SciChart.Charting3D.SciChart3DSurface.RenderableSeries" /> changes. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.#ctor(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Internal Ctor used for tests + </summary> + <param name="mockServices"></param> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.SupportsXamlRenderSurface"> + <summary> + Returns True if the current <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance supports the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> for high quality vector rendering and export. By default this is True, but some chart types, e.g. 3D Charts, cannot support this output + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.RootSceneEntity"> + <summary> + The Root Entity in the 3D Scene. This should always be defined and child entities are drawn in order + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.IsAxisCubeVisible"> + <summary> + When True, the Axis Cube is visible, when false, the entire axis cube is hidden + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.AxisPlaneVisibilityMode"> + <summary> + Defines how Axis Cube planes are drawn. + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.IsFpsCounterVisible"> + <summary> + When True, the FPS Count (Refresh Rate, Hz) is shown in the bottom left corner of the SciChart3DSurface + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.IsXyzGizmoVisible"> + <summary> + When True, the XYZ Orientation Gizmo is drawn in the bottom left of the SciChart3DSurface + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.CoordinateSystem"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.CoordinateSystem3D" /> to apply to the current SciChart3DSurface. + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.Viewport3D"> + <summary> + Gets the <see cref="T:SciChart.Charting3D.IViewport3D" /> which hosts the 3D Scene. This may be null if the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> has not yet loaded or initialized + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.RenderableSeries"> + <summary> + Gets the collection of <see cref="T:SciChart.Charting3D.RenderableSeries.IRenderableSeries3D" /> that this SciChart3DSurface draws. + </summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.XAxis"> + <summary> + Gets or sets the XAxis on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.YAxis"> + <summary> + Gets or sets the YAxis on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.ZAxis"> + <summary> + Gets or sets the ZAxis on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.ViewportManager"> + <summary> + Gets or sets the ViewportManager instance on the chart, which handles behavior of the viewport on render + </summary> + <value>The renderable series.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.ChartModifier"> + <summary> + Gets or sets the ChartModifier on the <see cref="T:SciChart.Charting3D.ISciChart3DSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.WorldDimensions"> + <summary> + Gets or sets the World Dimensions as a <see cref="T:SciChart.Charting3D.Vector3" />. + </summary> + <remarks> + The default is X,Y,Z = 100,100,100. + The extents of the X,Y,Z world ranges from -DimX/2 to +DimX/2, -DimY/2 to +DimY/2, -DimZ/2 to +DimZ/2 + </remarks> + </member> + <member name="P:SciChart.Charting3D.SciChart3DSurface.Camera"> + <summary> + Gets or sets the <see cref="T:SciChart.Charting3D.ICameraController" />, which allows direct control over the position, target of the camera and therefore the view, projection matrices of the viewport + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.ZoomExtents"> + <summary> + Zooms the X,Y,Z Axis to the extents of the data, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the X,Y and Z Axes + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.AnimateZoomExtents(System.TimeSpan)"> + <summary> + Animated zoom-extents on the the X,Y,Z Axis to the extents of the data, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the X,Y and Z Axes + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.ZoomExtentsY"> + <summary> + Zooms just the YAxis to extents, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the YAxis + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.AnimateZoomExtentsY(System.TimeSpan)"> + <summary> + Animated zoom-extents just the YAxis, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the YAxis + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.ZoomExtentsX"> + <summary> + Zooms just the XAxis to extents, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the XAxis + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.AnimateZoomExtentsX(System.TimeSpan)"> + <summary> + Animated zoom-extents just the XAxis, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the XAxis + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.ZoomExtentsZ"> + <summary> + Zooms just the ZAxis to extents, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the ZAxis + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.AnimateZoomExtentsZ(System.TimeSpan)"> + <summary> + Animated zoom-extents just the ZAxis, plus any <see cref="P:SciChart.Charting.Visuals.Axes.AxisCore.GrowBy" /> fraction set on the ZAxis + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.OnArrangeSciChart"> + <summary> + Preparations for a render pass, called internally, returns the viewport size + </summary> + <returns>The required Viewport Size</returns> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.RegisterServices(SciChart.Core.Utility.IServiceContainer)"> + <summary> + Called in the constructor of <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />, gives derived classes the opportunity to register services per <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> instance + </summary> + <param name="serviceContainer">The service container instance.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.OnSciChartSurfaceLoaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is loaded. Perform initialization operations here. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.OnSciChartSurfaceUnloaded"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> is Unloaded and removed from the visual tree. Perform cleanup operations here + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.OnRenderSurfaceDependencyPropertyChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called with the <see cref="F:SciChart.Charting.Visuals.SciChartSurfaceBase.RenderSurfaceProperty" /> changes. + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.DoDrawingLoop"> + <summary> + The inner drawing loop. Called once per frame. Do your drawing here. + </summary> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.PrepareSurfaceForExport(System.Double,System.Double)"> + <summary> + Prepares the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" /> for export to bitmap or file + </summary> + <param name="width">The width of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + <param name="height">The height of the <see cref="T:SciChart.Charting.Visuals.SciChartSurfaceBase" />.</param> + </member> + <member name="M:SciChart.Charting3D.SciChart3DSurface.OnChildStyleChanged(System.Windows.DependencyPropertyChangedEventArgs)"> + <summary> + Called when the RenderSurfaceStyle DependencyProperty changes. May be overridden in derived classes + </summary> + <param name="e">The <see cref="T:System.Windows.DependencyPropertyChangedEventArgs" /> instance containing the event data.</param> + </member> + <member name="T:SciChart.Charting3D.TextureFormat"> + <summary> + Enumeration constants to define the DirectX Texture format passed between WPF and the 3D Engine + </summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_NONE"> + <summary>The textureformat is None</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_R8G8B8"> + <summary>The textureformat is R8G8B8</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_A8R8G8B8"> + <summary>The textureformat is 32-bit ARGB</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_A8B8G8R8"> + <summary>The textureformat is 32-bit ABGR</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_A32B32G32R32F"> + <summary>The textureformat is 128-bit float ABGR</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_A16B16G16R16F"> + <summary>The textureformat is 64-bit float ABGR</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_R32G32F"> + <summary>The textureformat is float RG</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_R16G16F"> + <summary>The textureformat is half-float RG</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_R32F"> + <summary>The textureformat is float R</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_R16F"> + <summary>The textureformat is half-float R</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_A8"> + <summary>The textureformat is 8-bit Alpha</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_DXT1"> + <summary>The textureformat is DXT1</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_DXT5"> + <summary>The textureformat is DXT5</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_ETC1"> + <summary>The textureformat is NoneETC1</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_PVRTC_RGB_4BPP"> + <summary>The textureformat is PVRTC_RGB</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_PVRTC_RGBA_4BPP"> + <summary>The textureformat is PVRTC_RGBA</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_PVRTC_RGB_2BPP"> + <summary>The textureformat is PVRTC_RGB</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_PVRTC_RGBA_2BPP"> + <summary>The textureformat is PVRTC_RGBA</summary> + </member> + <member name="F:SciChart.Charting3D.TextureFormat.TEXTUREFORMAT_END"> + <summary>The textureformat is Unknown</summary> + </member> + <member name="T:SciChart.Charting3D.Texture2D"> + <summary> + The Texture2D represents a Texture in the 3D engine stored in GPU memory + </summary> + </member> + <member name="M:SciChart.Charting3D.Texture2D.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Charting3D.Texture2D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Texture2D.#ctor(System.Int32,System.Int32,SciChart.Charting3D.TextureFormat)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Texture2D" /> class. + </summary> + <param name="width">The width of the texture.</param> + <param name="height">The height of the texture.</param> + <param name="textureFormat">The texture format.</param> + <exception cref="T:System.InvalidOperationException">Texture2D Width and Height must be greater than 1</exception> + </member> + <member name="M:SciChart.Charting3D.Texture2D.#ctor(SciChart.Charting3D.Interop.TSRTexture,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Texture2D" /> class. + </summary> + <param name="tsrTexture">The wrapped <see cref="T:SciChart.Charting3D.Interop.TSRTexture" />.</param> + <param name="noDispose">if set to <c>true</c> does not dispose the wrapped .</param> + </member> + <member name="M:SciChart.Charting3D.Texture2D.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Charting3D.Texture2D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Texture2D.TextureFormat"> + <summary> + Gets the <see cref="P:SciChart.Charting3D.Texture2D.TextureFormat" /></summary> + </member> + <member name="P:SciChart.Charting3D.Texture2D.Width"> + <summary> + Gets the width of the texture + </summary> + </member> + <member name="P:SciChart.Charting3D.Texture2D.Height"> + <summary> + Gets the height of the texture + </summary> + </member> + <member name="M:SciChart.Charting3D.Texture2D.WritePixels(System.Single[])"> + <summary> + Writes float[] data into the texture. The <see cref="P:SciChart.Charting3D.Texture2D.TextureFormat" /> must be a floating point format + </summary> + <param name="pixelData">The pixel data.</param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting3D.Texture2D.WritePixels(System.UInt32[])"> + <summary> + Writes uint[] rgba into the texture. The <see cref="P:SciChart.Charting3D.Texture2D.TextureFormat" /> must be a 8-bit format + </summary> + <param name="rgbaData">The pixel data.</param> + <exception cref="T:System.InvalidOperationException"></exception> + </member> + <member name="M:SciChart.Charting3D.Texture2D.FromWriteableBitmap(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.Texture2D" /> from WPF <see cref="T:System.Windows.Media.Imaging.WriteableBitmap" /></summary> + <param name="wbmp">The WriteableBitmap.</param> + <returns>The <see cref="T:SciChart.Charting3D.Texture2D" /> instance</returns> + <exception cref="T:System.ArgumentNullException">WriteableBitmap is null</exception> + </member> + <member name="M:SciChart.Charting3D.Texture2D.FromBytes(System.Byte[],System.Int32,System.Int32)"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.Texture2D" /> from byte array + </summary> + <param name="bytes">The bytes.</param> + <param name="width">The width of the texture.</param> + <param name="height">The height of the texture.</param> + <returns>The <see cref="T:SciChart.Charting3D.Texture2D" /> instance</returns> + <exception cref="T:System.ArgumentNullException">byte[] array is null</exception> + </member> + <member name="M:SciChart.Charting3D.Texture2D.FromArgb(System.UInt32[],System.Int32,System.Int32)"> + <summary> + Creates a <see cref="T:SciChart.Charting3D.Texture2D" /> from ARGB format uint array + </summary> + <param name="argb">The ARGB data.</param> + <param name="width">The width of the texture.</param> + <param name="height">The height of the texture.</param> + <returns>The <see cref="T:SciChart.Charting3D.Texture2D" /> instance</returns> + <exception cref="T:System.ArgumentNullException">argb[] array is null</exception> + </member> + <member name="M:SciChart.Charting3D.Texture2D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Charting3D.Texture2D.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Charting3D.VectorEditor"> + <summary> + Provides a Templatable WPF Control which allows you to view, and edit <see cref="T:SciChart.Charting3D.Vector3" /> X,Y,Z components + </summary> + </member> + <member name="F:SciChart.Charting3D.VectorEditor.VectorProperty"> + <summary> + The <see cref="P:SciChart.Charting3D.VectorEditor.Vector" /> DependencyProperty + </summary> + </member> + <member name="M:SciChart.Charting3D.VectorEditor.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.VectorEditor" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.VectorEditor.Vector"> + <summary> + Gets or sets the vector to edit. + </summary> + </member> + <member name="M:SciChart.Charting3D.VectorEditor.OnApplyTemplate"> + <summary> + When overridden in a derived class, is invoked whenever application code or internal processes call <see cref="M:System.Windows.FrameworkElement.ApplyTemplate" />. + </summary> + </member> + <member name="M:SciChart.Charting3D.VectorEditor.OnTextBoxLostFocus(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Called when a text box loses focus + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.RoutedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Charting3D.VectorEditor.OnVectorChanged(SciChart.Charting3D.Vector3,SciChart.Charting3D.Vector3)"> + <summary> + Called when the <see cref="P:SciChart.Charting3D.VectorEditor.Vector" /> DependencyProperty changes + </summary> + <param name="oldValue">The old value.</param> + <param name="newValue">The new value.</param> + </member> + <member name="T:SciChart.Charting3D.FullScreenAntiAliasingMode"> + <summary> + Enumeration constants to define the Full Screen AntiAliasing mode on the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /></summary> + </member> + <member name="F:SciChart.Charting3D.FullScreenAntiAliasingMode.None"> + <summary> + No Antialiasing + </summary> + </member> + <member name="F:SciChart.Charting3D.FullScreenAntiAliasingMode.MSAA2x"> + <summary> + Enables Multi-Sample AntiAliasing x2 + </summary> + </member> + <member name="F:SciChart.Charting3D.FullScreenAntiAliasingMode.MSAA4x"> + <summary> + Enables Multi-Sample AntiAliasing x4 + </summary> + </member> + <member name="F:SciChart.Charting3D.FullScreenAntiAliasingMode.MSAA8x"> + <summary> + Enables Multi-Sample AntiAliasing x8 + </summary> + </member> + <member name="T:SciChart.Charting3D.IViewport3D"> + <summary> + Defines the interface to a 3D Viewport, which wraps a C++/DirectX Engine and allows presentation of the 3D Scene in WPF + </summary> + </member> + <member name="P:SciChart.Charting3D.IViewport3D.IdProvider"> + <summary>Gets or sets the EntityId Provider. Defaults to the <see cref="T:SciChart.Charting3D.Primitives.DefaultEntityIdProvider" /></summary> + </member> + <member name="P:SciChart.Charting3D.IViewport3D.RootEntity"> + <summary>Gets or sets the Root Scene Entity which exists in the Viewport</summary> + </member> + <member name="P:SciChart.Charting3D.IViewport3D.ViewportSize"> + <summary>Gets the current Viewport3D size in pixels</summary> + </member> + <member name="P:SciChart.Charting3D.IViewport3D.Started"> + <summary>Gets whether DirectX is started on the Viewport3D</summary> + </member> + <member name="P:SciChart.Charting3D.IViewport3D.SyncRoot"> + <summary>Gets the synchronization object for multi-threaded operations on the Viewport3D</summary> + </member> + <member name="P:SciChart.Charting3D.IViewport3D.CameraController"> + <summary> + Gets the current <see cref="T:SciChart.Charting3D.ICameraController" /> instance attached to the <see cref="T:SciChart.Charting3D.Viewport3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.DrawFrame(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary>Forces a redraw to occur in the Viewport3D</summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.AttachCamera(SciChart.Charting3D.ICameraController)"> + <summary>Attaches a Camera to the Viewport3D</summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.OnViewportResized(System.Int32,System.Int32)"> + <summary>Tells the viewport the parent size has changed</summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.PickScene(System.Windows.Rect)"> + <summary>Performs a Pick operation on the scene, returning the unique Vertex ID that was picked, or zero for none</summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.PickScene(System.Windows.Point)"> + <summary>Performs a Pick operation on the scene, returning the list of unique vertex IDs that are inside the screen rect, or zero for none</summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.SetCoordinateSystem(SciChart.Charting3D.CoordinateSystem3D)"> + <summary>Sets the coordinate system (e.g. Left Handed or Right Handed) to use in the current Viewport instance</summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.GetWorld"> + <summary> + Gets the 3D Scene World from the 3D engine + </summary> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.BuildUpViewport(System.Collections.Generic.IList{SciChart.Charting3D.Interop.SCRTSceneEntity})"> + <summary> + INTERNAL USE ONLY: After <see cref="M:SciChart.Charting3D.Viewport3D.Restart3DEngineWith(SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode,SciChart.Charting3D.FullScreenAntiAliasingMode,System.Boolean)" />, this method is called internally to build up the viewport. We expose this only as public for unit tests. + </summary> + <param name="persistedEntities">The entities persisted from <see cref="M:SciChart.Charting3D.IViewport3D.TearDownViewport" /> which must now be restored</param> + </member> + <member name="M:SciChart.Charting3D.IViewport3D.TearDownViewport"> + <summary> + INTERNAL USE ONLY: Before <see cref="M:SciChart.Charting3D.Viewport3D.Restart3DEngineWith(SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode,SciChart.Charting3D.FullScreenAntiAliasingMode,System.Boolean)" />, this method is called internally to tear down the viewport. We expose this only as public for unit tests. + </summary> + </member> + <member name="T:SciChart.Charting3D.Viewport3D"> + <summary> + Defines a 3D Viewport, which wraps a C++/DirectX Engine and allows presentation of the 3D Scene in WPF + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.TdrSafeModeOverride"> + <summary> + Determines whether the automatic TDR-safe Mode is overriden. TDR-safe Mode is the state where + The Visual Xccelerator Engine operates on limited efficiency to avoid hitting the TDR. + Find more information about TDR: https://docs.microsoft.com/en-us/windows-hardware/drivers/display/tdr-registry-keys + null - TDR-safe Mode is Automatic. It means TDR-safe Mode enables automatically, when Low-range Graphics Adapter is detected. + true - TDR-safe Mode is Enabled. + false - TDR-safe Mode is Disabled. + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting3D.Viewport3D" /> class. + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Charting3D.Viewport3D" /> class. + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.RootEntity"> + <summary> + Gets or sets the Root Scene Entity which exists in the Viewport + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.IdProvider"> + <summary> + Gets or sets the EntityId Provider. Defaults to the <see cref="T:SciChart.Charting3D.Primitives.DefaultEntityIdProvider" /></summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.Started"> + <summary> + Gets whether DirectX is started on the Viewport3D + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.SyncRoot"> + <summary> + Gets the synchronization object for multi-threaded operations on the Viewport3D + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.ViewportSize"> + <summary> + Gets the current Viewport3D size in pixels + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.Restart3DEngineWith(SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode,SciChart.Charting3D.FullScreenAntiAliasingMode,System.Boolean)"> + <summary> + Restarts the 3D Engine for all Viewport3D instances in the application with the following flags. + <para><see cref="T:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode" /> specifies the DirectX version. Choose <see cref="F:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode.AutoDetect" /> to auto detect. + </para><para><see cref="T:SciChart.Charting3D.FullScreenAntiAliasingMode" /> specifies the level of antialiasing, or oversampling. The default is <see cref="F:SciChart.Charting3D.FullScreenAntiAliasingMode.None" />. Note that lines (Gridlines, Wireframes) are antialiased by default throughout the scene. + </para></summary> + <param name="directXMode">specifies the DirectX version. Choose <see cref="F:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode.AutoDetect" /> to auto detect. </param> + <param name="antiAliasingMode">specifies the level of antialiasing, or oversampling. The default is <see cref="F:SciChart.Charting3D.FullScreenAntiAliasingMode.None" />. Note that lines (Gridlines, Wireframes) are antialiased by default throughout the scene.</param> + <param name="d3d11UseLowerFeaturesLevel"></param> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.SetCoordinateSystem(SciChart.Charting3D.CoordinateSystem3D)"> + <summary> + Sets the coordinate system (e.g. Left Handed or Right Handed) to use in the current Viewport instance + </summary> + <param name="coordinateSystem"></param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.OnViewportResized(System.Int32,System.Int32)"> + <summary> + Tells the viewport the parent size has changed + </summary> + <param name="width"></param> + <param name="height"></param> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.PickScene(System.Windows.Point)"> + <summary> + Performs a Pick operation on the scene, returning the list of unique vertex IDs that are inside the screen rect, or zero for none + </summary> + <param name="mousePoint"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.PickScene(System.Windows.Rect)"> + <summary> + Performs a Pick operation on the scene, returning the unique Vertex ID that was picked, or zero for none + </summary> + <param name="screenRect"></param> + <returns></returns> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.DrawFrame(SciChart.Charting3D.Primitives.IRenderPassInfo3D)"> + <summary> + Forces a redraw to occur in the Viewport3D + </summary> + <param name="rpi">Frame pass info that contains all the necessary data to render a frame</param> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.BuildUpViewport(System.Collections.Generic.IList{SciChart.Charting3D.Interop.SCRTSceneEntity})"> + <summary> + INTERNAL USE ONLY: After <see cref="M:SciChart.Charting3D.Viewport3D.Restart3DEngineWith(SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode,SciChart.Charting3D.FullScreenAntiAliasingMode,System.Boolean)" />, this method is called internally to build up the viewport. We expose this only as public for unit tests. + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.TearDownViewport"> + <summary> + INTERNAL USE ONLY: Before <see cref="M:SciChart.Charting3D.Viewport3D.Restart3DEngineWith(SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode,SciChart.Charting3D.FullScreenAntiAliasingMode,System.Boolean)" />, this method is called internally to tear down the viewport. We expose this only as public for unit tests. + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.AttachCamera(SciChart.Charting3D.ICameraController)"> + <summary> + Attaches a Camera to the Viewport3D + </summary> + <param name="cameraController">The <see cref="T:SciChart.Charting3D.ICameraController" /> instance to attach</param> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.CameraController"> + <summary> + Gets the current <see cref="T:SciChart.Charting3D.ICameraController" /> instance attached to the <see cref="T:SciChart.Charting3D.Viewport3D" /></summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.GetWorld"> + <summary> + Gets the 3D Scene World from the 3D engine + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.FillSourceRDP"> + <summary> + Should be called to fill the WPF Image from the Direct3D Render Target at the end of drawing + </summary> + <remarks> + Alternative method for filling a WriteableBitmap with directx content, avoiding D3DImage (does not work over RDP due to bug in .NET4.0 implementation of D3DImage) + </remarks> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.IsRemoteDesktop"> + <summary> + Determines if the code is being run under Remote Desktop + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.IsRemoteDesktopDetected"> + <summary> + Internal access for testing. + </summary> + </member> + <member name="M:SciChart.Charting3D.Viewport3D.ResolveAlternativeFillSource"> + <summary> + Internal access for testing. + </summary> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.UseAlternativeFillSource"> + <summary> + When false (default), uses <see cref="T:System.Windows.Interop.D3DImage" /> for hardware accelerated texture sharing. + When true, uses software method to FillSource (avoiding use of D3DImage). This can help compatibility on certain systems + </summary> + <example> + To enable compatibility mode for SciChart3DSurface, set this property once, statically, in your application + <code> + void Foo() + { + Direct3D11RenderSurface.UseAlternativeFillSource = true; + } + </code></example> + </member> + <member name="P:SciChart.Charting3D.Viewport3D.ForceStallUntilGPUIsIdle"> + <summary> + When false (default), there is no waiting for the gpu to finish rendering, and the frame buffer is copied immediately + when true, we force the application to stall until the gpu is idle, this fixes flicker issues that can happen on older hardware + </summary> + <example> + To enable waiting for gpu to finish + <code> + void Foo() + { + Viewport3D.ForceStallUntilGPUIsIdle = true; + } + </code></example> + </member> + <member name="T:SciChart.Charting3D.ViewportManager3DBase"> + <summary> + <para>Defines the base implementation of a Viewportmanager, assigned to <see cref="P:SciChart.Charting3D.SciChart3DSurface.ViewportManager" /> property.</para> + <para>The ViewportManager allows control over the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> and allows you to override X,Y,Z AutoRanging algorithms</para> + <para>See derived types <seealso cref="T:SciChart.Charting3D.ViewportManager3DBase" /> and <seealso cref="T:SciChart.Charting3D.DefaultViewportManager3D" /> for concrete implementations</para> + </summary> + </member> + <member name="P:SciChart.Charting3D.ViewportManager3DBase.Services"> + <summary> + Gets the <see cref="T:SciChart.Core.Utility.ServiceContainer" /> which provides access to services throughout SciChart. + ServiceContainers are created one per <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> instance, + and shared between peripheral components such as <see cref="T:SciChart.Charting3D.Axis.AxisBase3D" />, <see cref="T:SciChart.Charting3D.RenderableSeries.BaseRenderableSeries3D" />, <see cref="T:SciChart.Charting3D.Modifiers.ChartModifierBase3D" /> instances. + For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="P:SciChart.Charting3D.ViewportManager3DBase.IsAttached"> + <summary> + Gets the value indicating whether a <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> has the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> attached to. + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.AttachSciChartSurface(SciChart.Charting3D.ISciChart3DSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> is attached to a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="scs">The SciChartSurface instance</param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.DetachSciChartSurface"> + <summary> + Called when the <see cref="T:SciChart.Charting.ViewportManagers.ViewportManagerBase" /> is detached from a parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + </member> + <member name="P:SciChart.Charting3D.ViewportManager3DBase.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns> + The disposable Update Suspender + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + <param name="suspender"></param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.ZoomExtents"> + <summary> + Zooms the chart to the extents of the data, plus any X or Y Grow By fraction set on the X and Y Axes + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.AnimateZoomExtents(System.TimeSpan)"> + <summary> + Zooms to extents with the specified animation duration + </summary> + <param name="duration">The duration of animation when zooming to extents</param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.ZoomExtentsX"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.AnimateZoomExtentsX(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the X-Direction + </summary> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.ZoomExtentsY"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.AnimateZoomExtentsY(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the Y-Direction, accounting for the current data in view in the X-direction + </summary> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.ZoomExtentsZ"> + <summary> + Zooms the chart to the extents of the data in the Z-Direction, accounting for the current data in view in the XY-direction + </summary> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.AnimateZoomExtentsZ(System.TimeSpan)"> + <summary> + Zooms the chart to the extents of the data in the Z-Direction, accounting for the current data in view in the XY-direction + </summary> + <param name="duration"></param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.CalculateAutoRange(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> requests to perform autoranging. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="axis">The axis</param> + <returns> + The new VisibleRange for the YAxis + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.CalculateNewXAxisRange(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to calculate the new XAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="xAxis"></param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.CalculateNewYAxisRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to calculate the new YAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="yAxis">The YAxis to calculate for</param> + <param name="renderPassInfo">The current <see cref="T:SciChart.Charting3D.Primitives.RenderPassInfo3D" /> containing render data</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.CalculateNewZAxisRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Called by the <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> during render to calculate the new ZAxis VisibleRange. Override in derived types to return a custom value + </summary> + <param name="zAxis">The ZAxis to calculate for</param> + <param name="renderPassInfo">The current <see cref="T:SciChart.Charting3D.Primitives.RenderPassInfo3D" /> containing render data</param> + <returns> + The new <see cref="T:SciChart.Data.Model.IRange" /> VisibleRange for the axis + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.OnCalculateNewXRange(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /> requests the XAxis VisibleRange. + + The Range returned by this method will be applied to the chart on render + </summary> + <param name="xAxis">The XAxis</param> + <returns>The new VisibleRange for the XAxis</returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.OnCalculateNewYRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> requests a YAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="yAxis">The YAxis</param> + <param name="renderPassInfo">The render pass info.</param> + <returns> + The new VisibleRange for the YAxis + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.OnCalculateNewZRange(SciChart.Charting3D.Axis.IAxis3D,SciChart.Charting3D.Primitives.RenderPassInfo3D)"> + <summary> + Overridden by derived types, called when the parent <see cref="T:SciChart.Charting3D.SciChart3DSurface" /> requests a ZAxis VisibleRange. + The Range returned by this method will be applied to the chart on render + </summary> + <param name="zAxis">The ZAxis</param> + <param name="renderPassInfo">The render pass info.</param> + <returns> + The new VisibleRange for the ZAxis + </returns> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.OnVisibleRangeChanged(SciChart.Charting3D.Axis.IAxis3D)"> + <summary> + Called when the <see cref="P:SciChart.Charting.Visuals.Axes.IAxisParams.VisibleRange" /> changes for an axis. Override in derived types to get a notification of this occurring + </summary> + <param name="axis">The <see cref="T:SciChart.Charting.Visuals.Axes.IAxis" />instance</param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.OnParentSurfaceRendered(SciChart.Charting3D.ISciChart3DSurface)"> + <summary> + Called when the <see cref="T:SciChart.Charting.Visuals.ISciChartSurface" /> is rendered. + </summary> + <param name="sciChartSurface">The SciChartSurface instance</param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.InvalidateParentSurface(SciChart.Charting.Model.DataSeries.RangeMode)"> + <summary> + Triggers a redraw on the parent surface with the specified RangeMode + </summary> + <param name="rangeMode">The <see cref="T:SciChart.Charting.Model.DataSeries.RangeMode" /> specifying how to redraw the parent surface</param> + </member> + <member name="M:SciChart.Charting3D.ViewportManager3DBase.OnInvalidateParentSurface"> + <summary> + Raises the <see cref="E:InvalidateParentSurface" /> event. + </summary> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Core.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Core.dll Binary files differnew file mode 100644 index 000000000..062a2ee86 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Core.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Core.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Core.xml new file mode 100644 index 000000000..0b10b99af --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Core.xml @@ -0,0 +1,2968 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Core</name> + </assembly> + <members> + <member name="T:SciChart.Core.AttachedProperties.ClipToBoundsHelper"> + <summary> + Attached property which helps to set ClipToBounds property + </summary> + </member> + <member name="F:SciChart.Core.AttachedProperties.ClipToBoundsHelper.ClipToBoundsProperty"> + <summary> + Defines the ClipToBounds DependencyProperty + </summary> + </member> + <member name="F:SciChart.Core.AttachedProperties.ClipToBoundsHelper.ClipToEllipseBoundsProperty"> + <summary> + Defines the ClipToEllipseBounds DependencyProperty + </summary> + </member> + <member name="M:SciChart.Core.AttachedProperties.ClipToBoundsHelper.GetClipToBounds(System.Windows.DependencyObject)"> + <summary> + Gets the ClipToBounds DependencyProperty value + </summary> + <param name="depObj">The dependencyObject target</param> + <returns>The ClipToBounds property value</returns> + </member> + <member name="M:SciChart.Core.AttachedProperties.ClipToBoundsHelper.SetClipToBounds(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the ClipToBounds DependencyProperty value. If true, the target object clips any child elements to the bounds when rendering. + </summary> + <param name="depObj">The dependencyObject target</param> + <param name="clipToBounds">if set to <c>true</c> clip to bounds.</param> + </member> + <member name="M:SciChart.Core.AttachedProperties.ClipToBoundsHelper.GetClipToEllipseBounds(System.Windows.DependencyObject)"> + <summary> + Gets the ClipToEllipseBounds DependencyProperty value + </summary> + <param name="depObj"></param> + <returns></returns> + </member> + <member name="M:SciChart.Core.AttachedProperties.ClipToBoundsHelper.SetClipToEllipseBounds(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the ClipToEllipseBounds DependencyProperty value. If true, the target object clips any child elements to the ellipse bounds when rendering. + </summary> + <param name="depObj"></param> + <param name="value"></param> + </member> + <member name="T:SciChart.Core.AttachedProperties.CompatibleFocus"> + <summary> + A helper class which provides properties to control element's focus. + Compatible with both Silverlight and WPF. + </summary> + </member> + <member name="F:SciChart.Core.AttachedProperties.CompatibleFocus.IsFocusableProperty"> + <summary> + Defines the IsFocusable DependencyProperty + </summary> + </member> + <member name="M:SciChart.Core.AttachedProperties.CompatibleFocus.GetIsFocusable(System.Windows.DependencyObject)"> + <summary> + Gets the IsFocusableProperty + </summary> + <param name="obj">The object.</param> + <returns>IsFocusableProperty value</returns> + </member> + <member name="M:SciChart.Core.AttachedProperties.CompatibleFocus.SetIsFocusable(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the IsFocusableProperty + </summary> + <param name="obj">The object.</param> + <param name="value">The IsFocusableProperty value</param> + </member> + <member name="T:SciChart.Core.AttachedProperties.Device"> + <summary> + Used to show or hide UIElements based on framework (WPF, Silverlight) + </summary> + </member> + <member name="F:SciChart.Core.AttachedProperties.Device.SnapsToDevicePixelsProperty"> + <summary> + Defines the SnapsToDevicePixels DependencyProperty + </summary> + </member> + <member name="M:SciChart.Core.AttachedProperties.Device.SetSnapsToDevicePixels(System.Windows.DependencyObject,System.Boolean)"> + <summary> + Sets the SnapsToDevicePixels attached property on the specified DependencyObject + </summary> + <param name="element">The DependencyObject</param> + <param name="snapToDevicePixels">The value of the SnapsToDevicePixels attached property to set</param> + </member> + <member name="M:SciChart.Core.AttachedProperties.Device.GetSnapsToDevicePixels(System.Windows.DependencyObject)"> + <summary> + Gets the SnapsToDevicePixels attached property from the specified DependencyObject + </summary> + <param name="element">The DependencyObject</param> + <return>The value of the SnapsToDevicePixels attached property</return> + </member> + <member name="T:SciChart.Core.Cpp.Interop.IntVector.IntVectorEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Core.Extensions.AttributeExtensions"> + <summary> + Extension methods for the <see cref="T:System.Attribute" /></summary> + </member> + <member name="T:SciChart.Core.Extensions.BrushExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.Media.Brush" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.BrushExtensions.IsTransparent(System.Windows.Media.Brush)"> + <summary> + Determines whether this Brush is transparent. + </summary> + <param name="brush">The brush.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.BrushExtensions.ExtractColor(System.Windows.Media.Brush)"> + <summary> + Extracts the color frmo the Brush + </summary> + <param name="brush">The brush.</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.ColorExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.Media.Color" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.ColorExtensions.IsTransparent(System.Windows.Media.Color)"> + <summary> + Determines whether this instance is transparent. + </summary> + <param name="color">The color.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ColorExtensions.ToInt(System.Windows.Media.Color)"> + <summary> + Returns the integer representation of the given color. + </summary> + </member> + <member name="T:SciChart.Core.Extensions.DateTimeExtensions"> + <summary> + Extension methods for the <see cref="T:System.DateTime" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.DateTimeExtensions.IsDefined(System.DateTime)"> + <summary> + Determines whether the <see cref="T:System.DateTime" /> is defined. + </summary> + <param name="current">The datetime.</param> + <returns>True if defined</returns> + </member> + <member name="M:SciChart.Core.Extensions.DateTimeExtensions.IsAdditionValid(System.DateTime,System.TimeSpan)"> + <summary> + Determines whether addition is valid between the specified <see cref="T:System.DateTime" /> and <see cref="T:System.TimeSpan" /></summary> + <param name="current">The DateTime.</param> + <param name="delta">The TimeSpan.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DateTimeExtensions.AddDelta(System.DateTime,System.TimeSpan)"> + <summary> + Adds the delta between the specified <see cref="T:System.DateTime" /> and <see cref="T:System.TimeSpan" /></summary> + <param name="current">The DateTime.</param> + <param name="delta">The TimeSpan.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DateTimeExtensions.AddMonths(System.DateTime,System.Int32)"> + <summary> + Adds the number of months to a DateTime instance, rolling year if end of year is reached + </summary> + <param name="current">The current.</param> + <param name="months">The months.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DateTimeExtensions.AddYears(System.DateTime,System.Int32)"> + <summary> + Adds the number of years to a DateTime instance + </summary> + <param name="current">The DateTime.</param> + <param name="years">The years.</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.DecimalExtensions"> + <summary> + Extension methods for the <see cref="T:System.Decimal" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.DecimalExtensions.RoundOff(System.Decimal)"> + <summary> + Rounds the <see cref="T:System.Decimal" /></summary> + <param name="d">The Decimal.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DecimalExtensions.RoundOff(System.Decimal,System.MidpointRounding)"> + <summary> + Rounds the <see cref="T:System.Decimal" /> with the specified <see cref="T:System.MidpointRounding" /> mode + </summary> + <param name="d">The Decimal.</param> + <param name="mode">The MidpointRounding.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DecimalExtensions.RoundOff(System.Decimal,System.Int32,System.MidpointRounding)"> + <summary> + Rounds using arithmetic (5 rounds up) symmetrical (up is away from zero) rounding + </summary> + <param name="d">A Decimal number to be rounded.</param> + <param name="decimals">The number of significant fractional digits (precision) in the return value.</param> + <param name="mode">The midpoint rounding mode</param> + <returns>The number nearest d with precision equal to decimals. If d is halfway between two numbers, then the nearest whole number away from zero is returned.</returns> + </member> + <member name="M:SciChart.Core.Extensions.DecimalExtensions.ToDateTime(System.Decimal)"> + <summary> + Converts a <see cref="T:System.Decimal" /> to <see cref="T:System.DateTime" /></summary> + <param name="d">The decimal.</param> + <returns>The equivalent DateTime</returns> + </member> + <member name="T:SciChart.Core.Extensions.DispatcherExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.Threading.Dispatcher" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.DispatcherExtensions.BeginInvokeAlways(System.Windows.Threading.Dispatcher,System.Action)"> + <summary> + Async Invokes a delegate on the UI thread + </summary> + <param name="dispatcher">The dispatcher.</param> + <param name="operation">The operation.</param> + </member> + <member name="M:SciChart.Core.Extensions.DispatcherExtensions.BeginInvokeIfRequired(System.Windows.Threading.Dispatcher,System.Action)"> + <summary> + Async Invokes a delegate on the UI thread, only if not already on the UI thread + </summary> + <param name="dispatcher">The dispatcher.</param> + <param name="operation">The operation.</param> + </member> + <member name="T:SciChart.Core.Extensions.DisposableExtensions"> + <summary> + Extension methods for <see cref="T:System.IDisposable" /> types + </summary> + </member> + <member name="M:SciChart.Core.Extensions.DisposableExtensions.SafeDispose(System.IDisposable)"> + <summary> + Checks for null and if not null, calls Dispose + </summary> + <param name="d">The IDisposable.</param> + </member> + <member name="T:SciChart.Core.Extensions.DoubleExtensions"> + <summary> + Extension methods for <see cref="T:System.Double" /> types + </summary> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.IsRealNumber(System.Double)"> + <summary> + Determines whether this double is a real number + </summary> + <param name="number">The number.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.IsNaN(System.Double)"> + <summary> + Determines whether the <see cref="T:System.Double" /> is a NaN + </summary> + <param name="value">The value.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.RoundOff(System.Double)"> + <summary> + Rounds the <see cref="T:System.Double" /></summary> + <param name="d">The Double.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.RoundOff(System.Double,System.MidpointRounding)"> + <summary> + Rounds the <see cref="T:System.Double" /> with the specified <see cref="T:System.MidpointRounding" /> mode + </summary> + <param name="d">The Double.</param> + <param name="mode">The MidpointRoudningMode</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.RoundOff(System.Double,System.Int32,System.MidpointRounding)"> + <summary> + Rounds using arithmetic (5 rounds up) symmetrical (up is away from zero) rounding + </summary> + <param name="d">A double number to be rounded.</param> + <param name="decimals">The number of significant fractional digits (precision) in the return value.</param> + <param name="mode">The midpoint rounding mode</param> + <returns>The number nearest d with precision equal to decimals. If d is halfway between two numbers, then the nearest whole number away from zero is returned.</returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.ToDateTime(System.Double)"> + <summary> + Converts a <see cref="T:System.Double" /> to <see cref="T:System.DateTime" /></summary> + <param name="ticks">The ticks as Double.</param> + <returns>The equivalent DateTime</returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.ToDecimal(System.Double)"> + <summary> + Converts a <see cref="T:System.Double" /> to <see cref="T:System.Decimal" /></summary> + <param name="value">The Double.</param> + <returns>The equivalent Decimal.</returns> + </member> + <member name="M:SciChart.Core.Extensions.DoubleExtensions.ClipToInt(System.Double)"> + <summary> + Converts a <see cref="T:System.Double" /> to <see cref="T:System.Int32" /> while avoiding arithmetic overflow + </summary> + <param name="d">The Double.</param> + <returns>The equivalent Int32</returns> + </member> + <member name="T:SciChart.Core.Extensions.ElementExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.UIElement" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.MeasureArrange(System.Windows.UIElement)"> + <summary> + Forces the layout pass on the element + </summary> + <param name="element">The element.</param> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.IsVisible(System.Windows.UIElement)"> + <summary> + Determines whether this instance is visible. + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.IsInVisualTree(System.Windows.DependencyObject)"> + <summary> + Determines whether instance is in visual tree + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.IsInVisualTree(System.Windows.DependencyObject,System.Windows.DependencyObject)"> + <summary> + Determines whether this instance is in visual tree with the specified ancestor + </summary> + <param name="element">The element.</param> + <param name="ancestor">The ancestor.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.TranslatePoint(System.Windows.FrameworkElement,System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates a Point relative to a <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="element">The element.</param> + <param name="point">The point.</param> + <param name="relativeTo">The relative to.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.IsPointWithinBounds(System.Windows.FrameworkElement,System.Windows.Point)"> + <summary> + Determines whether a Point is within bounds of an element + </summary> + <param name="element">The element.</param> + <param name="point">The point.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.GetBoundsRelativeTo(System.Windows.FrameworkElement,SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of an element relative to another <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="element">The element.</param> + <param name="relativeTo">The relative to.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.GetBoundsRelativeTo(System.Windows.FrameworkElement,System.Windows.UIElement)"> + <summary> + Get the bounds of an element relative to another element. + </summary> + <param name="element">The element.</param> + <param name="otherElement"> + The element relative to the other element. + </param> + <returns> + The bounds of the element relative to another element, or null if + the elements are not related. + </returns> + <exception cref="T:System.ArgumentNullException"> + <paramref name="element" /> is null. + </exception> + <exception cref="T:System.ArgumentNullException"> + <paramref name="otherElement" /> is null. + </exception> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.FindLogicalParent``1(System.Windows.FrameworkElement)"> + <summary> + Finds the logical parent of the <see cref="T:System.Windows.FrameworkElement" /></summary> + <typeparam name="T">The type of parent to find</typeparam> + <param name="frameworkElement">The FrameworkElement.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.FindVisualParent``1(System.Windows.UIElement)"> + <summary> + Finds the visual parent of type T + </summary> + <typeparam name="T"></typeparam> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.FindVisualParent(System.Windows.UIElement,System.Type)"> + <summary> + Finds the visual parent given a System.Type + </summary> + <typeparam name="T"></typeparam> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.RegisterForNotification(System.Windows.FrameworkElement,System.String,System.Windows.PropertyChangedCallback)"> + <summary> + Registers a PropertyChangedCallback on the property name + </summary> + <param name="element">The element.</param> + <param name="propertyName">Name of the property.</param> + <param name="callback">The callback.</param> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.ThreadSafeSetValue(System.Windows.FrameworkElement,System.Windows.DependencyProperty,System.Object)"> + <summary> + ThreadSafe DependencyObject.SetValue implementation + </summary> + <param name="element">The element.</param> + <param name="property">The property.</param> + <param name="value">The value.</param> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.CanvasXy(System.Windows.UIElement,System.Windows.Point)"> + <summary> + Sets Canvas.Left, Canvas.Top to the X,Y value of a point + </summary> + <param name="element">The element.</param> + <param name="topLeft">The top left.</param> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.CanvasXy(System.Windows.UIElement,System.Double,System.Double)"> + <summary> + Sets Canvas.Left, Canvas.Top to the X,Y value of a point + </summary> + <param name="element">The element.</param> + <param name="left">The left.</param> + <param name="top">The top.</param> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.LineXy(System.Windows.Shapes.Line,System.Windows.Point,System.Windows.Point)"> + <summary> + Sets X1,Y1,X2,Y2 of a Line + </summary> + <param name="line">The line.</param> + <param name="x1y1">The x1y1.</param> + <param name="x2y2">The x2y2.</param> + </member> + <member name="M:SciChart.Core.Extensions.ElementExtensions.LineXy(System.Windows.Shapes.Line,System.Double,System.Double,System.Double,System.Double)"> + <summary> + Sets X1,Y1,X2,Y2 of a Line + </summary> + <param name="line">The line.</param> + <param name="x1">The x1.</param> + <param name="y1">The y1.</param> + <param name="x2">The x2.</param> + <param name="y2">The y2.</param> + </member> + <member name="T:SciChart.Core.Extensions.EnumerableExtensions"> + <summary> + Extension methods for <see cref="T:System.Collections.IList" />, <see cref="T:System.Collections.IEnumerable" /> types + </summary> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.ToEnumerable``1(``0)"> + <summary> + Yields a single item, converting it to <see cref="T:System.Collections.IEnumerable" />. + </summary> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.IsNullOrEmptyList(System.Collections.IList)"> + <summary> + Determines whether this is a is null or empty list + </summary> + <param name="enumerable">The enumerable.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.IsNullOrEmpty``1(System.Collections.Generic.IEnumerable{``0})"> + <summary> + Determines whether this is a is null or empty list + </summary> + <typeparam name="T"></typeparam> + <param name="enumerable">The enumerable.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.IsEmpty``1(System.Collections.Generic.IEnumerable{``0})"> + <summary> + Determines whether this list is empty. + </summary> + <typeparam name="T"></typeparam> + <param name="enumerable">The enumerable.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.ForEachDo``1(System.Collections.IEnumerable,System.Action{``0})"> + <summary> + Iterates over the list and performs an action on each element + </summary> + <typeparam name="T"></typeparam> + <param name="enumerable">The enumerable.</param> + <param name="operation">The operation.</param> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.ForEachDo``1(System.Collections.Generic.IEnumerable{``0},System.Action{``0})"> + <summary> + Iterates over the list and performs an action on each element + </summary> + <typeparam name="T"></typeparam> + <param name="enumerable">The enumerable.</param> + <param name="operation">The operation.</param> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.ForEachDo``1(System.Collections.Generic.IEnumerable{``0},System.Action{System.Int32,``0})"> + <summary> + Iterates over the list and performs an action on each element + </summary> + <typeparam name="T"></typeparam> + <param name="enumerable">The enumerable.</param> + <param name="operation">The operation.</param> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.RemoveWhere``1(System.Collections.Generic.IList{``0},System.Predicate{``0})"> + <summary> + Removes items from the list that match a predicate + </summary> + <typeparam name="T"></typeparam> + <param name="collection">The collection.</param> + <param name="predicate">The predicate.</param> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.AddIfNotContains``1(System.Collections.Generic.IList{``0},``0)"> + <summary> + Adds an item to a list if it does not already contain it + </summary> + <typeparam name="T"></typeparam> + <param name="collection">The collection.</param> + <param name="item">The item.</param> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.RemoveIfContains``1(System.Collections.Generic.IList{``0},``0)"> + <summary> + Removes an item from a list if it contains the item + </summary> + <typeparam name="T"></typeparam> + <param name="collection">The collection.</param> + <param name="item">The item.</param> + </member> + <member name="M:SciChart.Core.Extensions.EnumerableExtensions.ToStringArray``1(System.Collections.Generic.IList{``0},System.String)"> + <summary> + Outputs a List as a Comma separated string. Used for debug purposes + </summary> + <typeparam name="T">The type of the array</typeparam> + <param name="array">The list.</param> + <param name="stringFormat">The string format e.g. in the format '{0:n2}' will output 0.00 0.01 etc...</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.FloatExtensions"> + <summary> + Extension methods for <see cref="T:System.Single" /> types + </summary> + </member> + <member name="M:SciChart.Core.Extensions.FloatExtensions.ClipToInt(System.Single)"> + <summary> + Converts a <see cref="T:System.Single" /> to <see cref="T:System.Int32" /> while avoiding arithmetic overflow + </summary> + <param name="d">The Double.</param> + <returns>The equivalent Int32</returns> + </member> + <member name="M:SciChart.Core.Extensions.FloatExtensions.IsNaN(System.Single)"> + <summary> + Determines whether the <see cref="T:System.Single" /> is a NaN + </summary> + <param name="value">The value.</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.IComparableExtensions"> + <summary> + Extension methods for the <see cref="T:System.IComparable" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.IsDefined(System.IComparable)"> + <summary> + Determines whether this IComparable is defined. + </summary> + <param name="c">The c.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.ToDouble(System.Double)"> + <summary> + Fast conversion to Double if Double + </summary> + <param name="c">The input IComparable.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.ToDouble(System.IComparable)"> + <summary> + Conversion to Double if IComparable + </summary> + <param name="c">The input IComparable.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.ToDoubleArray``1(``0[])"> + <summary> + Converts an <see cref="T:System.IComparable" /> array to double array + </summary> + <typeparam name="T"></typeparam> + <param name="inputArray">The input array.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.ToDoubleArray``1(System.Collections.Generic.IList{``0})"> + <summary> + Converts an <see cref="T:System.IComparable" /> list to double array + </summary> + <typeparam name="T"></typeparam> + <param name="inputArray">The input array.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.ToDateTime(System.IComparable)"> + <summary> + Converts an <see cref="T:System.IComparable" /> to DateTime + </summary> + <param name="c">The IComparable.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.IComparableExtensions.ToTimeSpan(System.IComparable)"> + <summary> + Converts an <see cref="T:System.IComparable" /> to TimeSpan + </summary> + <param name="c">The IComparable.</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.IntExtensions"> + <summary> + Extension methods for the <see cref="T:System.Int32" /> type. + </summary> + </member> + <member name="M:SciChart.Core.Extensions.IntExtensions.ToColor(System.Int32)"> + <summary> + Returns a <see cref="T:System.Windows.Media.Color" /> that corresponds to this Integer. + </summary> + <param name="intColor"></param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.LongExtensions"> + <summary> + Extension methods for the <see cref="T:System.Int64" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.LongExtensions.ToDateTime(System.Int64)"> + <summary> + Converts a Long (ticks) to DateTime + </summary> + <param name="ticks">The ticks.</param> + <returns>A DateTime</returns> + </member> + <member name="T:SciChart.Core.Extensions.PanelExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.Controls.Panel" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.PanelExtensions.SafeAddChild(System.Windows.Controls.Panel,System.Object,System.Int32)"> + <summary> + Adds a child if the panel is not null and if the panel does not contain the element + </summary> + <param name="panel">The panel.</param> + <param name="child">The child.</param> + <param name="index">The index.</param> + </member> + <member name="M:SciChart.Core.Extensions.PanelExtensions.SafeRemoveChild(System.Windows.Controls.Panel,System.Object)"> + <summary> + Removes a child if the panel is not null and the panel contains the element + </summary> + <param name="panel">The panel.</param> + <param name="child">The child.</param> + </member> + <member name="T:SciChart.Core.Extensions.PointExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.Point" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.PointExtensions.Floor(System.Windows.Point)"> + <summary> + Returns a new Point where X and Y components are equivalent to Math.Floor of the input point + </summary> + <param name="point">The input point, e.g. x=1.242, y=6.336</param> + <returns>The Floor'ed point, e.g. x=1, y=6</returns> + </member> + <member name="T:SciChart.Core.Extensions.PropertyHelper"> + <summary> + Contains common functions to get property names + </summary> + </member> + <member name="M:SciChart.Core.Extensions.PropertyHelper.GetMemberName``1(System.Linq.Expressions.Expression{System.Func{``0,System.Object}})"> + <summary> + Returns the name of a type member from the <see cref="T:System.Linq.Expressions.Expression" /></summary> + </member> + <member name="T:SciChart.Core.Extensions.RectExtensions"> + <summary> + Extension methods for the <see cref="T:System.Windows.Rect" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.BottomLeft(System.Windows.Rect)"> + <summary> + Cross platform extension method for getting rect.BottomLeft + </summary> + <param name="rect"></param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.TopLeft(System.Windows.Rect)"> + <summary> + Cross platform extension method for getting rect.TopLeft + </summary> + <param name="rect"></param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.TopRight(System.Windows.Rect)"> + <summary> + Cross platform extension method for getting rect.TopRight + </summary> + <param name="rect"></param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.BottomRight(System.Windows.Rect)"> + <summary> + Cross platform extension method for getting rect.BottomRight + </summary> + <param name="rect"></param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.ClipToBounds(System.Windows.Rect,System.Windows.Point)"> + <summary> + Clips a Point to Rect bounds + </summary> + <param name="rect">The rect.</param> + <param name="point">The point.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.Expand(System.Windows.Rect,System.Double)"> + <summary> + Expands a rect by offset + </summary> + <param name="rect">The rect.</param> + <param name="offset">The offset.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.RectExtensions.ToPointsArray(System.Windows.Rect)"> + <summary> + Returns <paramref name="rect" /> TopLeft, TopRight, BottomRight and BottomLeft in the points array + </summary> + </member> + <member name="T:SciChart.Core.Extensions.StringExtensions"> + <summary> + Extension methods for the <see cref="T:System.String" /> type + </summary> + </member> + <member name="M:SciChart.Core.Extensions.StringExtensions.Substring(System.String,System.String,System.String)"> + <summary> + Returns the substring of the input string which is sandwiched between the Before and After strings + </summary> + <param name="input"></param> + <param name="before"></param> + <param name="after"></param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.StringExtensions.IsNullOrWhiteSpace(System.String)"> + <summary> + Determines whether a string is null or white space + </summary> + <param name="input">The input.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.StringExtensions.AllIndexesOf(System.String,System.String)"> + <summary> + Gets all indices of a value in a string + </summary> + <param name="str">The string.</param> + <param name="value">The value.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.StringExtensions.Measure(System.String,System.Windows.Controls.TextBlock)"> + <summary> + Measures the provided <see cref="T:System.String" /> instance using <see cref="T:System.Windows.Media.FormattedText" />. + </summary> + <param name="candidate">A string to measure.</param> + <param name="textBlock">TextBlock which the string will be assigned to.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.StringExtensions.Measure(System.String,System.Double)"> + <summary> + Measures the provided <see cref="T:System.String" /> instance using <see cref="T:System.Windows.Media.FormattedText" />. + </summary> + <param name="candidate">A string to measure.</param> + <param name="fontSize">The desired font size.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.StringExtensions.ToNullable``1(System.String)"> + <summary> + Converts string value to nullable T value + </summary> + <typeparam name="T"></typeparam> + <param name="s"></param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.TimeSpanExtensions"> + <summary> + Extension methods for the <see cref="T:System.TimeSpan" /> type + </summary> + </member> + <member name="F:SciChart.Core.Extensions.TimeSpanExtensions.DaysInYear"> + <summary> + The days in year + </summary> + </member> + <member name="F:SciChart.Core.Extensions.TimeSpanExtensions.DaysInMonth"> + <summary> + The days in month + </summary> + </member> + <member name="M:SciChart.Core.Extensions.TimeSpanExtensions.IsZero(System.TimeSpan)"> + <summary> + Determines whether this instance is zero. + </summary> + <param name="timeSpan">The time span.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.TimeSpanExtensions.FromMonths(System.Int32)"> + <summary> + TimeSpan from number of months + </summary> + <param name="numberMonths">The number months.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.TimeSpanExtensions.FromWeeks(System.Int32)"> + <summary> + TimeSpan from number of weeks + </summary> + <param name="numberWeeks">The number weeks.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.TimeSpanExtensions.FromYears(System.Int32)"> + <summary> + Froms the years. + </summary> + <param name="numberYears">The number years.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.TimeSpanExtensions.IsDivisibleBy(System.TimeSpan,System.TimeSpan)"> + <summary> + Determines whether a TimeSpan is divisible by another + </summary> + <param name="current">The current.</param> + <param name="other">The other.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.TimeSpanExtensions.IsAdditionValid(System.TimeSpan,System.TimeSpan)"> + <summary> + Determines whether addition is valid between two timespans + </summary> + <param name="current">The current.</param> + <param name="delta">The delta.</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.TypeExtensions"> + <summary> + Extension methods for the <see cref="T:System.Type" /></summary> + </member> + <member name="M:SciChart.Core.Extensions.TypeExtensions.ToTypeString(System.Type)"> + <summary> + Converts type to string + </summary> + <param name="type">The type.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Extensions.TypeExtensions.GetAssembly(System.Type)"> + <summary> + Gets the <see cref="T:System.Reflection.Assembly" /> that the current <see cref="T:System.Type" /> belongs to + </summary> + <param name="type">The type.</param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Extensions.UIElementCollectionExtensions"> + <summary> + Extension methods on the <see cref="T:System.Windows.Controls.UIElementCollection" /> type + </summary> + </member> + <member name="T:SciChart.Core.Framework.DisposableAction"> + <summary> + Wraps an Action in an IDisposable. Useful when you want to have lazy dispose which is often used by the DirectX render context + </summary> + </member> + <member name="M:SciChart.Core.Framework.DisposableAction.#ctor(System.Action)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Framework.DisposableAction" /> class. + </summary> + <param name="action">The action.</param> + </member> + <member name="M:SciChart.Core.Framework.DisposableAction.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="T:SciChart.Core.Framework.DisposableBase"> + <summary> + A base class which implements IDisposable and implements the Finalizer pattern to ensure dispose is called by the Garbage Collector if not called by the user + </summary> + </member> + <member name="M:SciChart.Core.Framework.DisposableBase.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Core.Framework.DisposableBase" /> class. + </summary> + </member> + <member name="M:SciChart.Core.Framework.DisposableBase.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Core.Framework.DisposableBase.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Core.Framework.GCHelper"> + <summary> + Temporarily suspends Garbage collection for the entire application. WARNING! Use only in Using blocks and use sparingly around performance-intensive code + </summary> + </member> + <member name="M:SciChart.Core.Framework.GCHelper.#ctor"> + <summary> + Prevents a default instance of the <see cref="T:SciChart.Core.Framework.GCHelper" /> class from being created. + </summary> + </member> + <member name="M:SciChart.Core.Framework.GCHelper.SuspendGarbageCollection"> + <summary> + Temporarily suspends Garbage collection for the entire application. WARNING! Use only in Using blocks and use sparingly around performance-intensive code + </summary> + <returns>a GCHelper Instance which must be disposed to resume garbage collection</returns> + </member> + <member name="M:SciChart.Core.Framework.GCHelper.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Core.Framework.DispatchPriority"> + <summary> + Describes the priorities at which operations can be invoked by way of the + System.Windows.Threading.Dispatcher. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Invalid"> + <summary> + The enumeration value is -1. This is an invalid priority. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Inactive"> + <summary> + The enumeration value is 0. Operations are not processed. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.SystemIdle"> + <summary> + The enumeration value is 1. Operations are processed when the system is idle. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.ApplicationIdle"> + <summary> + The enumeration value is 2. Operations are processed when the application is idle. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.ContextIdle"> + <summary> + The enumeration value is 3. Operations are processed after background operations have completed. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Background"> + <summary> + The enumeration value is 4. Operations are processed after all other non-idle + operations are completed. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Input"> + <summary> + The enumeration value is 5. Operations are processed at the same priority as input. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Loaded"> + <summary> + The enumeration value is 6. Operations are processed when layout and render + has finished but just before items at input priority are serviced. Specifically + this is used when raising the Loaded event. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Render"> + <summary> + The enumeration value is 7. Operations processed at the same priority as rendering. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.DataBind"> + <summary> + The enumeration value is 8. Operations are processed at the same priority as data binding. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Normal"> + <summary> + The enumeration value is 9. Operations are processed at normal priority. This is the typical application priority. + </summary> + </member> + <member name="F:SciChart.Core.Framework.DispatchPriority.Send"> + <summary> + The enumeration value is 10. Operations are processed before other asynchronous operations. This is the highest priority. + </summary> + </member> + <member name="T:SciChart.Core.Framework.IDispatcherFacade"> + <summary> + Defines the interface to a Dispatcher Facade + </summary> + </member> + <member name="M:SciChart.Core.Framework.IDispatcherFacade.Invoke(System.Action)"> + <summary> + Invokes an action synchronously on the UI Thread + </summary> + <param name="action"></param> + </member> + <member name="M:SciChart.Core.Framework.IDispatcherFacade.BeginInvoke(System.Action,SciChart.Core.Framework.DispatchPriority)"> + <summary> + Asynchronously invokes the <paramref name="action" /> on the UI Thread + </summary> + <param name="action">The action.</param> + <param name="priority">The dispatcher priority.</param> + </member> + <member name="M:SciChart.Core.Framework.IDispatcherFacade.BeginInvokeIfRequired(System.Action,SciChart.Core.Framework.DispatchPriority)"> + <summary> + Asynchronously invokes the <paramref name="action" /> on the UI Thread, only if not currently on the UI thread + </summary> + <param name="action">The action.</param> + <param name="priority">The dispatcher priority.</param> + </member> + <member name="T:SciChart.Core.Framework.IHitTestable"> + <summary> + Defines the base interface for a type which can be hit-tested + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Core.Framework.IHitTestable.ActualWidth"> + <summary> + Gets the width of the <see cref="T:SciChart.Core.Framework.IHitTestable" /></summary> + </member> + <member name="P:SciChart.Core.Framework.IHitTestable.ActualHeight"> + <summary> + Gets the height of the <see cref="T:SciChart.Core.Framework.IHitTestable" /></summary> + </member> + <member name="M:SciChart.Core.Framework.IHitTestable.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The input point relative to this <see cref="T:SciChart.Core.Framework.IHitTestable" /></param> + <param name="relativeTo">The other <see cref="T:SciChart.Core.Framework.IHitTestable" /> to use when transforming the point</param> + <returns>The transformed Point</returns> + </member> + <member name="M:SciChart.Core.Framework.IHitTestable.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns>true if the Point is within the bounds</returns> + </member> + <member name="M:SciChart.Core.Framework.IHitTestable.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element relative to another <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="relativeTo"></param> + <returns></returns> + </member> + <member name="T:SciChart.Core.Framework.IInvalidatableElement"> + <summary> + Types which implement IInvalidatableElement can be invalidated (redrawn) + </summary> + </member> + <member name="M:SciChart.Core.Framework.IInvalidatableElement.InvalidateElement"> + <summary> + Asynchronously requests that the element redraws itself plus children. + Will be ignored if the element is ISuspendable and currently IsSuspended (within a SuspendUpdates/ResumeUpdates call) + </summary> + </member> + <member name="T:SciChart.Core.Framework.ISuspendable"> + <summary> + Types which implement ISuspendable can have updates suspended/resumed. Useful for batch operations + </summary> + </member> + <member name="P:SciChart.Core.Framework.ISuspendable.IsSuspended"> + <summary> + Gets a value indicating whether updates for the target are currently suspended + </summary> + </member> + <member name="M:SciChart.Core.Framework.ISuspendable.SuspendUpdates"> + <summary> + Suspends drawing updates on the target until the returned object is disposed, when a final draw call will be issued + </summary> + <returns>The disposable Update Suspender</returns> + </member> + <member name="M:SciChart.Core.Framework.ISuspendable.ResumeUpdates(SciChart.Core.Framework.IUpdateSuspender)"> + <summary> + Resumes updates on the target, intended to be called by IUpdateSuspender + </summary> + </member> + <member name="M:SciChart.Core.Framework.ISuspendable.DecrementSuspend"> + <summary> + Called by IUpdateSuspender each time a target suspender is disposed. When the final + target suspender has been disposed, ResumeUpdates is called + </summary> + </member> + <member name="T:SciChart.Core.Framework.IUpdateSuspender"> + <summary> + Defines the interface to an <see cref="T:SciChart.Core.Framework.UpdateSuspender" />, a disposable class which allows nested suspend/resume operations on an <see cref="T:SciChart.Core.Framework.ISuspendable" /> target + </summary> + </member> + <member name="P:SciChart.Core.Framework.IUpdateSuspender.IsSuspended"> + <summary> + Gets a value indicating whether updates for this instance are currently suspended + </summary> + </member> + <member name="P:SciChart.Core.Framework.IUpdateSuspender.ResumeTargetOnDispose"> + <summary> + Gets or sets a value indicating whether the target will resume when the IUpdateSuspender is disposed. Default is True + </summary> + </member> + <member name="P:SciChart.Core.Framework.IUpdateSuspender.Tag"> + <summary> + Gets or sets an associated Tab for this <see cref="T:SciChart.Core.Framework.IUpdateSuspender" /> instance + </summary> + </member> + <member name="T:SciChart.Core.Framework.UpdateSuspender"> + <summary> + A disposable class which allows nested suspend/resume operations on an <see cref="T:SciChart.Core.Framework.ISuspendable" /> target + </summary> + </member> + <member name="M:SciChart.Core.Framework.UpdateSuspender.#ctor(SciChart.Core.Framework.ISuspendable,System.Object)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Framework.UpdateSuspender" /> class. + </summary> + <param name="target">The target.</param> + <param name="tag">The tag.</param> + </member> + <member name="M:SciChart.Core.Framework.UpdateSuspender.#ctor(SciChart.Core.Framework.ISuspendable)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Framework.UpdateSuspender" /> class. + </summary> + <param name="target">The target.</param> + </member> + <member name="P:SciChart.Core.Framework.UpdateSuspender.IsSuspended"> + <summary> + Gets a value indicating whether updates for this instance are currently suspended + </summary> + </member> + <member name="P:SciChart.Core.Framework.UpdateSuspender.ResumeTargetOnDispose"> + <summary> + Gets or sets a value indicating whether the target will resume when the IUpdateSuspender is disposed. Default is True + </summary> + </member> + <member name="M:SciChart.Core.Framework.UpdateSuspender.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="P:SciChart.Core.Framework.UpdateSuspender.Tag"> + <summary> + Gets or sets an associated Tab for this <see cref="T:SciChart.Core.Framework.IUpdateSuspender" /> instance + </summary> + </member> + <member name="M:SciChart.Core.Framework.UpdateSuspender.GetIsSuspended(SciChart.Core.Framework.ISuspendable)"> + <summary> + Thread-safe gets if an instance is currently suspended + </summary> + <param name="target">The target.</param> + <returns>True, if the instance is currently suspended</returns> + </member> + <member name="T:SciChart.Core.ExportType"> + <summary> + Provides values for exporting snapshot of a <see cref="T:System.Windows.UIElement" /> to file. + </summary> + </member> + <member name="F:SciChart.Core.ExportType.Png"> + <summary> + Export in PNG format + </summary> + </member> + <member name="F:SciChart.Core.ExportType.Jpeg"> + <summary> + Export in JPEG format + </summary> + </member> + <member name="F:SciChart.Core.ExportType.Bmp"> + <summary> + Export in BMP format + </summary> + </member> + <member name="F:SciChart.Core.ExportType.Xps"> + <summary> + Export in XPS format + </summary> + </member> + <member name="T:SciChart.Core.DoubleAnimator"> + <summary> + Fluent API class for animating a double DependencyProperty from and to a value + </summary> + </member> + <member name="M:SciChart.Core.DoubleAnimator.WithTarget(System.Windows.UIElement)"> + <summary> + Sets the target element + </summary> + <param name="target">The target.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.DoubleAnimator.WithFromTo(System.Double,System.Double)"> + <summary> + Sets the From and To values + </summary> + <param name="from">From.</param> + <param name="to">To.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.DoubleAnimator.WithTargetProperty(System.String)"> + <summary> + Sets the Target Property to animate + </summary> + <param name="targetProperty">The target property.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.DoubleAnimator.WithDuration(System.TimeSpan)"> + <summary> + Sets the animation duration + </summary> + <param name="duration">The duration.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.DoubleAnimator.WithCompletedHandler(System.EventHandler)"> + <summary> + Sets the Completed Handler + </summary> + <param name="handler">The handler.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.DoubleAnimator.WithEasing(System.Windows.Media.Animation.IEasingFunction)"> + <summary> + Sets the Easing Func + </summary> + <param name="easingFunction">The easing function.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.DoubleAnimator.Go"> + <summary> + Starts the animator + </summary> + </member> + <member name="F:SciChart.Core.NativeLibraryConfig.Method"> + <summary> + Load method : either directly from disk, from resource into disk + </summary> + </member> + <member name="F:SciChart.Core.NativeLibraryConfig.ResourceName"> + <summary> + name of resource to locate in assembly + </summary> + </member> + <member name="F:SciChart.Core.NativeLibraryConfig.FileSystemPath"> + <summary> + File system path, will be used to dump file in case of resources + </summary> + </member> + <member name="F:SciChart.Core.NativeLibraryConfig.assembly"> + <summary> + The assembly + </summary> + </member> + <member name="F:SciChart.Core.NativeLibraryConfig.Overwrite"> + <summary> + Overwrite existing dll or not + </summary> + </member> + <member name="P:SciChart.Core.NativeDllLoader.DependenciesPathRoot"> + <summary> + <para>The dependenciesPathRoot is the root path where SciChart will write out native DLL dependencies during startup. Make sure that this path has write access. The default is %USER%/Appdata/Local/SciChart/Dependencies</para> + <para>To change the path, set this property once before any other SciChart function or method is called, including SciChartSurface.SetRuntimeLicenseKey.</para> + <para>SciChart will create subfolders for environment and version number inside this folder.</para> + </summary> + </member> + <member name="M:SciChart.Core.NativeDllLoader.#cctor"> + <summary> + Initializes the <see cref="T:SciChart.Core.NativeDllLoader" /> class. + </summary> + </member> + <member name="T:SciChart.Core.ObjectPool`1"> + <summary> + Represents a pool of objects with a size limit. + </summary> + <typeparam name="T">The type of object in the pool.</typeparam> + </member> + <member name="M:SciChart.Core.ObjectPool`1.#ctor"> + <summary> + Initializes a new instance of the ObjectPool class. + </summary> + </member> + <member name="M:SciChart.Core.ObjectPool`1.#ctor(System.Int32,System.Func{`0,`0})"> + <summary> + Initializes a new instance of the ObjectPool class. + </summary> + </member> + <member name="P:SciChart.Core.ObjectPool`1.Count"> + <summary> + Gets the summary amount of created instances + </summary> + </member> + <member name="P:SciChart.Core.ObjectPool`1.AvailableCount"> + <summary> + Gets the amount of pooled instances + </summary> + </member> + <member name="P:SciChart.Core.ObjectPool`1.IsEmpty"> + <summary> + Gets the value indicating whether current ObjectPool instance is empty. + </summary> + </member> + <member name="M:SciChart.Core.ObjectPool`1.Get"> + <summary> + Retrieves an item from the pool. + </summary> + <returns>The item retrieved from the pool.</returns> + </member> + <member name="M:SciChart.Core.ObjectPool`1.Get(System.Func{`0,`0})"> + <summary> + Retrieves an item from the pool. + </summary> + <returns>The item retrieved from the pool.</returns> + </member> + <member name="M:SciChart.Core.ObjectPool`1.Get(System.Func{`0})"> + <summary> + Retrieves an item from the pool. + </summary> + <returns>The item retrieved from the pool.</returns> + </member> + <member name="M:SciChart.Core.ObjectPool`1.Put(`0)"> + <summary> + Places an item in the pool. + </summary> + <param name="item">The item to place to the pool.</param> + </member> + <member name="M:SciChart.Core.ObjectPool`1.Dispose"> + <summary> + Disposes of items in the pool that implement IDisposable. + </summary> + </member> + <member name="T:SciChart.Core.MarkupExtensions.MultiBindingCompatible"> + <summary> + Cross platform MultiBinding implementation + </summary> + </member> + <member name="T:SciChart.Core.Messaging.IEventAggregator"> + <summary> + Defines the interface to a lightweight Event Aggregator used within SciChart for inter-component communication + </summary> + </member> + <member name="T:SciChart.Core.Messaging.LoggedMessageBase"> + <summary> + Base class for automatically logged Event Aggregator messages + </summary> + </member> + <member name="M:SciChart.Core.Messaging.LoggedMessageBase.#ctor(System.Object)"> + <summary> + Initializes a new instance of the MessageBase class. + </summary> + <param name="sender">Message sender (usually "this")</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Core.Messaging.RenderSurfaceResizedMessage"> + <summary> + Event message when RenderSurface is resized + </summary> + </member> + <member name="M:SciChart.Core.Messaging.RenderSurfaceResizedMessage.#ctor(System.Object,System.Windows.Size)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Messaging.RenderSurfaceResizedMessage" /> class. + </summary> + <param name="sender">The sender.</param> + <param name="viewportSize">Size of the viewport.</param> + </member> + <member name="P:SciChart.Core.Messaging.RenderSurfaceResizedMessage.ViewportSize"> + <summary> + Gets the size of the viewport. + </summary> + <value> + The size of the viewport. + </value> + </member> + <member name="T:SciChart.Core.Messaging.CoordinateSystemMessage"> + <summary> + Event message when CoordinateSystem changes + </summary> + </member> + <member name="M:SciChart.Core.Messaging.CoordinateSystemMessage.#ctor(System.Object,SciChart.Core.Messaging.CoordinateSystem)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Messaging.CoordinateSystemMessage" /> class. + </summary> + <param name="sender">The sender.</param> + <param name="coordinateSystem">The coordinate system.</param> + </member> + <member name="P:SciChart.Core.Messaging.CoordinateSystemMessage.CoordinateSystem"> + <summary> + Gets the coordinate system. + </summary> + <value> + The coordinate system. + </value> + </member> + <member name="T:SciChart.Core.Messaging.CoordinateSystem"> + <summary> + The CoordinateSystem + </summary> + </member> + <member name="F:SciChart.Core.Messaging.CoordinateSystem.Cartesian"> + <summary> + The cartesian CoordinateSystem + </summary> + </member> + <member name="F:SciChart.Core.Messaging.CoordinateSystem.Polar"> + <summary> + The polar CoordinateSystem + </summary> + </member> + <member name="T:SciChart.Core.Utility.CompositionSyncedDelegate"> + <summary> + Allows synchronizing a Delegate with the <see cref="E:System.Windows.Media.CompositionTarget.Rendering" /> event + </summary> + </member> + <member name="M:SciChart.Core.Utility.CompositionSyncedDelegate.Create(System.Action)"> + <summary> + Creates a new instance of the <see cref="T:SciChart.Core.Utility.CompositionSyncedDelegate" /> class. + </summary> + <param name="operation">The operation.</param> + </member> + <member name="T:SciChart.Core.Utility.SciChartDebugLogger"> + <summary> + Provides a debug logger which can be used to pipe debug messages from SciChart to your own code, by setting the <see cref="T:SciChart.Core.Utility.ISciChartLoggerFacade" /> via SetLogger + </summary> + </member> + <member name="P:SciChart.Core.Utility.SciChartDebugLogger.Instance"> + <summary> + Gets the singleton <see cref="T:SciChart.Core.Utility.SciChartDebugLogger" /> instance + </summary> + </member> + <member name="M:SciChart.Core.Utility.SciChartDebugLogger.WriteLine(System.String,System.Object[])"> + <summary> + Writes a line to the <see cref="T:SciChart.Core.Utility.ISciChartLoggerFacade" />. By default, the facade instance is null. In this case nothing happens + </summary> + <remarks>Logging is performance intensive and will drastically slow down the chart.</remarks> + <param name="formatString">The format string</param> + <param name="args">Optional args for the format string</param> + </member> + <member name="M:SciChart.Core.Utility.SciChartDebugLogger.SetLogger(SciChart.Core.Utility.ISciChartLoggerFacade)"> + <summary> + Sets the <see cref="T:SciChart.Core.Utility.ISciChartLoggerFacade" /> to write to. By default this is null, but after being set, the <see cref="T:SciChart.Core.Utility.SciChartDebugLogger" /> will write all output to this instance + </summary> + <param name="loggerFacade">The <see cref="T:SciChart.Core.Utility.ISciChartLoggerFacade" /> instance.</param> + <remarks>Logging is performance intensive and will drastically slow down the chart. Enable only when necessary</remarks> + </member> + <member name="T:SciChart.Core.Utility.GuardConstraint"> + <summary> + Allows assertions to be built with the following syntax: + <code> + Guard.Assert(123).IsLessThan(456); + </code></summary> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.#ctor(System.IComparable,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.GuardConstraint" /> class. + </summary> + <param name="value">The value.</param> + <param name="argName">Name of the arg.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsLessThan(System.IComparable,System.String)"> + <summary> + Asserts that the current value is less than the specified other value + </summary> + <param name="other">The other value.</param> + <param name="otherArgName">Name of the other arg.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsNotEqualTo(System.IComparable,System.String)"> + <summary> + Asserts that the current value is not equal to the specified other value + </summary> + <param name="other">The other value.</param> + <param name="otherArgName">Name of the other arg.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsEqualTo(System.IComparable,System.String)"> + <summary> + Asserts that the current value is equal to the specified other value + </summary> + <param name="other">The other value.</param> + <param name="otherArgName">Name of the other arg.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsNotEqualTo(System.IComparable)"> + <summary> + Asserts that the current value is not equal to the specified other value + </summary> + <param name="other">The other value.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsLessThanOrEqualTo(System.IComparable,System.String)"> + <summary> + Asserts that the current value is less than or equal to the specified other value + </summary> + <param name="other">The other value.</param> + <param name="otherArgName">Name of the other arg.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsGreaterThanOrEqualTo(System.IComparable)"> + <summary> + Asserts that the current value is greater than or equal to the specified other value + </summary> + <param name="other">The other value.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.GuardConstraint.IsGreaterThan(System.IComparable)"> + <summary> + Asserts that the current value is greater to the specified other value + </summary> + <param name="other">The other value.</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Core.Utility.ISciChartLoggerFacade"> + <summary> + Defines the interface to a logger facade. If you wish to receive debug log messages from SciChart, then set a logger instance via + <see cref="M:SciChart.Core.Utility.SciChartDebugLogger.SetLogger(SciChart.Core.Utility.ISciChartLoggerFacade)" />. Note that logging will dramatically decrease performance, especially in a real-time scenario + </summary> + </member> + <member name="M:SciChart.Core.Utility.ISciChartLoggerFacade.Log(System.String,System.Object[])"> + <summary> + Logs the string format message with optional arguments + </summary> + <param name="formatString">The formatting string</param> + <param name="args">Optional arguments to the formatting string</param> + </member> + <member name="T:SciChart.Core.Utility.Mouse.IPublishMouseEvents"> + <summary> + Defines the interface to a class which publishes mouse events. + Used in conjunction with <see cref="T:SciChart.Core.Utility.Mouse.IReceiveMouseEvents" /> and <see cref="T:SciChart.Core.Utility.Mouse.MouseManager" /> + to provide cross-platform WPF and Silverlight mouse eventing + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.KeyDown"> + <summary> + Occurs when the KeyDown event occurs on this element + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.KeyUp"> + <summary> + Occurs when the KeyUp event occurs on this element + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseLeftButtonDown"> + <summary> + Occurs when the left mouse button is pressed (or when the tip of the stylus touches the tablet) while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseLeftButtonUp"> + <summary> + Occurs when the left mouse button is released (or the tip of the stylus is removed from the tablet) while the mouse (or the stylus) is over a <see cref="T:System.Windows.UIElement" /> (or while a <see cref="T:System.Windows.UIElement" /> holds mouse capture). + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseRightButtonDown"> + <summary> + Occurs when the right mouse button is pressed while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseRightButtonUp"> + <summary> + Occurs when the right mouse button is released while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. However, this event will only be raised if a caller marks the preceding <see cref="E:System.Windows.UIElement.MouseRightButtonDown" /> event as handled; see Remarks. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseMove"> + <summary> + Occurs when the coordinate position of the mouse (or stylus) changes while over a <see cref="T:System.Windows.UIElement" /> (or while a <see cref="T:System.Windows.UIElement" /> holds mouse capture). + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseWheel"> + <summary> + Occurs when the user rotates the mouse wheel while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />, or the <see cref="T:System.Windows.UIElement" /> has focus. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseLeave"> + <summary> + Occurs when the mouse pointer leaves the bounds of this element + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseMiddleButtonDown"> + <summary> + Occurs when the middle mouse button is pressed while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishMouseEvents.MouseMiddleButtonUp"> + <summary> + Occurs when the middle mouse button is released while the mouse pointer is over a <see cref="T:System.Windows.UIElement" />. However, this event will only be raised if a caller marks the preceding <see cref="E:System.Windows.UIElement.MouseRightButtonDown" /> event as handled; see Remarks. + </summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.IPublishTouchEvents"> + <summary> + Defines the interface to a class which publishes touch events. + Used in conjunction with <see cref="T:SciChart.Core.Utility.Mouse.IReceiveTouchEvents" /> and <see cref="T:SciChart.Core.Utility.Mouse.MouseManager" /> + to provide WPF touch interaction with Chart Modifiers + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.TouchDown"> + <summary> + Occurs when an input device begins a manipulation on the <see cref="T:System.Windows.UIElement" />. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.TouchMove"> + <summary> + Occurs when an input device changes position during manipulation. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.TouchUp"> + <summary> + Occurs when a manipulation and inertia on the <see cref="T:System.Windows.UIElement" /> object is complete. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.ManipulationStarting"> + <summary> + Occurs when an input device begins a manipulation on the <see cref="T:System.Windows.UIElement" /></summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.ManipulationStarted"> + <summary> + Occurs when an input device begins a manipulation on the <see cref="T:System.Windows.UIElement" /></summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.ManipulationCompleted"> + <summary> + Occurs when a manipulation and inertia on the System.Windows.UIElement object is complete. + </summary> + </member> + <member name="E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.ManipulationDelta"> + <summary> + Occurs when the input device changes position during a manipulation. + </summary> + </member> + <!-- Badly formed XML comment ignored for member "E:SciChart.Core.Utility.Mouse.IPublishTouchEvents.ManipulationInertiaStarting" --> + <member name="P:SciChart.Core.Utility.Mouse.IPublishTouchEvents.RegisterTouchEvents"> + <summary> + When true, touch events are enabled, else disabled + </summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.IReceiveMouseEvents"> + <summary> + Defines the interface to a type which receives unified Mouse Events (cross-platform WPF and Silverlight). + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.IsEnabled"> + <summary> + Gets or sets whether the mouse target is enabled. + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup"> + <summary> + Gets or sets a Mouse Event Group, an ID used to share mouse events across multiple targets. + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.CanReceiveMouseEvents"> + <summary> + Returns a value indicating whether mouse events should be propagated to the mouse target. + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.ResetKeyboardFocus"> + <summary> + Sets a keyboard focus on a parent root element of the mouse target. + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierDoubleClick(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse DoubleClick occurs. + </summary> + <param name="e">Arguments detailing the mouse button operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierMouseDown(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is pressed. + </summary> + <param name="e">Arguments detailing the mouse button operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierMouseMove(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse is moved. + </summary> + <param name="e">Arguments detailing the mouse move operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierMouseUp(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when a Mouse Button is released. + </summary> + <param name="e">Arguments detailing the mouse button operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierMouseWheel(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the Mouse Wheel is scrolled. + </summary> + <param name="e">Arguments detailing the mouse wheel operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnMasterMouseLeave(SciChart.Core.Utility.Mouse.ModifierMouseArgs)"> + <summary> + Called when the MouseLeave event is fired for a Master of current <see cref="P:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup" />. + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierKeyDown(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyDown event is fired for the Master of the current <see cref="P:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.OnModifierKeyUp(SciChart.Core.Utility.Mouse.ModifierKeyArgs)"> + <summary> + Called when the KeyUp event is fired for the Master of the current <see cref="P:SciChart.Core.Utility.Mouse.IReceiveMouseEvents.MouseEventGroup" /></summary> + <param name="e">Arguments detailing the key event</param> + </member> + <member name="T:SciChart.Core.Utility.Mouse.IReceiveTouchEvents"> + <summary> + Defines the interface to a type which receives WPF4 Touch Events + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchDown(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Touch Down event is registered + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchMove(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called after each touch position change during a manipulation. + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchUp(SciChart.Charting.ChartModifiers.ModifierTouchArgs)"> + <summary> + Called when a Touch Up is complete. + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchManipulationStarting(SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchManipulationStarted(SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs)"> + <summary> + Called when a manipulation is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchManipulationCompleted(SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs)"> + <summary> + Called when a manipulation is completed + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchManipulationDelta(SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs)"> + <summary> + Called when a touch manipulation delta occurs + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IReceiveTouchEvents.OnModifierTouchManipulationInertiaStarting(SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs)"> + <summary> + Called when a manipulation ineritia is starting + </summary> + <param name="e">Arguments detailing the manipulation operation.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ManipulationCompatibilityExtensions.ManipulationOrigin(System.Windows.Input.ManipulationStartedEventArgs)"> + <summary> + Gets the origin point from <see cref="T:System.Windows.Input.ManipulationStartedEventArgs" /></summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ManipulationCompatibilityExtensions.ManipulationOrigin(System.Windows.Input.ManipulationDeltaEventArgs)"> + <summary> + Gets the origin point from <see cref="T:System.Windows.Input.ManipulationDeltaEventArgs" /></summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ManipulationCompatibilityExtensions.CumulativeManipulation(System.Windows.Input.ManipulationDeltaEventArgs)"> + <summary> + Gets the Cumulative Manipulation from <see cref="T:System.Windows.Input.ManipulationDeltaEventArgs" /></summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ManipulationCompatibilityExtensions.DeltaManipulation(System.Windows.Input.ManipulationDeltaEventArgs)"> + <summary> + Gets the Delta Manipulation from <see cref="T:System.Windows.Input.ManipulationDeltaEventArgs" /></summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ManipulationCompatibilityExtensions.Manipulators(System.Windows.Input.ManipulationDeltaEventArgs)"> + <summary> + Gets the collection of Manipulators from <see cref="T:System.Windows.Input.ManipulationDeltaEventArgs" /></summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.ModifierKeyArgs"> + <summary> + Cross platform Key Event Args, used by various classes within SciChart to process key events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.ModifierKeyArgs.Key"> + <summary> + Gets or sets the key. + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.ModifierKeyArgs.Modifier"> + <summary> + Gets or sets the Modifier Key that was pressed at the time of the event + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ModifierKeyArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.ModifierKeyArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ModifierKeyArgs.#ctor(System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.ModifierKeyArgs" /> class. + </summary> + <param name="isMaster">if set to <c>true</c> the event came from a master chart surface, else it came from a slave.</param> + <param name="master">The master chart instance.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ModifierKeyArgs.#ctor(System.Windows.Input.Key,SciChart.Core.Utility.Mouse.MouseModifier,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.ModifierKeyArgs" /> class. + </summary> + <param name="key">The key.</param> + <param name="modifier">The modifier.</param> + <param name="isMaster">if set to <c>true</c> the event came from a master chart surface, else it came from a slave.</param> + <param name="master">The master chart instance.</param> + </member> + <member name="T:SciChart.Core.Utility.Mouse.ModifierMouseArgs"> + <summary> + Defines a cross-platform Mouse event args, used by various classes within SciChart to process mouse events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.ModifierMouseArgs.Delta"> + <summary> + Gets or sets the mouse wheel delta + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.ModifierMouseArgs.MousePoint"> + <summary> + Gets or sets the mouse point that this event occurred at + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.ModifierMouseArgs.MouseButtons"> + <summary> + Gets or sets the MouseButtons that were pressed at the time of the event + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.ModifierMouseArgs.Modifier"> + <summary> + Gets or sets the Modifier Key that was pressed at the time of the event + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ModifierMouseArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.ModifierMouseArgs" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ModifierMouseArgs.#ctor(System.Windows.Point,SciChart.Core.Utility.Mouse.MouseButtons,SciChart.Core.Utility.Mouse.MouseModifier,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.ModifierMouseArgs" /> class. + </summary> + <param name="mousePoint">The mouse point that this event occurred at relative to the chart root grid.</param> + <param name="mouseButtons">The mouse buttons clicked.</param> + <param name="modifier">The modifier key pressed.</param> + <param name="isMaster">If True, then this mouse event occurred on a master ChartModifierBase. + Used to process which modifier was the source of an event when multiple modifiers are linked</param> + <param name="master">The instance of the master ChartModifierBase which sourced the event. Default value is null</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.Mouse.ModifierMouseArgs.#ctor(System.Windows.Point,SciChart.Core.Utility.Mouse.MouseButtons,SciChart.Core.Utility.Mouse.MouseModifier,System.Int32,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.ModifierMouseArgs" /> class. + </summary> + <param name="mousePoint">The mouse point that this event occurred at relative to the chart root grid.</param> + <param name="mouseButtons">The mouse buttons clicked.</param> + <param name="modifier">The modifier key pressed.</param> + <param name="wheelDelta">The mouse wheel delta.</param> + <param name="isMaster">If True, then this mouse event occurred on a master ChartModifierBase. + Used to process which modifier was the source of an event when multiple modifiers are linked</param> + <param name="master">The instance of the master ChartModifierBase which sourced the event. Default value is null</param> + <remarks></remarks> + </member> + <member name="T:SciChart.Core.Utility.Mouse.MouseModifier"> + <summary> + Specifies the Modifier button pressed at the time of a mouse operation + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseModifier.None"> + <summary> + No modifiers were pressed + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseModifier.Shift"> + <summary> + The SHIFT button was pressed + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseModifier.Ctrl"> + <summary> + The CTRL button was pressed + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseModifier.Alt"> + <summary> + The ALT button was pressed + </summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.MouseButtons"> + <summary> + Specifies the MouseButtons pressed at the time of a mouse operation + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseButtons.None"> + <summary> + No buttons were pressed + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseButtons.Left"> + <summary> + The LEFT button was pressed + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseButtons.Middle"> + <summary> + The MIDDLE button was pressed + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseButtons.Right"> + <summary> + The RIGHT button was pressed + </summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.MouseDelegates"> + <summary> + Proxy class to handle mouse-events between a type which implements <see cref="T:SciChart.Core.Utility.Mouse.IPublishMouseEvents" /> and <see cref="T:SciChart.Core.Utility.Mouse.IReceiveMouseEvents" /></summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.Target"> + <summary> + The target element which will receive the notifications + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.KeyDownDelegate"> + <summary> + A proxy delegate for KeyDown events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.KeyUpDelegate"> + <summary> + A proxy delegate for KeyUp events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseLeftUpDelegate"> + <summary> + A proxy delegate for Mouse Left Up events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseLeftDownDelegate"> + <summary> + A proxy delegate for Mouse Left Down events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseMoveDelegate"> + <summary> + A proxy delegate for Mouse Move events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseRightUpDelegate"> + <summary> + A proxy delegate for Mouse Right Up events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseRightDownDelegate"> + <summary> + A proxy delegate for Mouse Right Down events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseMiddleDownDelegate"> + <summary> + A proxy delegate for Mouse Middle Down events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseMiddleUpDelegate"> + <summary> + A proxy delegate for Mouse Middle Up events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseWheelDelegate"> + <summary> + A proxy delegate for Mouse Wheel events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.MouseLeaveDelegate"> + <summary> + A proxy delegate for Mouse Leave events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.TouchDownDelegate"> + <summary> + A proxy delegate for Touch Down events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.TouchMoveDelegate"> + <summary> + A proxy delegate for Touch Move events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.TouchUpDelegate"> + <summary> + A proxy delegate for Touch Up events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.ManipulationStartingDelegate"> + <summary> + A proxy delegate for ManipulationStarting events + </summary> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseDelegates.ManipulationStartedDelegate"> + <summary> + A proxy delegate for ManipulationStarting events + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseDelegates.ManipulationCompletedDelegate"> + <summary> + A proxy delegate for ManipulationCompleted events + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseDelegates.ManipulationDeltaDelegate"> + <summary> + A proxy delegate for ManipulationDelta events + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseDelegates.ManipulationInertiaStartingDelegate"> + <summary> + A proxy delegate for ManipulationInertiaStarting events + </summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.IMouseManager"> + <summary> + Defines the interface to the MouseManager, a cross-platform helper class to propagate mouse events in both Silverlight and WPF + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IMouseManager.Subscribe(SciChart.Core.Utility.Mouse.IPublishMouseEvents,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Subscribes to mouse events on the Source, propagating handlers to the Target + </summary> + <param name="source">The source of mouse events</param> + <param name="target">The target to receive mouse event handlers</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IMouseManager.Unsubscribe(SciChart.Core.Utility.Mouse.IPublishMouseEvents)"> + <summary> + Unsubscribes the source from mouse events + </summary> + <param name="element">The source to unsubscribe</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IMouseManager.Unsubscribe(SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Unsubscribes the element from mouse events + </summary> + <param name="element">The element to unsubscribe</param> + </member> + <member name="T:SciChart.Core.Utility.Mouse.MouseManager"> + <summary> + A cross-platform helper class to propagate mouse events in both Silverlight and WPF + </summary> + </member> + <member name="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty"> + <summary> + Defines the MouseEventGroup Attached Property + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Core.Utility.Mouse.MouseManager" /> class. + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.SetMouseEventGroup(System.Windows.DependencyObject,System.String)"> + <summary> + Sets the MouseEventGroup Attached Property + </summary> + <param name="element">The element.</param> + <param name="modifierGroup">The modifier group.</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.GetMouseEventGroup(System.Windows.DependencyObject)"> + <summary> + Gets the MouseEventGroup Attached Property + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.Subscribe(SciChart.Core.Utility.Mouse.IPublishMouseEvents,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Subscribes to mouse events on the Source, propagating handlers to the Target + </summary> + <param name="source">The source of mouse events</param> + <param name="target">The target to receive mouse event handlers</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.Unsubscribe(SciChart.Core.Utility.Mouse.IPublishMouseEvents)"> + <summary> + Unsubscribes the source from subscribers + </summary> + <param name="source">The source to unsubscribe</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.Unsubscribe(SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Unsubscribes the element from mouse events + </summary> + <param name="element">The element to unsubscribe</param> + </member> + <member name="M:SciChart.Core.Utility.Mouse.MouseManager.GetTargets(SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Gets the Targets that should receive mouse events (in the same <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" /> based on the current provided target + </summary> + <param name="target"></param> + <returns></returns> + </member> + <member name="P:SciChart.Core.Utility.Mouse.MouseManager.SubscribersBySource"> + <summary> + USED INTERNALLY FOR TESTS. DO NOT MODIFY. Gets subscribers by source + </summary> + </member> + <member name="T:SciChart.Core.Utility.Mouse.IMousePositionProvider"> + <summary> + An interface to a provider which converts <see cref="T:System.Windows.Input.MouseEventArgs" /> into <see cref="T:System.Windows.Point" /> coordinates. Used + internally to SciChart and implemented with interface to enable mocking and testing + </summary> + </member> + <member name="M:SciChart.Core.Utility.Mouse.IMousePositionProvider.GetPosition(SciChart.Core.Utility.Mouse.IPublishMouseEvents,System.Windows.Input.MouseEventArgs)"> + <summary> + Gets the mouse position from the <see cref="T:System.Windows.Input.MouseEventArgs" /> as a <see cref="T:System.Windows.Point" /> (pixel coordinates relative to <see cref="T:SciChart.Core.Utility.Mouse.IPublishMouseEvents">source</see></summary> + <param name="source"></param> + <param name="e"></param> + <returns>The mouse position as a <see cref="T:System.Windows.Point" /></returns> + </member> + <member name="T:SciChart.Core.Utility.IServiceContainer"> + <summary> + Defines the interface to a ServiceContainer used throughout SciChart. For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + </member> + <member name="M:SciChart.Core.Utility.IServiceContainer.GetService``1"> + <summary> + Gets the service instance registered by type. For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + <typeparam name="T">The type of service to get </typeparam> + <returns>The service instance, unique to this <see cref="T:SciChart.Core.Utility.IServiceContainer" /> instance</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.IServiceContainer.RegisterService``1(``0)"> + <summary> + Registers the service. + </summary> + <typeparam name="T"></typeparam> + <param name="instance">The instance.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.IServiceContainer.DeRegisterService``1"> + <summary> + Deregisters service of type T + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="M:SciChart.Core.Utility.IServiceContainer.HasService``1"> + <summary> + Determines whether this instance has the service of type <typeparamref name="T" /></summary> + <typeparam name="T"></typeparam> + <returns></returns> + </member> + <member name="T:SciChart.Core.Utility.ServiceContainer"> + <summary> + Provides a container with access to shared services throught SciChart components + </summary> + </member> + <member name="M:SciChart.Core.Utility.ServiceContainer.HasService``1"> + <summary> + Determines whether this instance has the service of type <typeparamref name="T" /></summary> + <typeparam name="T"></typeparam> + <returns></returns> + </member> + <member name="M:SciChart.Core.Utility.ServiceContainer.RegisterService``1(``0)"> + <summary> + Registers the service. + </summary> + <typeparam name="T"></typeparam> + <param name="instance">The instance.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Core.Utility.ServiceContainer.DeRegisterService``1"> + <summary> + Deregisters service of type T + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="M:SciChart.Core.Utility.ServiceContainer.GetService``1"> + <summary> + Gets the service instance registered by type. For a full list of available services, see the remarks on <see cref="T:SciChart.Core.Utility.ServiceContainer" /></summary> + <typeparam name="T">The type of service to get</typeparam> + <remarks></remarks> + </member> + <member name="T:SciChart.Core.Utility.TimedMethodThread"> + <summary> + Enumeration constants to define what thread a <see cref="T:SciChart.Core.Utility.TimedMethod" /> is invoked on + </summary> + </member> + <member name="F:SciChart.Core.Utility.TimedMethodThread.UIThread"> + <summary> + Invoke actions on the UI Thread + </summary> + </member> + <member name="F:SciChart.Core.Utility.TimedMethodThread.Background"> + <summary> + Invoke actions on a background thread + </summary> + </member> + <member name="T:SciChart.Core.Utility.TimedMethod"> + <summary> + TimedMethod allows an Action to be invoked after a specific period of time. Returns a cancellation token which can be cancelled before the method is invoked + </summary> + </member> + <member name="M:SciChart.Core.Utility.TimedMethod.Invoke(System.Action)"> + <summary> + Invokes the specified action. use Fluent API .After .OnThread to specify other options + </summary> + <param name="action">The action.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Utility.TimedMethod.After(System.Int32)"> + <summary> + Invokes the specified action after N milliseconds. Use Fluent API .OnThread to specify other options + </summary> + <param name="milliseconds">The milliseconds.</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Utility.TimedMethod.OnThread(SciChart.Core.Utility.TimedMethodThread)"> + <summary> + Invokes the specified action on a specific thread + </summary> + <param name="thread">The thread to execute on</param> + <returns></returns> + </member> + <member name="M:SciChart.Core.Utility.TimedMethod.Dispose"> + <summary> + Cancels the Timedmethod and disposes timers + </summary> + </member> + <member name="M:SciChart.Core.Utility.TimedMethod.Go"> + <summary> + Starts the timed-method operation + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierEventArgsBase"> + <summary> + Defines a ModifierEventArgsBase, which provides a set of properties and methods which are common to all derived classes + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierEventArgsBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierEventArgsBase" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierEventArgsBase.#ctor(SciChart.Core.Utility.Mouse.IReceiveMouseEvents,System.Boolean)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierEventArgsBase" /> class. + </summary> + <param name="source">The source.</param> + <param name="isMaster">if set to <c>true</c> [is master].</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierEventArgsBase.IsMaster"> + <summary> + If True, then this mouse event occurred on a master ChartModifierBase. + Used to process which modifier was the source of an event when multiple modifiers are linked + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierEventArgsBase.Handled"> + <summary> + Gets or sets whether this event is Handled. If true, no further modifiers will be informed of the mouse event and mouse events will cease bubbling and tunnelling + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierEventArgsBase.Source"> + <summary> + In the case where e.Master is true, this returns the instance of the master chart modifier + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs.#ctor(System.Windows.UIElement,System.Windows.Input.ManipulationStartingEventArgs,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs" /> class. + </summary> + <param name="args">The inner platform args.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs.Mode"> + <summary> + Gets or sets which types of manipulations are possible. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationStartingArgs.Pivot"> + <summary> + Gets or sets an object that describes the pivot for a single-point manipulation. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs.#ctor(System.Windows.UIElement,System.Windows.Input.ManipulationStartedEventArgs,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs" /> class. + </summary> + <param name="args">The inner platform args.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs.Cancel"> + <summary> + Cancels the manipulation and promotes touch to mouse events. + </summary> + <returns>true if touch was successfully promoted to mouse events, otherwise, false.</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationStartedArgs.Complete"> + <summary> + Completes the manipulation without inertia. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.#ctor(System.Windows.UIElement,System.Windows.Input.ManipulationDeltaEventArgs,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs" /> class. + </summary> + <param name="sender">The sender of the event</param> + <param name="args">The inner args.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.CumulativeManipulation"> + <summary> + Gets the cumulated changes of the current manipulation. + </summary> + <value> + The cumulated changes of the current manipulation. + </value> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.DeltaManipulation"> + <summary> + Gets the most recent changes of the current manipulation. + </summary> + <value> + The most recent changes of the current manipulation. + </value> + </member> + <!-- Badly formed XML comment ignored for member "P:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.IsInertial" --> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.Cancel"> + <summary> + Cancels the manipulation and promotes touch to mouse events. + </summary> + <returns>true if touch was successfully promoted to mouse events, otherwise, false.</returns> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.StartInertia"> + <summary> + Starts inertia on the manipulation by ignoring subsequent contact movements and raising the System.Windows.UIElement.ManipulationInertiaStarting event. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationDeltaArgs.Complete"> + <summary> + Completes the manipulation without inertia. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs.#ctor(System.Windows.UIElement,System.Windows.Input.ManipulationCompletedEventArgs,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs" /> class. + </summary> + <param name="sender">The sender of the event</param> + <param name="args">The inner args.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <!-- Badly formed XML comment ignored for member "P:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs.IsInertial" --> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationCompletedArgs.Cancel"> + <summary> + Cancels the manipulation and promotes touch to mouse events. + </summary> + <returns>true if touch was successfully promoted to mouse events, otherwise, false.</returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs.#ctor(System.Windows.UIElement,System.Windows.Input.ManipulationInertiaStartingEventArgs,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs" /> class. + </summary> + <param name="sender">The sender of the event</param> + <param name="args">The inner args.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationInertiaStartingArgs.Cancel"> + <summary> + Cancels the manipulation and promotes touch to mouse events. + </summary> + <returns>true if touch was successfully promoted to mouse events, otherwise, false.</returns> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierManipulationArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierManipulationArgs.#ctor(System.Windows.UIElement,System.Windows.Point,System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents,System.Collections.Generic.IEnumerable{System.Windows.Input.IManipulator})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierManipulationArgs" /> class. + </summary> + <param name="origin">The origin point for the manipulation event</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + <param name="sender">The sender of the event</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationArgs.Sender"> + <summary> + The sender of the Manipulation event + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationArgs.ManipulationOrigin"> + <summary> + Gets the point from which the manipulation originated. + </summary> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierManipulationArgs.Manipulators"> + <summary> + Gets a collection of Manipulators which represent the touch-points in this manipulation operation + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierTouchArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierTouchArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierTouchArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierTouchArgs.#ctor(System.Collections.Generic.IEnumerable{System.Windows.Input.TouchPoint},System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierTouchArgs" /> class. + </summary> + <param name="touchPoints">The touch points.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierTouchArgs.TouchPoints"> + <summary> + Gets a collection of objects that represents the touch contacts for the manipulation. + </summary> + </member> + <member name="T:SciChart.Charting.ChartModifiers.ModifierTouchManipulationArgs"> + <summary> + Defines a cross-platform Manipulation event args, used by classes throughout Scichart process manipulation events. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierTouchManipulationArgs.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierTouchManipulationArgs" /> class. + </summary> + </member> + <member name="M:SciChart.Charting.ChartModifiers.ModifierTouchManipulationArgs.#ctor(System.Collections.Generic.IEnumerable{System.Windows.Input.TouchPoint},System.Boolean,SciChart.Core.Utility.Mouse.IReceiveMouseEvents)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Charting.ChartModifiers.ModifierTouchManipulationArgs" /> class. + </summary> + <param name="touchPoints">The touch points.</param> + <param name="isMaster">if set to <c>true</c>, this is a Master event, else Slave event.</param> + <param name="master">The master instance in the case where charts are synchronized using <see cref="F:SciChart.Core.Utility.Mouse.MouseManager.MouseEventGroupProperty" />.</param> + </member> + <member name="P:SciChart.Charting.ChartModifiers.ModifierTouchManipulationArgs.Manipulators"> + <summary> + Gets a collection of objects that represents the touch contacts for the manipulation. + </summary> + </member> + <member name="T:TinyMessenger.ITinyMessage"> + <summary> + A TinyMessage to be published/delivered by TinyMessenger + </summary> + </member> + <member name="P:TinyMessenger.ITinyMessage.Sender"> + <summary> + The sender of the message, or null if not supported by the message implementation. + </summary> + </member> + <member name="T:TinyMessenger.TinyMessageBase"> + <summary> + Base class for messages that provides weak refrence storage of the sender + </summary> + </member> + <member name="P:TinyMessenger.TinyMessageBase.Sender"> + <summary> + The sender of the message, or null if not supported by the message implementation. + </summary> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.TinyMessageBase.#ctor(System.Object)"> + <summary> + Initializes a new instance of the MessageBase class. + </summary> + <param name="sender">Message sender (usually "this")</param> + </member> + <member name="T:TinyMessenger.GenericTinyMessage`1"> + <summary> + Generic message with user specified content + </summary> + <typeparam name="TContent">Content type to store</typeparam> + </member> + <member name="P:TinyMessenger.GenericTinyMessage`1.Content"> + <summary> + Contents of the message + </summary> + </member> + <member name="M:TinyMessenger.GenericTinyMessage`1.#ctor(System.Object,`0)"> + <summary> + Create a new instance of the GenericTinyMessage class. + </summary> + <param name="sender">Message sender (usually "this")</param> + <param name="content">Contents of the message</param> + </member> + <member name="T:TinyMessenger.CancellableGenericTinyMessage`1"> + <summary> + Basic "cancellable" generic message + </summary> + <typeparam name="TContent">Content type to store</typeparam> + </member> + <member name="P:TinyMessenger.CancellableGenericTinyMessage`1.Cancel"> + <summary> + Cancel action + </summary> + </member> + <member name="P:TinyMessenger.CancellableGenericTinyMessage`1.Content"> + <summary> + Contents of the message + </summary> + </member> + <member name="M:TinyMessenger.CancellableGenericTinyMessage`1.#ctor(System.Object,`0,System.Action)"> + <summary> + Create a new instance of the CancellableGenericTinyMessage class. + </summary> + <param name="sender">Message sender (usually "this")</param> + <param name="content">Contents of the message</param> + <param name="cancelAction">Action to call for cancellation</param> + </member> + <member name="T:TinyMessenger.TinyMessageSubscriptionToken"> + <summary> + Represents an active subscription to a message + </summary> + </member> + <member name="M:TinyMessenger.TinyMessageSubscriptionToken.#ctor(TinyMessenger.ITinyMessengerHub,System.Type)"> + <summary> + Initializes a new instance of the TinyMessageSubscriptionToken class. + </summary> + </member> + <member name="M:TinyMessenger.TinyMessageSubscriptionToken.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + <remarks></remarks> + </member> + <member name="T:TinyMessenger.ITinyMessageSubscription"> + <summary> + Represents a message subscription + </summary> + </member> + <member name="P:TinyMessenger.ITinyMessageSubscription.SubscriptionToken"> + <summary> + Token returned to the subscribed to reference this subscription + </summary> + </member> + <member name="M:TinyMessenger.ITinyMessageSubscription.ShouldAttemptDelivery(TinyMessenger.ITinyMessage)"> + <summary> + Whether delivery should be attempted. + </summary> + <param name="message">Message that may potentially be delivered.</param> + <returns>True - ok to send, False - should not attempt to send</returns> + </member> + <member name="M:TinyMessenger.ITinyMessageSubscription.Deliver(TinyMessenger.ITinyMessage)"> + <summary> + Deliver the message + </summary> + <param name="message">Message to deliver</param> + </member> + <member name="T:TinyMessenger.ITinyMessageProxy"> + <summary> + Message proxy definition. + + A message proxy can be used to intercept/alter messages and/or + marshall delivery actions onto a particular thread. + </summary> + </member> + <member name="M:TinyMessenger.ITinyMessageProxy.Deliver(TinyMessenger.ITinyMessage,TinyMessenger.ITinyMessageSubscription)"> + <summary> + Delivers the specified message. + </summary> + <param name="message">The message.</param> + <param name="subscription">The subscription.</param> + <remarks></remarks> + </member> + <member name="T:TinyMessenger.DefaultTinyMessageProxy"> + <summary> + Default "pass through" proxy. + + Does nothing other than deliver the message. + </summary> + </member> + <member name="P:TinyMessenger.DefaultTinyMessageProxy.Instance"> + <summary> + Singleton instance of the proxy. + </summary> + </member> + <member name="M:TinyMessenger.DefaultTinyMessageProxy.Deliver(TinyMessenger.ITinyMessage,TinyMessenger.ITinyMessageSubscription)"> + <summary> + Delivers the specified message. + </summary> + <param name="message">The message.</param> + <param name="subscription">The subscription.</param> + <remarks></remarks> + </member> + <member name="T:TinyMessenger.TinyMessengerSubscriptionException"> + <summary> + Thrown when an exceptions occurs while subscribing to a message type + </summary> + </member> + <member name="M:TinyMessenger.TinyMessengerSubscriptionException.#ctor(System.Type,System.String)"> + <summary> + Initializes a new instance of the <see cref="T:TinyMessenger.TinyMessengerSubscriptionException" /> class. + </summary> + <param name="messageType">Type of the message.</param> + <param name="reason">The reason.</param> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.TinyMessengerSubscriptionException.#ctor(System.Type,System.String,System.Exception)"> + <summary> + Initializes a new instance of the <see cref="T:TinyMessenger.TinyMessengerSubscriptionException" /> class. + </summary> + <param name="messageType">Type of the message.</param> + <param name="reason">The reason.</param> + <param name="innerException">The inner exception.</param> + <remarks></remarks> + </member> + <member name="T:TinyMessenger.ITinyMessengerHub"> + <summary> + Messenger hub responsible for taking subscriptions/publications and delivering of messages. + </summary> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0})"> + <summary> + Subscribe to a message type with the given destination and delivery action. + All references are held with WeakReferences + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action. + Messages will be delivered via the specified proxy. + All references (apart from the proxy) are held with WeakReferences + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},System.Boolean)"> + <summary> + Subscribe to a message type with the given destination and delivery action. + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction </param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},System.Boolean,TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action. + Messages will be delivered via the specified proxy. + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction </param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean})"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + All references are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean},TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + Messages will be delivered via the specified proxy. + All references (apart from the proxy) are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean},System.Boolean)"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + All references are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean},System.Boolean,TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + Messages will be delivered via the specified proxy. + All references are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction</param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Unsubscribe``1(TinyMessenger.TinyMessageSubscriptionToken)"> + <summary> + Unsubscribe from a particular message type. + + Does not throw an exception if the subscription is not found. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="subscriptionToken">Subscription token received from Subscribe</param> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.Publish``1(``0)"> + <summary> + Publish a message to any subscribers + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="message">Message to deliver</param> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.PublishAsync``1(``0)"> + <summary> + Publish a message to any subscribers asynchronously + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="message">Message to deliver</param> + </member> + <member name="M:TinyMessenger.ITinyMessengerHub.PublishAsync``1(``0,System.AsyncCallback)"> + <summary> + Publish a message to any subscribers asynchronously + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="message">Message to deliver</param> + <param name="callback">AsyncCallback called on completion</param> + </member> + <member name="T:TinyMessenger.TinyMessengerHub"> + <summary> + Messenger hub responsible for taking subscriptions/publications and delivering of messages. + </summary> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0})"> + <summary> + Subscribe to a message type with the given destination and delivery action. + All references are held with strong references + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action. + Messages will be delivered via the specified proxy. + All references (apart from the proxy) are held with strong references + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},System.Boolean)"> + <summary> + Subscribe to a message type with the given destination and delivery action. + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction </param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},System.Boolean,TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action. + Messages will be delivered via the specified proxy. + + All messages of this type will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction </param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean})"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + All references are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean},TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + Messages will be delivered via the specified proxy. + All references (apart from the proxy) are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean},System.Boolean)"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + All references are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Subscribe``1(System.Action{``0},System.Func{``0,System.Boolean},System.Boolean,TinyMessenger.ITinyMessageProxy)"> + <summary> + Subscribe to a message type with the given destination and delivery action with the given filter. + Messages will be delivered via the specified proxy. + All references are held with WeakReferences + Only messages that "pass" the filter will be delivered. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="deliveryAction">Action to invoke when message is delivered</param> + <param name="messageFilter">The message filter.</param> + <param name="useStrongReferences">Use strong references to destination and deliveryAction</param> + <param name="proxy">Proxy to use when delivering the messages</param> + <returns>TinyMessageSubscription used to unsubscribing</returns> + <remarks></remarks> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Unsubscribe``1(TinyMessenger.TinyMessageSubscriptionToken)"> + <summary> + Unsubscribe from a particular message type. + + Does not throw an exception if the subscription is not found. + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="subscriptionToken">Subscription token received from Subscribe</param> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.Publish``1(``0)"> + <summary> + Publish a message to any subscribers + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="message">Message to deliver</param> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.PublishAsync``1(``0)"> + <summary> + Publish a message to any subscribers asynchronously + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="message">Message to deliver</param> + </member> + <member name="M:TinyMessenger.TinyMessengerHub.PublishAsync``1(``0,System.AsyncCallback)"> + <summary> + Publish a message to any subscribers asynchronously + </summary> + <typeparam name="TMessage">Type of message</typeparam> + <param name="message">Message to deliver</param> + <param name="callback">AsyncCallback called on completion</param> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Data.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Data.dll Binary files differnew file mode 100644 index 000000000..bc2c582d9 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Data.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Data.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Data.xml new file mode 100644 index 000000000..a75ab97e8 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Data.xml @@ -0,0 +1,2292 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Data</name> + </assembly> + <members> + <member name="T:SciChart.Data.ColoredVertex"> + <summary> + Defines a Colored Vertex with X,Y Coordinate and Color + </summary> + </member> + <member name="F:SciChart.Data.ColoredVertex.X"> + <summary> + The X-Coordinate + </summary> + </member> + <member name="F:SciChart.Data.ColoredVertex.Y"> + <summary> + The Y-Coordinate + </summary> + </member> + <member name="F:SciChart.Data.ColoredVertex.ColorArgb"> + <summary> + The Color, in Argb format + </summary> + </member> + <member name="F:SciChart.Data.ColoredVertex.U"> + <summary> + The U-Coordinate + </summary> + </member> + <member name="P:SciChart.Data.ColoredVertex.SizeOf"> + <summary> + Gets the SizeOf the struct in bytes + </summary> + </member> + <member name="M:SciChart.Data.Extensions.ListExtensions.ToUncheckedList``1(System.Collections.Generic.IList{``0})"> + <returns>warning: returned array may contain padding zeros in end</returns> + </member> + <member name="M:SciChart.Data.Extensions.ListExtensions.RemoveAllIndices``1(System.Collections.Generic.List{``0},System.Collections.Generic.IEnumerable{System.Int32})"> + <summary> + Removes items with the corresponding indexes from the source list + </summary> + <typeparam name="T"></typeparam> + <param name="list"></param> + <param name="indices"></param> + <returns>Returns an array</returns> + </member> + <member name="M:SciChart.Data.Interop.Charting2DNativeDllsLoader.InitNativeLibs"> + <summary> + Loads native DLLs that SciChart.Data depends on. + </summary> + </member> + <member name="T:SciChart.Data.Model.BindableObject"> + <summary> + Provides a base-type for classes that need to raise <see cref="T:System.ComponentModel.INotifyPropertyChanged" /> events + </summary> + </member> + <member name="M:SciChart.Data.Model.BindableObject.OnPropertyChanged(System.String)"> + <summary> + Raises the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged" /> event + </summary> + <param name="propertyName">Name of the property.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.BindableObject.OnPropertyChanged(System.String,System.Object,System.Object)"> + <summary> + Raises the <see cref="E:System.ComponentModel.INotifyPropertyChanged.PropertyChanged" /> event + </summary> + <param name="propertyName">Name of the property.</param> + <param name="oldValue">Old value of the property.</param> + <param name="newValue">New value of the property.</param> + <remarks></remarks> + </member> + <member name="E:SciChart.Data.Model.BindableObject.PropertyChanged"> + <summary> + Occurs when a property value changes. + </summary> + </member> + <member name="T:SciChart.Data.Model.DateRange"> + <summary> + Defines a Range of Type DateTime + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.DateRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.#ctor(System.DateTime,System.DateTime)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.DateRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.ToString"> + <summary> + Returns a <see cref="T:System.String" /> that represents this instance. + </summary> + <returns>A <see cref="T:System.String" /> that represents this instance.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.DateRange.Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.DateRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <returns></returns> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.DateTime})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" /> with a maximum range limit, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DateRange.ClipTo(SciChart.Data.Model.IRange{System.DateTime})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.DecimalRange"> + <summary> + Defines a range of type <see cref="T:System.Decimal" /></summary> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.DecimalRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.#ctor(System.Decimal,System.Decimal)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.DecimalRange" /> class. + </summary> + <param name="min">The min value.</param> + <param name="max">The max value.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.DecimalRange.Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.DecimalRange.IsZero"> + <summary> + Gets a value indicating whether this instance is zero. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <returns></returns> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.Decimal})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DecimalRange.ClipTo(SciChart.Data.Model.IRange{System.Decimal})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.DoubleRange"> + <summary> + Defines a range of type <see cref="T:System.Double" /></summary> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.DoubleRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.#ctor(System.Double,System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.DoubleRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.DoubleRange.UndefinedRange"> + <summary> + Returns a new Undefined range + </summary> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.DoubleRange.Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.DoubleRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.Double})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.DoubleRange.ClipTo(SciChart.Data.Model.IRange{System.Double})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.FloatRange"> + <summary> + Defines a range of type <see cref="T:System.Single" /></summary> + </member> + <member name="M:SciChart.Data.Model.FloatRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.FloatRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.FloatRange.#ctor(System.Single,System.Single)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.FloatRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.FloatRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.FloatRange.Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.FloatRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.FloatRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.FloatRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.FloatRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.Single})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.FloatRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.FloatRange.ClipTo(SciChart.Data.Model.IRange{System.Single})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.GridData`1"> + <summary> + A Data Structure which stores a 2D uniform array of <typeparam name="T">T</typeparam> elements + </summary> + </member> + <member name="F:SciChart.Data.Model.GridData`1.SyncRoot"> + <summary> + The synchronization object + </summary> + </member> + <member name="M:SciChart.Data.Model.GridData`1.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.GridData`1" /> class, which creates a two-dimensional + </summary> + <param name="xSize">Size of the x.</param> + <param name="zSize">Size of the z.</param> + </member> + <member name="M:SciChart.Data.Model.GridData`1.#ctor(`0[][])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.GridData`1" /> class, passing in the two-dimensional array. Assumes the array is rectangular + </summary> + <param name="innerArray">The inner array.</param> + </member> + <member name="P:SciChart.Data.Model.GridData`1.InternalArray"> + <summary> + Gets the internal array, which is a rectangular two-dimensional array + </summary> + </member> + <member name="P:SciChart.Data.Model.GridData`1.XSize"> + <summary> + Gets the size of the Internal array in the X-direction + </summary> + </member> + <member name="P:SciChart.Data.Model.GridData`1.ZSize"> + <summary> + Gets the size of the Internal array in the Z-direction + </summary> + </member> + <member name="P:SciChart.Data.Model.GridData`1.Item(System.Int32,System.Int32)"> + <summary> + Gets or sets the element with the specified z and x index. + </summary> + </member> + <member name="M:SciChart.Data.Model.GridData`1.Clear(System.Int32,System.Int32)"> + <summary> + Clears and recreates the internal array with the desired X and Z size + </summary> + <param name="xSize">Size of the x.</param> + <param name="zSize">Size of the z.</param> + </member> + <member name="M:SciChart.Data.Model.GridData`1.GetRowAt(System.Int32)"> + <summary> + Gets the row at the specified Z index. The row is length X + </summary> + <param name="zIndex">Index of the z.</param> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.GridData`1.SetRowAt(System.Int32,`0[])"> + <summary> + Sets the row at the specified Z index + </summary> + <param name="zIndex">Index of the z.</param> + <param name="row">The row.</param> + </member> + <member name="M:SciChart.Data.Model.GridData`1.PushRow(`0[])"> + <summary> + Pushes a row into the array, which discards one old row in a First In First Out fashion. use this method to scroll the GridData in the Z-direction + </summary> + <param name="row">The row.</param> + </member> + <member name="T:SciChart.Data.Model.IndexRange"> + <summary> + Defines a range used to specify array indices to another series + </summary> + </member> + <member name="M:SciChart.Data.Model.IndexRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.IndexRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IndexRange.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.IndexRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.IndexRange.IsDefined"> + <summary> + Gets whether this Range is defined + </summary> + <example>Min and Max are not equal to double.NaN and are greater or equal to zero</example> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IndexRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.IndexRange.Diff"> + <summary> + Gets the Diff (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IndexRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IndexRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.IndexRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IndexRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.Int32})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IndexRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IndexRange.ClipTo(SciChart.Data.Model.IRange{System.Int32})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.Int64Range"> + <summary> + Defines a Range of type Int64 + </summary> + </member> + <member name="M:SciChart.Data.Model.Int64Range.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.IntegerRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Int64Range.#ctor(System.Int64,System.Int64)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.IntegerRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Int64Range.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.Int64Range.Diff"> + <summary> + Gets the Diff (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.Int64Range.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Int64Range.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.Int64Range.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Int64Range.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.Int64})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Int64Range.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Int64Range.ClipTo(SciChart.Data.Model.IRange{System.Int64})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.IntegerRange"> + <summary> + Defines a Range of type Integer + </summary> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.IntegerRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.#ctor(System.Int32,System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.IntegerRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.IntegerRange.Diff"> + <summary> + Gets the Diff (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IntegerRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.Int32})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IntegerRange.ClipTo(SciChart.Data.Model.IRange{System.Int32})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.IPointSeries"> + <summary> + Defines the interface to a collection of X,Y data used to render points to the screen. + </summary> + <seealso cref="T:SciChart.Data.Model.Point2DSeries" /> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.XValues"> + <summary> + Gets the Raw X-Values for the PointSeries. + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.OriginalXType"> + <summary> + Gets the original type of X-Values. + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.YValues"> + <summary> + Gets the Raw Y-Values for the PointSeries. + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.OriginalYType"> + <summary> + Gets the original type of Y-Values. + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.Indexes"> + <summary> + Gets the indexes of points in the original DataSeries + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.Count"> + <summary> + Gets or sets the count of elements in the PointSeries + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.Capacity"> + <summary> + Gets or sets the capacity of buffers in the PointSeries + </summary> + </member> + <member name="P:SciChart.Data.Model.IPointSeries.XRange"> + <summary> + Gets or sets the XRange of the Point Series. + </summary> + </member> + <member name="M:SciChart.Data.Model.IPointSeries.GetYRange"> + <summary> + Gets the min, max range in the Y-Direction. + </summary> + <returns>A <see cref="T:SciChart.Data.Model.DoubleRange" /> defining the min, max in the Y-direction.</returns> + </member> + <member name="M:SciChart.Data.Model.IPointSeries.Clear"> + <summary> + Clears content of this instance + </summary> + </member> + <member name="M:SciChart.Data.Model.IPointSeries.ApplyYCalc(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <summary> + Applies Y-Axis Calculator to the series. + </summary> + <param name="yCalc">Y-Axis' </param> + <returns>Created instance.</returns> + </member> + <member name="M:SciChart.Data.Model.IPointSeries.Concat(SciChart.Data.Model.IPointSeries,System.Boolean,System.Double)"> + <summary> + Concatenates two PointSeries together + </summary> + <param name="other">Point Series to concat with.</param> + <param name="fifoMode">Determines whether the FIFO mode is enabled for the Data Series.</param> + <param name="minX">In case of FIFO mode, determines minimum of the XRange.</param> + </member> + <member name="T:SciChart.Data.Model.IXyyPointSeries"> + <summary> + Defines the interface to a collection of X,Y,Y1 data used to render points to the screen. + </summary> + </member> + <member name="P:SciChart.Data.Model.IXyyPointSeries.Y1Values"> + <summary> + Gets the Y1-Values for the PointSeries. + </summary> + </member> + <member name="T:SciChart.Data.Model.IRange"> + <summary> + Defines the base interface to a Range (Min, Max), used throughout SciChart for visible, data and index range calculations + </summary> + </member> + <member name="P:SciChart.Data.Model.IRange.Min"> + <summary> + Gets or sets the Min value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IRange.Max"> + <summary> + Gets or sets the Max value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IRange.IsDefined"> + <summary> + Gets whether this Range is defined + </summary> + <example>Min and Max are not equal to double.NaN, or DateTime.MinValue or DateTime.MaxValue</example> + </member> + <member name="P:SciChart.Data.Model.IRange.Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + </member> + <member name="M:SciChart.Data.Model.IRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.IRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.IRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IRange.SetMinMaxWithLimit(System.Double,System.Double,SciChart.Data.Model.IRange)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IRange.ClipTo(SciChart.Data.Model.IRange)"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange" /> to a maxmimum range with <see cref="F:SciChart.Data.Model.RangeClipMode.MinMax" /> mode + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.IRange.ClipTo(SciChart.Data.Model.IRange,SciChart.Data.Model.RangeClipMode)"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange" /> to a maximum according to clip mode + </summary> + <param name="maximumRange">The maximum range</param> + <param name="clipMode">clip mode which defines how to clip range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.IRange.Union(SciChart.Data.Model.IRange)"> + <summary> + Performs the Union of two <see cref="T:SciChart.Data.Model.IRange" /> instances, returning a new <see cref="T:SciChart.Data.Model.IRange" /></summary> + </member> + <member name="M:SciChart.Data.Model.IRange.IsValueWithinRange(System.IComparable)"> + <summary> + Returns True if the value is within the Min and Max of the Range + </summary> + <param name="value">The value to test</param> + <returns>True if the value is within the Min and Max of the Range</returns> + </member> + <member name="T:SciChart.Data.Model.IRange`1"> + <summary> + Defines the generic interface to a Range (Min, Max), used throughout SciChart for visible, data and index range calculations + </summary> + <typeparam name="T">The Type Parameter, expected types are Double, DateTime etc... </typeparam> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.IRange`1.Min"> + <summary> + Gets or sets the Min value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IRange`1.Max"> + <summary> + Gets or sets the Max value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.IRange`1.Diff"> + <summary> + Gets the Diff (Max - Min) of this range + </summary> + </member> + <member name="M:SciChart.Data.Model.IRange`1.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and maxFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IRange`1.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.IRange`1.SetMinMaxT(`0,`0)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.IRange`1.Union(SciChart.Data.Model.IRange{`0})"> + <summary> + Performs the Union of two <see cref="T:SciChart.Data.Model.IRange" /> instances, returning a new <see cref="T:SciChart.Data.Model.IRange" /></summary> + <example> + <code> + var firstRange = new DoubleRange(1, 2); + var secondRange = new DoubleRange(1.5, 2.5) + var unionRange = firstRange.Union(secondRange); + // unionRange result should be new DoubleRange(1, 2.5) + </code> + </example> + <param name="range"></param> + <returns></returns> + </member> + <member name="T:SciChart.Data.Model.RangeClipMode"> + <summary> + Provide values which define how to perform clipping of <see cref="T:SciChart.Data.Model.IRange" /></summary> + </member> + <member name="F:SciChart.Data.Model.RangeClipMode.MinMax"> + <summary> + Allow clipping at Min and Max + </summary> + </member> + <member name="F:SciChart.Data.Model.RangeClipMode.Max"> + <summary> + Allow clipping only at Max + </summary> + </member> + <member name="F:SciChart.Data.Model.RangeClipMode.Min"> + <summary> + Allow clipping only at Min + </summary> + </member> + <member name="T:SciChart.Data.Model.ISciList`1"> + <summary> + Defines a high-performance array-backed generic list type + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.GetMaximum"> + <summary> + Gets the maximum in the list + </summary> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.GetMinimum"> + <summary> + Gets the minimum in the list + </summary> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.GetMinMax(`0@,`0@)"> + <summary> + Gets the minimum and maximum in the list + </summary> + <param name="min">The minimum value in the list</param> + <param name="max">The maximum value in the list</param> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.AddRange(System.Collections.Generic.IEnumerable{`0})"> + <summary> + Adds a range of items to the list + </summary> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.InsertRange(System.Int32,System.Collections.Generic.IEnumerable{`0})"> + <summary> + Inserts a range of items to the list + </summary> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.RemoveRange(System.Int32,System.Int32)"> + <summary> + Removes a range of items from the list + </summary> + </member> + <member name="P:SciChart.Data.Model.ISciList`1.ItemsArray"> + <summary> + Gets the internal ItemsArray that this list wraps for direct unchecked access + NOTE: The count of the ItemsArray may differ from the count of the List. Use the List.Count when iterating + </summary> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.SetCount(System.Int32)"> + <summary> + Forces the count of the list, in operations where we know the capacity in advance + </summary> + <param name="setLength"></param> + </member> + <member name="P:SciChart.Data.Model.ISciList`1.HasValues"> + <summary> + Gets a value indicating whether this list has any values. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.AsList"> + <summary> + Gets this instance as <see cref="T:System.Collections.IList" /> instance + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.ContainsNaN(System.Int32,System.Int32)"> + <summary> + Gets a value indicating whether this list has NaN values in specified range + </summary> + <param name="startIndex"></param> + <param name="count"></param> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.IsSortedAscending(System.Int32,System.Int32)"> + <summary> + Gets a value indicating whether this list has sorted ascending values in specified range + </summary> + <param name="startIndex"></param> + <param name="count"></param> + <returns></returns> + </member> + <member name="M:SciChart.Data.Model.ISciList`1.IsEvenlySpaced(System.Int32,System.Int32,System.Double,System.Double@)"> + <summary> + Gets a value indicating whether this list has evenly spaced values in specified range + </summary> + <param name="startIndex"></param> + <param name="count"></param> + <param name="epsilon"></param> + <param name="spacing"></param> + <returns></returns> + </member> + <member name="T:SciChart.Data.Model.IVertexBuffer"> + <summary> + Buffer of vertices, managed on native side and used for native point series rendering purposes. + </summary> + </member> + <member name="P:SciChart.Data.Model.IVertexBuffer.Count"> + <summary> + Gets count of elements in buffer. + </summary> + </member> + <member name="P:SciChart.Data.Model.IVertexBuffer.DataPointer"> + <summary> + Gets pointer to native vector of elements. + </summary> + </member> + <member name="P:SciChart.Data.Model.IVertexBuffer.StrideX"> + <summary> + Gets stride values of X field in an element. + </summary> + </member> + <member name="P:SciChart.Data.Model.IVertexBuffer.StrideY"> + <summary> + Gets stride values of Y field in an element. + </summary> + </member> + <member name="P:SciChart.Data.Model.IVertexBuffer.ElementSize"> + <summary> + Gets an element size. + </summary> + </member> + <member name="M:SciChart.Data.Model.IVertexBuffer.Reserve(System.Int32)"> + <summary> + Reserves specified size of elements. + </summary> + <param name="size">Size of elements.</param> + </member> + <member name="M:SciChart.Data.Model.IVertexBuffer.Clear"> + <summary> + Clears the vertex buffer. + </summary> + </member> + <member name="T:SciChart.Data.Model.Point2DSeries"> + <summary> + Defines a strongly typed PointSeries which contains subset of X,Y data used to render points to the screen. + </summary> + </member> + <member name="M:SciChart.Data.Model.Point2DSeries.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.Point2DSeries" /> class. + </summary> + <param name="capacity">The required capacity.</param> + </member> + <member name="M:SciChart.Data.Model.Point2DSeries.#ctor(SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Int32})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.Point2DSeries" /> class. + </summary> + <param name="xValues">The xValues</param> + <param name="yValues">The yValues</param> + <param name="indexes">The indexes</param> + </member> + <member name="P:SciChart.Data.Model.Point2DSeries.XValues"> + <inheritdoc /> + </member> + <member name="P:SciChart.Data.Model.Point2DSeries.YValues"> + <inheritdoc /> + </member> + <member name="M:SciChart.Data.Model.Point2DSeries.GetYRange"> + <inheritdoc /> + </member> + <member name="M:SciChart.Data.Model.Point2DSeries.Resize(System.Int32)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Data.Model.Point2DSeries.EnsureCapacity(System.Int32)"> + <inheritdoc /> + </member> + <member name="M:SciChart.Data.Model.Point2DSeries.Clear"> + <inheritdoc /> + </member> + <member name="T:SciChart.Data.Model.XyyPoint2DSeries"> + <summary> + Defines a strongly typed PointSeries which contains subset of X,Y,Y1 data used to render points to the screen. + </summary> + </member> + <member name="M:SciChart.Data.Model.XyyPoint2DSeries.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.XyyPoint2DSeries" /> class. + </summary> + <param name="capacity">The required capacity.</param> + </member> + <member name="M:SciChart.Data.Model.XyyPoint2DSeries.#ctor(SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Double},SciChart.Data.Model.Values{System.Int32})"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.XyyPoint2DSeries" /> class. + </summary> + <param name="xValues">The xValues</param> + <param name="yValues">The yValues</param> + <param name="y1Values">The y1Values</param> + <param name="indexes">The indexes</param> + </member> + <member name="P:SciChart.Data.Model.XyyPoint2DSeries.Y1Values"> + <summary> + Gets the Y1-Values for the PointSeries. + </summary> + </member> + <member name="M:SciChart.Data.Model.XyyPoint2DSeries.Resize(System.Int32)"> + <summary> + Resizes this point series instance + </summary> + <param name="newCount">The new count value</param> + </member> + <member name="M:SciChart.Data.Model.XyyPoint2DSeries.EnsureCapacity(System.Int32)"> + <summary> + Changes capacity of this point series instance + </summary> + <param name="newCapacity">The new capacity value</param> + </member> + <member name="M:SciChart.Data.Model.XyyPoint2DSeries.Clear"> + <summary> + Clears content of this instance + </summary> + </member> + <member name="M:SciChart.Data.Model.XyyPoint2DSeries.GetYRange"> + <summary> + Gets the min, max range in the Y-Direction. + </summary> + <returns> + A <see cref="T:SciChart.Data.Model.DoubleRange" /> defining the min, max in the Y-direction. + </returns> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.XValues"> + <summary> + Gets the X-Values for the PointSeries. + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.OriginalXType"> + <summary> + Gets the original type of X-Values. + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.YValues"> + <summary> + Gets the Y-Values for the PointSeries. + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.OriginalYType"> + <summary> + Gets the original type of Y-Values. + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.Indexes"> + <summary> + Gets the Indexes for the PointSeries. + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.Count"> + <summary> + Gets the count of the PointSeries. + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.Capacity"> + <summary> + Gets or sets the capacity of the PointSeries + </summary> + </member> + <member name="P:SciChart.Data.Model.PointSeriesBase.XRange"> + <summary> + Gets or sets the XRange of the Point Series. + </summary> + </member> + <member name="M:SciChart.Data.Model.PointSeriesBase.Resize(System.Int32)"> + <summary> + Resizes this point series instance. + </summary> + <param name="count">The new count value</param> + </member> + <member name="M:SciChart.Data.Model.PointSeriesBase.EnsureCapacity(System.Int32)"> + <summary> + Changes capacity of this point series instance. + </summary> + <param name="capacity">The new capacity value</param> + </member> + <member name="M:SciChart.Data.Model.PointSeriesBase.Clear"> + <summary> + Clears content of this instance. + </summary> + </member> + <member name="M:SciChart.Data.Model.PointSeriesBase.ApplyYCalc(SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator{System.Double})"> + <inheritdoc /> + </member> + <member name="M:SciChart.Data.Model.PointSeriesBase.GetYRange"> + <summary> + Gets the min, max range in the Y-Direction. + </summary> + <returns> + A <see cref="T:SciChart.Data.Model.DoubleRange" /> defining the min, max in the Y-direction. + </returns> + </member> + <member name="M:SciChart.Data.Model.PointSeriesBase.Concat(SciChart.Data.Model.IPointSeries,System.Boolean,System.Double)"> + <summary> + Concatenates two PointSeries together + </summary> + <param name="other">Point Series to concat with.</param> + <param name="fifoMode">Determines whether the FIFO mode is enabled for the Data Series.</param> + <param name="minX">In case of FIFO mode, determines minimum of the XRange.</param> + </member> + <member name="T:SciChart.Data.Model.PropertyChangedEventArgsWithValues"> + <summary> + Provides data for the System.ComponentModel.INotifyPropertyChanged.PropertyChanged event. + </summary> + </member> + <member name="M:SciChart.Data.Model.PropertyChangedEventArgsWithValues.#ctor(System.String,System.Object,System.Object)"> + <summary> + Initializes a new instance of the PropertyChangedEventArgsWithValues class + </summary> + <param name="propertyName"> The name of the property that changed.</param> + <param name="oldValue"> Old value of the property that changed. </param> + <param name="newValue"> New value of the property that changed. </param> + </member> + <member name="P:SciChart.Data.Model.PropertyChangedEventArgsWithValues.OldValue"> + <summary> + Gets an old value of property that changed + </summary> + </member> + <member name="P:SciChart.Data.Model.PropertyChangedEventArgsWithValues.NewValue"> + <summary> + Gets a new value of property that changed + </summary> + </member> + <member name="T:SciChart.Data.Model.Range`1"> + <summary> + Abstract base implementation of <see cref="T:SciChart.Data.Model.IRange" />, used throughout SciChart for visible, data and index range calculations + </summary> + <typeparam name="T">The typeparameter of the range, e.g. <see cref="T:System.Double" /></typeparam> + </member> + <member name="M:SciChart.Data.Model.Range`1.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.Range`1" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.#ctor(`0,`0)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.Range`1" /> class. + </summary> + <param name="min">The min value.</param> + <param name="max">The max value.</param> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.Range`1.IsDefined"> + <summary> + Gets whether this Range is defined + </summary> + <example>Min and Max are not equal to double.NaN, or DateTime.MinValue or DateTime.MaxValue</example> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.Range`1.SciChart#Data#Model#IRange#Min"> + <summary> + Gets or sets the Min value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.Range`1.SciChart#Data#Model#IRange#Max"> + <summary> + Gets or sets the Max value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.Range`1.SciChart#Data#Model#IRange#Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.Range`1.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.Range`1.Min"> + <summary> + Gets or sets the Min value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.Range`1.Max"> + <summary> + Gets or sets the Max value of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.Range`1.Diff"> + <summary> + Gets the Diff (Max - Min) of this range + </summary> + </member> + <member name="M:SciChart.Data.Model.Range`1.Clone"> + <summary> + Creates a new object that is a copy of the current instance. + </summary> + <returns>A new object that is a copy of this instance.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.ClipTo(SciChart.Data.Model.IRange{`0})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <returns></returns> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.DateRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.SetMinMaxT(`0,`0)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance</returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{`0})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" /> with a maximum range limit, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.SetMinMaxInternal(`0,`0)"> + <summary> + Internal implementation: Sets the Min, Max values of the <see cref="T:SciChart.Data.Model.Range`1" /></summary> + <param name="min">The new Min value</param> + <param name="max">The new Max value</param> + </member> + <member name="M:SciChart.Data.Model.Range`1.ClipTo(SciChart.Data.Model.IRange)"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange" /> to a maxmimum range with <see cref="F:SciChart.Data.Model.RangeClipMode.MinMax" /> mode + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.ClipTo(SciChart.Data.Model.IRange,SciChart.Data.Model.RangeClipMode)"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange" /> to a maximum according to clip mode + </summary> + <param name="maximumRange">The maximum range</param> + <param name="clipMode">clip mode which defines how to clip range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.Union(SciChart.Data.Model.IRange)"> + <summary> + Performs the Union of two <see cref="T:SciChart.Data.Model.IRange" /> instances, returning a new <see cref="T:SciChart.Data.Model.IRange" /></summary> + </member> + <member name="M:SciChart.Data.Model.Range`1.IsValueWithinRange(System.IComparable)"> + <summary> + Returns True if the value is within the Min and Max of the Range + </summary> + <param name="value">The value to test</param> + <returns> + True if the value is within the Min and Max of the Range + </returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.Union(SciChart.Data.Model.IRange{`0})"> + <summary> + Performs a Union logical operation between two ranges. The returned <see cref="T:SciChart.Data.Model.IRange`1" /> has Min = Math.Min(range1.min, range2.min) + and Max = Math.Max(range1.Max, range2.Max) + </summary> + <param name="range">The input range to union with this range</param> + <returns>The range result</returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.SciChart#Data#Model#IRange#SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.SciChart#Data#Model#IRange#SetMinMaxWithLimit(System.Double,System.Double,SciChart.Data.Model.IRange)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange" /> with a max range to clip values to, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range, which is used to clip values.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.SciChart#Data#Model#IRange#GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The max fraction.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.ToString"> + <summary> + Returns the <see cref="T:System.String" /> that represents current <see cref="T:SciChart.Data.Model.IRange" />. + </summary> + <returns>A <see cref="T:System.String" /> that represents this instance.</returns> + </member> + <member name="M:SciChart.Data.Model.Range`1.GetHashCode"> + <summary> + Returns a hash code for this instance. + </summary> + <returns>A hash code for this instance, suitable for use in hashing algorithms and data structures like a hash table.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.Equals(System.Object)"> + <summary> + Compares Min and Max values to determine whether the specified <see cref="T:System.Object" /> is equal to this instance. + </summary> + <param name="obj">The <see cref="T:System.Object" /> to compare with the current <see cref="T:System.Object" />.</param> + <returns> + <c>true</c> if the specified <see cref="T:System.Object" /> is equal to this instance; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.Range`1.Equals(SciChart.Data.Model.IRange{`0})"> + <summary> + Compares Min and Max values to determine whether the specified <see cref="T:SciChart.Data.Model.IRange`1" /> is equal to this instance. + </summary> + <param name="other">The <see cref="T:SciChart.Data.Model.IRange`1" /> to compare with the current <see cref="T:SciChart.Data.Model.IRange`1" />.</param> + <returns> + <c>true</c> if the specified <see cref="T:SciChart.Data.Model.IRange`1" /> is equal to this instance; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="T:SciChart.Data.Model.RangeFactory"> + <summary> + Helper class to instantiate IRange derived types, where strong typing is required underneath but the runtime type of IRange is not known + </summary> + </member> + <member name="M:SciChart.Data.Model.RangeFactory.NewWithMinMax(SciChart.Data.Model.IRange,System.IComparable,System.IComparable)"> + <summary> + Creates a new <see cref="T:SciChart.Data.Model.IRange" /> derived instance of the same type as originalRange with the specified Min and Max + </summary> + <param name="originalRange">The original range to use as a reference</param> + <param name="min">The min value of the new range</param> + <param name="max">The max value of the new range</param> + <returns>A new <see cref="T:SciChart.Data.Model.IRange" /> derived instance of the same type as originalRange</returns> + </member> + <member name="M:SciChart.Data.Model.RangeFactory.NewWithMinMax(SciChart.Data.Model.IRange,System.Double,System.Double,SciChart.Data.Model.IRange)"> + <summary> + Creates a new <see cref="T:SciChart.Data.Model.IRange" /> derived instance of the same type as originalRange with the specified Min and Max, with a Range Limit to clip min, max to. + </summary> + <param name="originalRange">The original range to use as a reference</param> + <param name="min">The min value of the new range</param> + <param name="max">The max value of the new range</param> + <param name="rangeLimit">The range limit to clip Min and Max to.</param> + <returns>A new <see cref="T:SciChart.Data.Model.IRange" /> derived instance of the same type as originalRange</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.RangeFactory.NewRange(System.IComparable,System.IComparable)"> + <summary> + Creates a new <see cref="T:SciChart.Data.Model.IRange" /> instance of the same type as the min, max range with the specified Min and Max + </summary> + <param name="min">The min value of the new range</param> + <param name="max">The max value of the new range</param> + <returns>A new <see cref="T:SciChart.Data.Model.IRange" /> derived instance of the same type as the input values</returns> + </member> + <member name="M:SciChart.Data.Model.RangeFactory.NewRange(System.Type,System.IComparable,System.IComparable)"> + <summary> + Creates a new <see cref="T:SciChart.Data.Model.IRange" /> instance of desired type, setting the min and max value + </summary> + <param name="rangeType">Type of the range to create, e.g. <see cref="T:SciChart.Data.Model.IndexRange" /> or <see cref="T:SciChart.Data.Model.DoubleRange" />.</param> + <param name="min">The min value of the new range</param> + <param name="max">The max value of the new range</param> + <returns> + A new <see cref="T:SciChart.Data.Model.IRange" /> derived instance of the same type as the input values + </returns> + </member> + <member name="T:SciChart.Data.Model.TimeSpanRange"> + <summary> + Defines a Range of Type TimeSpan + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.TimeSpanRange" /> class. + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.#ctor(System.TimeSpan,System.TimeSpan)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.TimeSpanRange" /> class. + </summary> + <param name="min">The min.</param> + <param name="max">The max.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.ToString"> + <summary> + Returns a <see cref="T:System.String" /> that represents this instance. + </summary> + <returns>A <see cref="T:System.String" /> that represents this instance.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.Clone"> + <summary> + Clones this instance. + </summary> + <returns></returns> + <remarks></remarks> + </member> + <member name="P:SciChart.Data.Model.TimeSpanRange.Diff"> + <summary> + Gets the difference (Max - Min) of this range + </summary> + </member> + <member name="P:SciChart.Data.Model.TimeSpanRange.IsZero"> + <summary> + Gets whether the range is Zero, where Max equals Min + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.AsDoubleRange"> + <summary> + Converts this range to a <see cref="T:SciChart.Data.Model.DoubleRange" />, which are used internally for calculations + </summary> + <returns></returns> + <example>For numeric ranges, the conversion is simple. For <see cref="T:SciChart.Data.Model.TimeSpanRange" /> instances, returns a new <see cref="T:SciChart.Data.Model.DoubleRange" /> with the Min and Max Ticks</example> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.SetMinMax(System.Double,System.Double)"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" />, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.SetMinMax(System.Double,System.Double,SciChart.Data.Model.IRange{System.TimeSpan})"> + <summary> + Sets the Min, Max values on the <see cref="T:SciChart.Data.Model.IRange`1" /> with a maximum range limit, returning this instance after modification + </summary> + <param name="min">The new Min value.</param> + <param name="max">The new Max value.</param> + <param name="maxRange">The max range.</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.GrowBy(System.Double,System.Double)"> + <summary> + Grows the current <see cref="T:SciChart.Data.Model.IRange`1" /> by the min and max fraction, returning this instance after modification + </summary> + <param name="minFraction">The Min fraction to grow by. For example, Min = -10 and minFraction = 0.1 will result in the new Min = -11</param> + <param name="maxFraction">The Max fraction to grow by. For example, Max = 10 and minFraction = 0.2 will result in the new Max = 12</param> + <returns>This instance, after the operation</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Data.Model.TimeSpanRange.ClipTo(SciChart.Data.Model.IRange{System.TimeSpan})"> + <summary> + Clips the current <see cref="T:SciChart.Data.Model.IRange`1" /> to a maxmimum range + </summary> + <param name="maximumRange">The Maximum Range</param> + <returns>This instance, after the operation</returns> + </member> + <member name="T:SciChart.Data.Model.UncheckedList`1"> + <summary> + A list wrapper that gives access to the underlying array. + TODO: Not fully implemented + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="T:SciChart.Data.Model.Values`1"> + <summary> + Defines a wrapper class for an array which can be resized + </summary> + <typeparam name="T">Type of items</typeparam> + </member> + <member name="M:SciChart.Data.Model.Values`1.#ctor(System.Int32)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.Values`1" /> class. + </summary> + <param name="capacity">initial capacity of <see cref="P:SciChart.Data.Model.Values`1.Items" /> array</param> + </member> + <member name="M:SciChart.Data.Model.Values`1.#ctor(`0[])"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Data.Model.Values`1" /> class. + </summary> + <param name="items">Initial <see cref="P:SciChart.Data.Model.Values`1.Items" /> array</param> + </member> + <member name="P:SciChart.Data.Model.Values`1.Items"> + <summary> + Gets the array with value for direct unchecked access + NOTE: The length of array may differ from the count of the Values. Use <see cref="P:SciChart.Data.Model.Values`1.Count" /> when iterating + </summary> + </member> + <member name="P:SciChart.Data.Model.Values`1.Item(System.Int32)"> + <summary> + Gets or sets the value at the specified index. + </summary> + </member> + <member name="P:SciChart.Data.Model.Values`1.Count"> + <summary> + Gets or sets the number of values contained in this <see cref="T:SciChart.Data.Model.Values`1" /> instance + </summary> + </member> + <member name="P:SciChart.Data.Model.Values`1.Capacity"> + <summary> + Gets or sets the size of <see cref="P:SciChart.Data.Model.Values`1.Items" /> array + NOTE. If new capacity is less than current capacity then new value is ignored + </summary> + </member> + <member name="M:SciChart.Data.Model.Values`1.Clear(System.Boolean)"> + <summary> + Clears content of this <see cref="T:SciChart.Data.Model.Values`1" /> instance + </summary> + <param name="disposeItems">If true <see cref="P:SciChart.Data.Model.Values`1.Items" /> array will be recreated, otherwise it will be reused</param> + </member> + <member name="M:SciChart.Data.Model.Values`1.GetEnumerator"> + <summary> + Returns an enumerator that iterates through values. + </summary> + </member> + <member name="M:SciChart.Data.Model.Values`1.System#Collections#IEnumerable#GetEnumerator"> + <summary> + Returns an enumerator that iterates through values. + </summary> + </member> + <member name="T:SciChart.Data.Numerics.GenericMath.IMath`1"> + <summary> + Defines the interface to a generic math helper + </summary> + <typeparam name="T"></typeparam> + </member> + <member name="P:SciChart.Data.Numerics.GenericMath.IMath`1.MinValue"> + <summary> + Gets the MinValue for T. for DateTime it returns DateTime.MinValue (it has .Ticks = 0) + </summary> + </member> + <member name="P:SciChart.Data.Numerics.GenericMath.IMath`1.MaxValue"> + <summary> + Gets the MaxValue for T. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.GenericMath.IMath`1.ZeroValue"> + <summary> + Gets the ZeroValue for T. for DateTime it returns DateTime.MinValue (it has .Ticks = 0) + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Max(`0,`0)"> + <summary> + Returns the Max of A and B + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Min(`0,`0)"> + <summary> + Returns the Min of A and B + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.MinGreaterThan(`0,`0,`0)"> + <summary> + Returns the Min of A and B greater than a Floor + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.IsNaN(`0)"> + <summary> + Returns if T is NaN. Only valid for Float, Double types. For all other types, always returns false + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Subtract(`0,`0)"> + <summary> + Subtracts a - b. For DateTime it returns a new DateTime with .Ticks = a.Ticks - b.Ticks + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Abs(`0)"> + <summary> + Get the Absolute value of (a) + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.ToDouble(`0)"> + <summary> + Converts to the equivalent value as a double + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Mult(`0,`0)"> + <summary> + Multiplies lhs * rhs + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Mult(`0,System.Double)"> + <summary> + Multiplies lhs * rhs + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Div(`0,`0)"> + <summary> + Divides lhs / rhs + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Add(`0,`0)"> + <summary> + Adds lhs + rhs. for DateTime it returns a new DateTime with .Ticks = lhs.Ticks + rhs.Ticks + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Inc(`0@)"> + <summary> + Returns T++ + for DateTime it increments .Ticks + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.Dec(`0@)"> + <summary> + Returns T-- + for DateTime it decrements .Ticks + </summary> + </member> + <member name="M:SciChart.Data.Numerics.GenericMath.IMath`1.FromDouble(System.Double)"> + <summary> + Converts a Double value to type <typeparam name="T"></typeparam></summary> + <param name="dValue"></param> + <returns></returns> + </member> + <member name="F:SciChart.Data.Numerics.PointResamplers.ExtremeResamplerAccelerationMode.Auto"> + <summary>Automatic detection of the best (fastest) SIMD version based on your CPU capabilities</summary> + </member> + <member name="F:SciChart.Data.Numerics.PointResamplers.ExtremeResamplerAccelerationMode.None"> + <summary>Do not use SIMD</summary> + </member> + <member name="F:SciChart.Data.Numerics.PointResamplers.ExtremeResamplerAccelerationMode.Avx"> + <summary>Force AVX SIMD instruction set</summary> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.INativeResamplerArtifact"> + <summary> + Native Resampler Artifact. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.INativeResamplerArtifact.Count"> + <summary> + Gets or sets number of contained elements. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.INativeResamplerArtifact.Capacity"> + <summary> + Gets or sets reserved amount of elements artifact can hold. + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.INativeResamplerArtifact.CalculateYCoordinates(SciChart.Charting2D.Interop.CoordinateCalculator)"> + <summary> + Calculates Y-Axis coordinated for resampled points. + </summary> + <param name="calculator">Y-Axis calculator, used for calculation.</param> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.INativeResamplerArtifact.GetYRange"> + <summary> + Calculates the range of Y-Axis. + </summary> + <returns>Calculated range.</returns> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory"> + <summary> + A Factory class to get PointResamplers, which are used to reduce datasets to minimal sets for efficient on-screen rendering + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.IPointResamplerFactory.GetPointResampler``2"> + <summary> + Gets the <see cref="!:IPointResampler" /> instance to handle this combination of Tx and Ty generic type parameters + </summary> + <typeparam name="TX">Type of the X-Axis.</typeparam> + <typeparam name="TY">Type of the Y-Axis.</typeparam> + <returns>Created Point Resampler.</returns> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.ResamplingParams"> + <summary> + Provides arguments which are required by <see cref="T:SciChart.Data.Numerics.PointResamplers.IPointResampler`2" /></summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.IsSortedData"> + <summary> + Specifies whether the data is sorted in the X direction. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.IsEvenlySpacedData"> + <summary> + Specifies whether the data is evenly spaced in the X direction. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.IsCategoryData"> + <summary> + Specifies if the XAxis is a category axis. It allows performance optimization in avoiding copying the X values. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.ContainsNaN"> + <summary> + Specifies if the yData contains NaN values + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.ZeroLineY"> + <summary> + Specifies the value which determines the zero line in Y direction + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.PointRange"> + <summary> + The indices of the X and Y input data to use (clips by indices) + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.VisibleRange"> + <summary> + The VisibleRange of the XAxis at the time of resampling + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.ViewportWidth"> + <summary> + The current width of the Viewport + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.IsFifo"> + <summary> + Specifies whether the data buffer is FIFO. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.FifoSize"> + <summary> + The size of FIFO buffer of the XAxis at the time of resampling. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.FifoStartIndex"> + <summary> + The Base Index of FIFO buffer of the XAxis at the time of resampling. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.RenderPassId"> + <summary> + ID of the current render pass, which is used to detect shared DataSeries during resampling + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.LastRenderPassId"> + <summary> + ID of the last render pass, which is used to detect shared DataSeries during resampling + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.LastPointRange"> + <summary> + The last Indices of the X and Y input data at the time of most recent resampling. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.LastVisibleRange"> + <summary> + The last VisibleRange of the XAxis at the time of most recent resampling. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.LastViewportWidth"> + <summary> + The last width of the Viewport at the time of most recent resampling. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.LastFifoSize"> + <summary> + The last size of FIFO buffer of the XAxis at the time of most recent resampling. + Zero value means the buffer is not FIFO. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.LastFifoStartIndex"> + <summary> + The last Start Index of FIFO buffer of the XAxis at the time of most recent resampling. + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.ResamplingPrecision"> + <summary> + The resampling precisions factor which allows to increase amount of points in resampled point series + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.ResamplingMode"> + <summary> + The user requested resampling mode + </summary> + </member> + <member name="P:SciChart.Data.Numerics.PointResamplers.ResamplingParams.EnableExperimentalResampling"> + <summary> + Enables experimental ridiculous performance resampling + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.ResamplingParams.Equals(System.Object)"> + <summary>Determines whether the specified <see cref="T:System.Object" /> is equal to the current <see cref="T:System.Object" />.</summary> + <returns>true if the specified object is equal to the current object; otherwise, false.</returns> + <param name="obj">The object to compare with the current object. </param> + <filterpriority>2</filterpriority> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.ResamplingParams.GetHashCode"> + <summary>Serves as a hash function for a particular type. </summary> + <returns>A hash code for the current <see cref="T:System.Object" />.</returns> + <filterpriority>2</filterpriority> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.IPointResampler`2"> + <summary> + Provides the interface to a PointResampler - an algorithm which is able to reduce the number of data-points in a series for rendering fast, while maintaining visual accuracy of the series + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.IPointResampler`2.Execute(System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Model.IPointSeries)"> + <summary> + Transforms the input X and Y series into an <see cref="T:SciChart.Data.Model.IPointSeries" />, a resampled, reduced dataset for rendering on screen + </summary> + <param name="xColumn">The input X-Value series</param> + <param name="yColumn">The input Y-Value series</param> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode</param> + <param name="pointSeries">The <see cref="T:SciChart.Data.Model.IPointSeries" /> to update</param> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.IPointResampler`2.Execute(System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`1},SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Model.IXyyPointSeries)"> + <summary> + Transforms the input X and Y series into an <see cref="T:SciChart.Data.Model.IPointSeries" />, a resampled, reduced dataset for rendering on screen + </summary> + <param name="xColumn">The input X-Value series</param> + <param name="yColumn">The input Y-Value series</param> + <param name="yColumn1">The input Y1-Value series</param> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode Y-Value series</param> + <param name="resamplingMode1">The resampling mode Y1-Value series</param> + <param name="pointSeries">The <see cref="T:SciChart.Data.Model.IPointSeries" /> to update</param> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.PointResamplerBase"> + <summary> + The <see cref="T:SciChart.Data.Numerics.PointResamplers.PointResamplerBase" /> provides base methods for resampling. + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.PointResamplerBase.ConvertToUncheckedList``1(System.Collections.Generic.IList{``0})"> + <summary> + Converts the <see cref="T:System.Collections.Generic.IList`1" /> instance to the <see cref="T:SciChart.Data.Model.UncheckedList`1" /></summary> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.PointResamplerBase`2"> + <summary> + The <see cref="T:SciChart.Data.Numerics.PointResamplers.PointResamplerBase`2" /> provides base methods for resampling. + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.PointResamplerBase`2.Execute(System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Model.IPointSeries)"> + <summary> + Transforms the input X and Y series into an <see cref="T:SciChart.Data.Model.IPointSeries" />, a resampled, reduced dataset for rendering on screen + </summary> + <param name="xColumn">The input X-Value series</param> + <param name="yColumn">The input Y-Value series</param> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode</param> + <param name="pointSeries">The <see cref="T:SciChart.Data.Model.IPointSeries" /> instance to update</param> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.PointResamplerBase`2.Execute(System.Collections.Generic.IList{`0},System.Collections.Generic.IList{`1},System.Collections.Generic.IList{`1},SciChart.Data.Numerics.PointResamplers.ResamplingParams,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Numerics.ResamplingMode,SciChart.Data.Model.IXyyPointSeries)"> + <summary> + Transforms the input X and Y series into an <see cref="T:SciChart.Data.Model.IPointSeries" />, a resampled, reduced dataset for rendering on screen + </summary> + <param name="xColumn">The input X-Value series</param> + <param name="yColumn">The input Y-Value series</param> + <param name="yColumn1">The input Y1-Value series</param> + <param name="resamplingParams">The resampling parameters</param> + <param name="resamplingMode">The resampling mode Y-Value series</param> + <param name="resamplingMode1">The resampling mode Y1-Value series</param> + <param name="pointSeries">The <see cref="T:SciChart.Data.Model.IPointSeries" /> to update</param> + </member> + <member name="T:SciChart.Data.Numerics.PointResamplers.PointResamplerFactory"> + <summary> + Instantiates <see cref="!:IPointResampler" /> instances. + </summary> + </member> + <member name="M:SciChart.Data.Numerics.PointResamplers.PointResamplerFactory.GetPointResampler``2"> + <summary> + Instantiates a <see cref="!:IPointResampler" /> instance for the combination of <typeparamref name="TX" /> and <typeparamref name="TY" />. + </summary> + </member> + <member name="T:SciChart.Data.Numerics.ResamplingMode"> + <summary> + Defines the ResamplingMode used by a RenderableSeries + </summary> + <remarks></remarks> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.None"> + <summary> + Do not use resampling when redrawing a series + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.MinMax"> + <summary> + Assumes Evenly-spaced data (TimeSeries). Resample by taking the min-max of oversampled data. This results in the most visually accurate resampling, with the most performant rendering + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.Mid"> + <summary> + Assumes Evenly-spaced data (TimeSeries). Resample by taking the median point of oversampled data + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.Max"> + <summary> + Assumes Evenly-spaced data (TimeSeries). Resample by taking the maximum point of oversampled data + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.Min"> + <summary> + Assumes Evenly-spaced data (TimeSeries). Resample by taking the minimum point of oversampled data + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.MinMaxWithUnevenSpacing"> + <summary> + Does not assume Evenly-spaced data (TimeSeries). Resample by taking the min-max of oversampled data. This results in the most visually accurate resampling, with the most performant rendering + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.Auto"> + <summary> + Auto-detect the most suitable resampling algorithm (Fastest, plus most accurate) for the type of data appended + </summary> + </member> + <member name="F:SciChart.Data.Numerics.ResamplingMode.MinOrMax"> + <summary> + EXPERIMENTAL! Assumes Evenly-spaced data (TimeSeries). Resample by taking the Min, or the Max point of oversampled data. Outputs Min and Max when points in the resampling bucket span zero + </summary> + </member> + <member name="P:SciChart.Charting2D.Interop.FinalizerExtensions.DebugFinalizerMethods"> + <summary> + When true, finalizer methods are sent to Debug.WriteLine, to help debug objects that are not being disposed. + </summary> + </member> + <member name="T:SciChart.Charting2D.Interop.Vectori.VectoriEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.Vectorui.VectoruiEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.Vectorul.VectorulEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.Vectord.VectordEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.Vectorf.VectorfEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.Vectorstr.VectorstrEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.Vectorwstr.VectorwstrEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.VectorTsrv4.VectorTsrv4Enumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.VectorCTVertex.VectorCTVertexEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.VectorCVertex.VectorCVertexEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting2D.Interop.VectorSpriteVertex.VectorSpriteVertexEnumerator"> + Note that the IEnumerator documentation requires an InvalidOperationException to be thrown + whenever the collection is modified. This has been done for changes in the size of the + collection but not when one of the elements of the collection is modified as it is a bit + tricky to detect unmanaged code that modifies the collection under our feet. + </member> + <member name="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1"> + <summary> + Using pre-computed constants, types which implement ICoordinateCalculator can convert from pixel coordinate to data value and back + </summary> + <typeparam name="T">The type of the underlying data to convert</typeparam> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsDiscontinuousAxisCalculator"> + <summary> + Gets a value indicating whether this is a discontinuous axis coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsCategoryAxisCalculator"> + <summary> + Gets a value indicating whether this is a category axis coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsLogarithmicAxisCalculator"> + <summary> + Gets a value indicating whether this is a logarithmic axis coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsTernaryAxisCalculator"> + <summary> + Gets a value indicating whether this is a ternary axis coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsPolarAxisCalculator"> + <summary> + Gets a value indicating whether this is a polar axis coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsHorizontalAxisCalculator"> + <summary> + Gets a value indicating whether this is a horizontal axis coordinate calculator. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.IsXAxisCalculator"> + <summary> + Gets a value indicating whether this is coordinate calculator belongs by X axis. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.HasFlippedCoordinates"> + <summary> + Gets a value indicating whether coordinates are flipped. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.CoordinatesOffset"> + <summary> + Gets an axis offset. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.CanSupportNativeCoordinateCalculation"> + <summary> + Gets a value indicating whether this instance can support native coordinate calculation. + </summary> + </member> + <member name="P:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.ViewportOffset"> + <summary> + Gets the viewport offset used when calculating pixels. + + E.g. for a bitmap, this is set to -1, since a 200 pixel wide bitmap will have coordinates ranging from 0 to 199. + + For an open space, e.g. a 3D world, this is set to 0, since a 200 'world unit' wide area requires coordinates ranging from 0 to 200 + </summary> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.GetCoordinate(System.DateTime)"> + <summary> + Transforms the DateTime data value into a pixel coordinate + </summary> + <param name="dataValue">The DateTime data value</param> + <returns>The pixel coordinate</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.GetCoordinate(`0)"> + <summary> + Transforms a data value into a pixel coordinate + </summary> + <param name="dataValue">The data value</param> + <returns>The pixel coordinate</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.GetCoordinates(`0[],System.Double[],System.Double)"> + <summary> + Transforms a data values into a pixel coordinates + </summary> + <param name="dataValues">The data values</param> + <param name="coordinates">The pixel coordinates. Assumes this array is created and length equals the DataValues</param> + <param name="offset">An offset to apply to each coordinate</param> + <returns>The pixel coordinates</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.GetCoordinates(`0[],System.Double[],System.Int32,System.Double)"> + <summary> + Transforms a data values into a pixel coordinates + </summary> + <param name="dataValues">The data values</param> + <param name="coordinates">The pixel coordinates. Assumes this array is created and length equals the DataValues</param> + <param name="count">The amount of values to transform</param> + <param name="offset">An offset to apply to each coordinate</param> + <returns>The pixel coordinates</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.GetDataValue(System.Double)"> + <summary> + Transforms a pixel coordinate into a data value + </summary> + <param name="pixelCoordinate">The pixel coordinate</param> + <returns>The data value</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.TranslateBy(System.Double,SciChart.Data.Model.DoubleRange)"> + <summary> + Translates the min and max of the input range by the specified data value. Specific implementations of <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> such as + <see cref="!:DoubleLinearCoordinateCalculator" />, <see cref="!:LogarithmicDoubleCoordinateCalculator" /> and <see cref="!:CategoryCoordinateCalculator" /> will treat this differently + </summary> + <param name="pixels">The number of pixels to translate by. InputRange min and max will be translated by this positive or negative amount</param> + <param name="inputRange">The input <see cref="T:SciChart.Data.Model.DoubleRange" /> to translate</param> + <returns>A new instance of <see cref="!:CategoryCoordinateCalculator" /> with the translation applied</returns> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.TranslateBy(System.Double,System.Double,SciChart.Data.Model.IRange)"> + <summary> + Translates the min and max of the input range, multiplies them by the specified <paramref name="minFraction" />, <paramref name="maxFraction" />. Specific implementations of <see cref="T:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1" /> such as + <see cref="!:DoubleLinearCoordinateCalculator" />, <see cref="!:LogarithmicDoubleCoordinateCalculator" /> and <see cref="!:CategoryCoordinateCalculator" /> will treat this differently + </summary> + <param name="inputRange">The input <see cref="T:SciChart.Data.Model.IRange" /> to translate</param> + <param name="minFraction">The multiplier of range start</param> + <param name="maxFraction">The multiplier of range end</param> + </member> + <member name="M:SciChart.Charting.Numerics.CoordinateCalculators.ICoordinateCalculator`1.ToNativeCalculator(SciChart.Charting2D.Interop.eAxisType,System.Type)"> + <summary> + Returns the native counterpart of this instance, if supported; otherwise null. + </summary> + <returns>When method returns, holds the native counterpart if supported; otherwise null.</returns> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.DirectX.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.DirectX.dll Binary files differnew file mode 100644 index 000000000..c4a065bfa --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.DirectX.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.DirectX.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.DirectX.xml new file mode 100644 index 000000000..e5a63b8fd --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.DirectX.xml @@ -0,0 +1,274 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Drawing.DirectX</name> + </assembly> + <members> + <member name="T:SciChart.Drawing.DirectX.Common.Disposer"> + <summary> + Disposes a class if not disposed + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Common.Disposer.RemoveAndDispose``1(``0)"> + <summary> + Dispose an object instance and set the reference to null + </summary> + <typeparam name="T">The type of object to dispose</typeparam> + <param name="disposer">A reference to the instance for disposal</param> + <remarks>This method hides any thrown exceptions that might occur during disposal of the object (by design)</remarks> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11CompatibilityHelper"> + <summary> + A helper class which can be used to detect if the Direct3D10 enhancements to SciChart can run on the current hardware & operating system + </summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11CompatibilityHelper.IsSupportedOperatingSystem"> + <summary> + Supported operating systems include Windows Vista, Windows 7, Windows 8, 8.1 and up. Windows XP, 2000, 2003 are not supported. + </summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11CompatibilityHelper.HasDirectX10CapableGpu"> + <summary> + Determines if the current GPU supports DirectX10 or later + </summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11CompatibilityHelper.SupportsDirectX10"> + <summary> + Determines if the current hardware & software configuration fully supports DirectX10 or later + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11ObsoleteWarning"> + <summary> + Displays an obsolete warning in all Direct3D11RenderSurface types + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface"> + <summary> + Provides a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> implementation that uses a DirectX 10 High Quality and High Speed raster, capable of rendering with sub-pixel accuracy. + This requires DirectX10 hardware or later to run. Newer GPUs will have superior performance. If performance issues occur, please use the <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /></summary> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="E:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.InitializationFailed"> + <summary> + This event handler will fire if the direct x initialization fails. + </summary> + </member> + <member name="E:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.RenderingFailed"> + <summary> + Event handler to be used when rendering fails. + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface" /> class. + </summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.UseAlternativeFillSource"> + <summary> + When false (default), uses <see cref="T:System.Windows.Interop.D3DImage" /> for hardware accelerated texture sharing. + When true, uses software method to FillSource (avoiding use of D3DImage). This can help compatibility on certain systems + </summary> + <example> + To enable compatibility mode for SciChart3DSurface, set this property once, statically, in your application + <code> + void Foo() + { + Direct3D11RenderSurface.UseAlternativeFillSource = true; + } + </code></example> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.GraphicsAdapterIndex"> + <summary> + Sets the Graphics Adapter Index to use for the <see cref="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface" />. Defaults to 0. Use values other than 0 only in multi GPU computers + </summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.EnableForceWaitForGPU"> + <summary> + When false (default), no waiting for gpu + when true , we force wait for the gpu to finish rendering before invalidating the final image or copying it + </summary> + <example> + To enable compatibility mode for SciChart3DSurface, set this property once, statically, in your application + <code> + void Foo() + { + Direct3D11RenderSurface.EnableForceWaitForGPU = true; + } + </code></example> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.SupportsDirectX10"> + <summary> + Gets a value indicating whether your current hardware supports DirectX10. THIS CALL IS DEFERRED TO Direct3D10CompatibilityHelper.SupportsDirectX10. Please check the property values and Intellisense documentation for Direct3D10CompatibilityHelper to see the reason why this failed + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.SciChart#Drawing#DirectX#Rendering#IDirectXRenderSurface#GetRenderContext"> + <summary> + Creates an <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance to perform drawing operations. Note this is only valid for the current render pass + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.GetRenderContext"> + <summary> + When overridden in a derived class, returns a RenderContext valid for the current render pass + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.SciChart#Drawing#DirectX#Rendering#IDirectXRenderSurface#ResetD3D11With(System.Boolean)"> + <summary> + Resets the D3D Engine with the flag which determines whether we use the alternative software path for mixing DirectX content with WPF. + This flag (when true) improves compatibility on some older graphics hardware, at the expense of performance. + </summary> + <param name="useAlternativeFillSource">This flag (when true) improves compatibility on some older graphics hardware, at the expense of performance</param> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.InitEngineAsync"> + <summary> + Initializes the Direct3D11RenderSurface D3D Engine Asynchronously. The task returns True when the operation has completed, or faulted if an exception occurs + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.RecreateSurface"> + <summary> + this is called when window is created or resized + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.AssertSupportsDirectX"> + <summary> + Asserts the current hardware/software configuration supports DirectX. + + Will throw a PlatformNotSupportedException if InitializationFailed is not handled, otherwise, raises the InitializationFailed event + </summary> + <exception cref="T:System.PlatformNotSupportedException"></exception> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.OnRenderSurfaceBaseLoaded(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is loaded into the visual tree + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.RoutedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface.DisposeUnmanagedResources"> + <summary> + Derived classes may override this method to be notified when to dispose of unmanaged resources. Called when the + <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is disposed + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper"> + <summary> + <para>A helper class to enable the Direct3D11RenderSurface </para> + <para>Usage: >SciChartSurface DirectXHelper.TryApplyDirectXRenderer="True"/<</para> + </summary> + </member> + <member name="F:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper.TryApplyDirectXRendererProperty"> + <summary>Defines the TryApplyDirectXRenderer attached property</summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper.SetTryApplyDirectXRenderer(SciChart.Charting.Visuals.SciChartSurface,System.Boolean)"> + <summary> + Sets the TryApplyDirectXRenderer attached property. When true, tries to apply DirectX rendering to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" /></summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> tries to apply DirectX rendering to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />.</param> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper.GetTryApplyDirectXRenderer(SciChart.Charting.Visuals.SciChartSurface)"> + <summary> + Sets the TryApplyDirectXRenderer attached property value + </summary> + </member> + <member name="F:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper.FallbackTypeProperty"> + <summary>Defines the FallbackType attached property</summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper.SetFallbackType(System.Windows.DependencyObject,System.Type)"> + <summary> + Sets the FallbackType attached property. This is the type of <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> which is created if DirectX is not available + </summary> + <param name="element">The element.</param> + <param name="value">if set to <c>true</c> tries to apply DirectX rendering to the <see cref="T:SciChart.Charting.Visuals.SciChartSurface" />.</param> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.DirectXHelper.GetFallbackType(System.Windows.DependencyObject)"> + <summary> + Sets the FallbackType attached property value + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.DXErrorEventArgs"> + <summary> + Event args used by the <see cref="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface" /></summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.DXErrorEventArgs.Exception"> + <summary> + Gets or sets the exception. + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.IDirectXRenderContext"> + <summary> + Defines the interface to a 3D RenderContext + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.IDirectXRenderContext.BeginScene"> + <summary> + BeginScene, must be called at the start of every frame + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.IDirectXRenderContext.EndScene"> + <summary> + EndScene, called at the end of every frame + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.IDirectXRenderContext.RenderColorTriangles(System.Collections.Generic.List{System.Windows.Point},System.Collections.Generic.List{System.Double},System.Collections.Generic.List{System.UInt32})"> + <summary> + Render a series of triangles that enclose points by heights sent, and filled with the colors sent + </summary> + <param name="points"></param> base 2 points fron eight heights will be extended + <param name="heights"></param> height used to extente length perpendicular on the point, creating quads ( 2 trangles for each 2 points ) + <param name="colors"></param> color used to fill the quads + </member> + <member name="M:SciChart.Drawing.DirectX.Context.D3D11.IDirectXRenderContext.RenderGammaSeriesFilledTriangles(System.Collections.Generic.List{System.Windows.Point},System.Collections.Generic.List{System.Windows.Point},System.Collections.Generic.List{System.UInt32})"> + <summary> + Render gamma series, with calculated point on the other side of the gamma curve + </summary> + <param name="points"></param> + <param name="gammaPoints"></param> + <param name="colors"></param> + </member> + <member name="T:SciChart.Drawing.DirectX.Context.D3D11.RdpDetectionTimer"> + <summary> + Provides a helper class that can be used to detect if Remote Desktop sessions is in use on the current PC + </summary> + </member> + <member name="P:SciChart.Drawing.DirectX.Context.D3D11.RdpDetectionTimer.IsRemoteDesktop"> + <summary> + Determines if the code is being run under Remote Desktop + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Engine2D.Effects.ShaderManager"> + <summary> + compiles Direct3D shaders from FX files in assembly resources + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Properties.Resources"> + <summary> + A strongly-typed resource class, for looking up localized strings, etc. + </summary> + </member> + <member name="T:SciChart.Drawing.DirectX.Rendering.IDirectXRenderSurface"> + <summary> + Defines the interface to a <see cref="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface" />: a DirectX10/11 implementation of <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> that uses high-quality, sub-pixel, hardware accelerated drawing algorithms. + </summary> + <seealso cref="T:SciChart.Drawing.DirectX.Context.D3D11.Direct3D11RenderSurface" /> + <seealso cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Drawing.DirectX.Rendering.IDirectXRenderSurface.GetRenderContext"> + <summary> + Creates an <see cref="T:SciChart.Drawing.DirectX.Context.D3D11.IDirectXRenderContext" /> instance to perform drawing operations. Note this is only valid for the current render pass + </summary> + </member> + <member name="M:SciChart.Drawing.DirectX.Rendering.IDirectXRenderSurface.ResetD3D11With(System.Boolean)"> + <summary> + Resets the D3D Engine with the flag <param name="useAlternativeFillSource"> which determines whether we use the alternative software path for mixing DirectX content with WPF. + This flag (when true) improves compatibility on some older graphics hardware, at the expense of performance</param></summary> + <param name="useAlternativeFillSource">This flag (when true) improves compatibility on some older graphics hardware, at the expense of performance</param> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.dll Binary files differnew file mode 100644 index 000000000..3a26f97d0 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.xml new file mode 100644 index 000000000..e83fdad84 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Drawing.xml @@ -0,0 +1,3370 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Drawing</name> + </assembly> + <members> + <member name="T:SciChart.Drawing.Common.DrawEventArgs"> + <summary> + EventArgs raised when the <see cref="E:SciChart.Drawing.Common.IRenderSurface.Draw" /> event is raised, which occurs at the start of the render pass + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + </member> + <member name="M:SciChart.Drawing.Common.DrawEventArgs.#ctor(SciChart.Drawing.Common.IRenderSurface2D)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.Common.DrawEventArgs" /> class. + </summary> + <param name="renderSurface">The render surface.</param> + </member> + <member name="P:SciChart.Drawing.Common.DrawEventArgs.RenderSurface2D"> + <summary> + Gets the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> instance which raised the Draw event + </summary> + </member> + <member name="T:SciChart.Drawing.Common.FontCacheKey"> + <summary> + identifies cached rendered character + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IBrush2D"> + <summary> + Defines the interface to a 2D Brush used to paint fills on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="P:SciChart.Drawing.Common.IBrush2D.AlphaBlend"> + <summary> + Gets whether fills painted with this brush should be alpha blended or not + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IExtremeRenderContext2D"> + <summary> + Defines the interface to a Extreme 2D RenderContext + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IExtremeRenderContext2D.ViewportSize"> + <summary> + Gets the current size of the viewport. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.IExtremeRenderContext2D.DrawColoredSprites(SciChart.Drawing.Common.ISprite2D,SciChart.Data.ColoredVertex[],System.Int32,System.Int32)"> + <summary> + Blits the sprite onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> with colors provided by vertices + </summary> + <param name="sprite">The sprite to draw</param> + <param name="vertices">The vertices to draw sprite at</param> + <param name="startIndex">The start index in vertices array</param> + <param name="count">The amount of vertices to draw</param> + </member> + <member name="M:SciChart.Drawing.Common.IExtremeRenderContext2D.DrawLineStrip(SciChart.Drawing.Common.IPen2D,SciChart.Data.ColoredVertex[],System.Int32,System.Int32)"> + <summary> + Draws colored line strip with colors provided by vertice + </summary> + <param name="pen">The pen to draw line strip with</param> + <param name="vertices">The vertices to draw line strip</param> + <param name="startIndex">The start index in vertices array</param> + <param name="count">The amount of vertices to draw</param> + </member> + <member name="T:SciChart.Drawing.Common.IPathColor"> + <summary> + A base interface for <see cref="T:SciChart.Drawing.Common.IPen2D" /> and <see cref="T:SciChart.Drawing.Common.IBrush2D" />. Used by the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to draw fills and lines + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IPathColor.Color"> + <summary> + Gets the color of the pen. Supports transparency + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IPathColor.ColorCode"> + <summary> + Used internally by the renderer, gets the integer color-code that represents the Pen color + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IPathColor.IsTransparent"> + <summary> + Gets a value indicating whether this pen is transparent. + </summary> + <value> + <c>true</c> if this instance is transparent; otherwise, <c>false</c>. + </value> + </member> + <member name="T:SciChart.Drawing.Common.IPathContextFactory"> + <summary> + <para>Creates <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> instances, e.g. to draw lines, points, polygon outlines depending on the final implementation. </para> + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> + </member> + <member name="M:SciChart.Drawing.Common.IPathContextFactory.Begin(SciChart.Drawing.Common.IPathColor,System.Double,System.Double)"> + <summary> + Begins drawing at the specified X,Y pixel coordinate, with the specified color. + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IPointMarkerPathContextFactory"> + <summary> + <para>Creates <see cref="T:SciChart.Drawing.Common.IPointMarkerPathDrawingContext" /> instances, e.g. to draw points (ellipses, squares, triangles). </para> + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> + <seealso cref="T:SciChart.Drawing.Common.IPointMarkerPathDrawingContext" /> + </member> + <member name="M:SciChart.Drawing.Common.IPointMarkerPathContextFactory.Begin(SciChart.Drawing.Common.IPathColor,System.Double,System.Double,System.Int32)"> + <summary> + Begins drawing at the specified X,Y pixel coordinate, with the specified color. + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IPathDrawingContext"> + <summary> + Returns an <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to draw a polyline, or collection of PointMarkers + </summary> + <example> + The following example shows how to create a PathDrawingContext, move it and dispose to complete the path + <code> + var lineContext = renderContext.BeginLine(pen, 0, 0); + lineContext.LineTo(1, 2); + lineContext.LineTo(3, 4); + lineContext.Dispose(); + </code></example> + </member> + <member name="M:SciChart.Drawing.Common.IPathDrawingContext.Begin(SciChart.Drawing.Common.IPathColor,System.Double,System.Double)"> + <summary> + Starts the context at the specified X,Y coordinate with a specified Pen + </summary> + <param name="color">The pen or brush for the drawing operation</param> + <param name="x">The x-coordinate in pixels</param> + <param name="y">The y-coordinate in pixels</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> instance, to allow fluent API</returns> + </member> + <member name="M:SciChart.Drawing.Common.IPathDrawingContext.MoveTo(System.Double,System.Double)"> + <summary> + Moves the Context to the specified X,Y coordinate. + </summary> + <param name="x">The x-coordinate in pixels</param> + <param name="y">The y-coordinate in pixels</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> instance, to allow fluent API</returns> + </member> + <member name="M:SciChart.Drawing.Common.IPathDrawingContext.End"> + <summary> + Ends the segment, flushing to render target + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IPointMarkerPathDrawingContext"> + <summary> + Returns an <see cref="T:SciChart.Drawing.Common.IPointMarkerPathDrawingContext" /> to draw a polyline, or collection of PointMarkers + </summary> + <example> + <code> + var lineContext = renderContext.BeginPoints(pen, 0, 0, 0); + lineContext.LineTo(1, 2, 1); + lineContext.LineTo(3, 4, 2); + lineContext.Dispose(); + </code> + </example> + </member> + <member name="M:SciChart.Drawing.Common.IPointMarkerPathDrawingContext.Begin(SciChart.Drawing.Common.IPathColor,System.Double,System.Double,System.Int32)"> + <summary> + Starts the context at the specified X,Y coordinate with a specified Pen + </summary> + <param name="color">The pen or brush for the drawing operation</param> + <param name="x">The x-coordinate in pixels</param> + <param name="y">The y-coordinate in pixels</param> + <param name="index">The index to the data.</param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> instance, to allow fluent API + </returns> + </member> + <member name="M:SciChart.Drawing.Common.IPointMarkerPathDrawingContext.MoveTo(System.Double,System.Double,System.Int32)"> + <summary> + Moves the Context to the specified X,Y coordinate. + </summary> + <param name="x">The x-coordinate in pixels</param> + <param name="y">The y-coordinate in pixels</param> + <param name="index">The index to the data.</param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> instance, to allow fluent API + </returns> + </member> + <member name="M:SciChart.Drawing.Common.IPointMarkerPathDrawingContext.End"> + <summary> + Ends the segment, flushing to render target + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IPen2D"> + <summary> + Defines the interface to a 2D pen, used to draw lines on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="P:SciChart.Drawing.Common.IPen2D.StrokeThickness"> + <summary> + Gets the stroke thickness + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IPen2D.Antialiased"> + <summary> + Gets if antialiasing should be used + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IPen2D.StrokeEndLineCap"> + <summary> + Gets a value that describes a shape at the end of line + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IDashSplittingContext"> + <summary> + Defines interface to context of splitting line into dashes + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IDashSplittingContext.HasDashes"> + <summary> + When true, this instance has dashes + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IDashSplittingContext.StrokeDashArray"> + <summary> + Optional array with lengths of dash pattern items + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IDashSplittingContext.StrokeDashArrayIndex"> + <summary> + Current index in StrokeDashArray + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IDashSplittingContext.StrokeDashArrayItemPassedLength"> + <summary> + Already passed length of current item in StrokeDashArray + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IRenderContext2D"> + <summary> + Defines the interface to a 2D RenderContext, allowing drawing, blitting and creation of pens and brushes on the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + <remarks>The <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> is a graphics context valid for the current render pass. in which an <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> is passed in. Use this to draw penned lines, fills, rectangles, ellipses and blit graphics to the screen.</remarks> + </member> + <member name="P:SciChart.Drawing.Common.IRenderContext2D.Layers"> + <summary> + Gets a collection of <see cref="T:SciChart.Drawing.Common.RenderOperationLayers" />, which allow rendering operations to be posted to a layered queue for later + execution in order (and correct Z-ordering). + </summary> + <example> + <code title="RenderOperationLayers Example" description="Demonstrates how to enqueue operations to the RenderOperationLayers collection and later flush to ensure rendering operations get processed in the correct Z-order" lang="C#"> + RenderOperationLayers layers = renderContext.Layers; + + // Enqueue some operations in the layers in any order + layers[RenderLayer.AxisMajorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + layers[RenderLayer.AxisBands].Enqueue(() => renderContext.DrawRectangle(/* .. */)); + layers[RenderLayer.AxisMinorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + + // Processes all layers by executing enqueued operations in order of adding, + // and in Z-order of layers + layers.Flush();</code> + </example> + </member> + <member name="P:SciChart.Drawing.Common.IRenderContext2D.ViewportSize"> + <summary> + Gets the current size of the viewport. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.SetPrimitivesCachingEnabled(System.Boolean)"> + <summary> + enables/disables primitves chaching optimization ( Direct3D renderer only ) + </summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.CreateBrush(System.Windows.Media.Color,System.Double,System.Nullable{System.Boolean})"> + <summary> + Creates a <see cref="T:SciChart.Drawing.Common.IBrush2D" /> valid for the current render pass. Use this to draw rectangles, polygons and shaded areas + </summary> + <param name="color">The color of the brush, supports transparency</param> + <param name="opacity">The opacity of the brush</param> + <param name="alphaBlend">If true, use alphablending when shading. If null, auto-detect</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IBrush2D" /> instance</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.CreateBrush(System.Windows.Media.Brush,System.Double,SciChart.Drawing.Common.TextureMappingMode)"> + <summary> + Creates a <see cref="T:SciChart.Drawing.Common.IBrush2D" /> from WPF Brush valid for the current render pass. Use this to draw rectangles, polygons and shaded areas + </summary> + <param name="brush">The WPF Brush to use as a source, e.g. this can be a <seealso cref="T:System.Windows.Media.SolidColorBrush" />, or it can be a <seealso cref="T:System.Windows.Media.LinearGradientBrush" />. Note that solid colors support transparency and are faster than gradient brushes</param> + <param name="opacity">The opacity of the brush</param> + <param name="textureMappingMode">Defines a <see cref="T:SciChart.Drawing.Common.TextureMappingMode" />, e.g. brushes share a texture per viewport or a new texture per primitive drawn</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IBrush2D" /> instance</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.CreatePen(System.Windows.Media.Color,System.Boolean,System.Single,System.Double,System.Double[],System.Windows.Media.PenLineCap)"> + <summary> + Creates a <see cref="T:SciChart.Drawing.Common.IPen2D" /> valid for the current render pass. Use this to draw outlines, quads and lines + </summary> + <param name="color">The color of the pen, supports transparency</param> + <param name="antiAliasing">If true, use antialiasing</param> + <param name="strokeThickness">The strokethickness, default=1.0</param> + <param name="opacity">The opecity of the pen</param> + <param name="strokeDashArray"></param> + <param name="strokeEndLineCap"></param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPen2D" /> instance</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.CreateSprite(System.Windows.FrameworkElement)"> + <summary> + Creates a Sprite from FrameworkElement by rendering to bitmap. This may be used in the <see cref="M:SciChart.Drawing.Common.IRenderContext2D.DrawSprite(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Windows.Point)" /> method + to draw to the screen repeatedly + </summary> + <param name="fe">The FrameworkElement to render</param> + <returns>The sprite which may be drawn in SciChart</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.CreateSprite(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Creates a Sprite from WriteableBitmap. This may be used in the <see cref="M:SciChart.Drawing.Common.IRenderContext2D.DrawSprite(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Windows.Point)" /> method + to draw to the screen repeatedly + </summary> + <param name="spriteContent">The WriteableBitmap containing the sprite content</param> + <returns>The sprite which may be drawn in SciChart</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.Clear"> + <summary> + Clears the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawSprite(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Windows.Point)"> + <summary> + Blits the source image onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="srcSprite">The source sprite to render</param> + <param name="srcRect">The source rectangle</param> + <param name="destPoint">The destination point, which will be the top-left coordinate of the sprite after blitting</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawSprites(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Batch draw of the source sprite onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="sprite2D">The sprite to render</param> + <param name="srcRect">The source rectangle</param> + <param name="points">The points to draw sprites at</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawSprites(SciChart.Drawing.Common.ISprite2D,System.Collections.Generic.IEnumerable{System.Windows.Rect})"> + <summary> + Batch draw of the source sprite onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="sprite2D">The sprite to render</param> + <param name="dstRects">The destination rectangles to draw sprites at</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.FillRectangle(SciChart.Drawing.Common.IBrush2D,System.Windows.Point,System.Windows.Point,System.Double)"> + <summary> + Fills a rectangle on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="brush">The brush</param> + <param name="pt2">The top-left point of the rectangle</param> + <param name="pt1">The bottom-right point of the rectangle</param> + <param name="gradientRotationAngle">The angle which the brush is rotated by, default is zero</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.FillRectangle(System.Int32,System.Windows.Point,System.Windows.Point)"> + <summary> + Fills a rectangle on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="color">The brush</param> + <param name="pt2">The top-left point of the rectangle</param> + <param name="pt1">The bottom-right point of the rectangle</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.FillPolygon(SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Fills a polygon on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specifie <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="brush">The brush</param> + <param name="points">The list of points defining the closed polygon, where X,Y coordinates in clockwise direction</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.FillArea(SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Tuple{System.Windows.Point,System.Windows.Point}},System.Boolean,System.Double)"> + <summary> + Fills an area defined the the Points and Heights, e.g. as in a mountain chart, using the specifie <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="brush">The brush</param> + <param name="lines"></param> + <param name="isVerticalChart">Value, indicates whether chart is vertical</param> + <param name="gradientRotationAngle">The angle which the brush is rotated by</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawQuad(SciChart.Drawing.Common.IPen2D,System.Windows.Point,System.Windows.Point)"> + <summary> + Draws a Quad on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IPen2D" /></summary> + <param name="pen">The Pen</param> + <param name="pt1">Left-top point in the quad</param> + <param name="pt2">Bottom-right point in the quad</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawEllipse(SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,System.Windows.Point,System.Double,System.Double)"> + <summary> + Draws an Ellipse on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified outline <see cref="T:SciChart.Drawing.Common.IPen2D">Pen</see> and fill <see cref="T:SciChart.Drawing.Common.IBrush2D">Brush</see></summary> + <param name="strokePen">The stroke pen</param> + <param name="fillBrush">The fill brush</param> + <param name="center">The center of the ellipse in pixels</param> + <param name="width">The width of the ellipse in pixels</param> + <param name="height">The height of the ellipse in pixels</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawEllipses(SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Windows.Point},System.Double,System.Double)"> + <summary> + Draws 0..N Ellipses at the points passed in with the same width, height, pen and brush + </summary> + <param name="strokePen"></param> + <param name="fillBrush"></param> + <param name="centres">The points to draw ellipses at</param> + <param name="width">The common width for all ellipses</param> + <param name="height">The common height for all ellipses</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawLine(SciChart.Drawing.Common.IPen2D,System.Windows.Point,System.Windows.Point)"> + <summary> + Draws a single line on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IPen2D" />. + Note for a faster implementation in some rasterizers, use DrawLines passing in an IEnumerable + </summary> + <param name="pen">The pen</param> + <param name="pt1">The start of the line in pixels</param> + <param name="pt2">The end of the line in pixels</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawLines(SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Draws a multi-point line on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IPen2D" /></summary> + <param name="pen">The pen</param> + <param name="points">The points </param> + <returns>The last point in the polyline drawn</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DisposeResourceAfterDraw(System.IDisposable)"> + <summary> + Call this method, passing in <see cref="T:System.IDisposable" /> instance to dispose after the render pass completes. + Called internally by SciChart to lazy-dispose of Direct2D and Direct3D brushes and textures + </summary> + <param name="disposable"></param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawPixelsVertically(System.Int32,System.Int32,System.Int32,System.Int32,System.Collections.Generic.IList{System.Int32},System.Double,System.Boolean)"> + <summary> + Draws vertical scan line for heatmap + from bottom to top, from yStart to yEnd + </summary> + <param name="xLeft">Screen X coordinate where to draw pixels</param> + <param name="xRight">Screen X coordinate where to draw pixels</param> + <param name="yStartBottom">Screen Y coordinate of vertical scan line's bottom. + Can be located outdide of visible area, in this case not all pixels in list are rendered</param> + <param name="yEndTop">Screen Y coordinate of vertical scan line's top. + Can be located outdide of visible area, in this case not all pixels in list are rendered</param> + <param name="pixelColorsArgb">The list of pixel colors to draw</param> + <param name="opacity">The Opacity of the line from 0.0 to 1.0</param> + <param name="yAxisIsFlipped">if set to <c>true</c> then y axis is flipped.</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawText(System.Windows.Rect,System.Windows.Media.Color,System.Single,System.String,System.Windows.Media.FontFamily,System.Windows.FontWeight,System.Windows.FontStyle)"> + <summary> + Draws text if it does not go outside + </summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.BeginLine(SciChart.Drawing.Common.IPen2D,System.Double,System.Double)"> + <summary> + Begins a Polyline segment, returning the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" />. This is the fastest way to draw lines and simply a proxy to <see cref="M:SciChart.Drawing.Common.IRenderContext2D.DrawLines(SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Windows.Point})" /> method. + </summary> + <param name="pen">The pen for the line segment</param> + <param name="startX">The start X coordinate (pixel coord)</param> + <param name="startY">The start Y coordinate (pixel coord)</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to continue the line</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.BeginPolygon(SciChart.Drawing.Common.IBrush2D,System.Double,System.Double,System.Double)"> + <summary> + Begins a filled Polygon segment, returning the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" />. This is the fastest way to draw polygon and simply a proxy to <see cref="M:SciChart.Drawing.Common.IRenderContext2D.FillArea(SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Tuple{System.Windows.Point,System.Windows.Point}},System.Boolean,System.Double)" /> method. + </summary> + <param name="brush">The brush for the polygon fill</param> + <param name="startX">The start X coordinate (pixel coord)</param> + <param name="startY">The start Y coordinate (pixel coord)</param> + <param name="gradientRotationAngle">The angle which the <paramref name="brush"></paramref> is rotated by</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to continue the polygon</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.BeginSpriteBatch(SciChart.Drawing.Common.ISprite2D,System.Double,System.Double,System.Nullable{System.Double},System.Nullable{System.Double})"> + <summary> + Begins a Sprite Batch, returning the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" />. This is the fastest way to draw sprites and simply a proxy to <see cref="M:SciChart.Drawing.Common.RenderContextBase.DrawSprites(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Collections.Generic.IEnumerable{System.Windows.Point})" /> method. + </summary> + <param name="sprite">The sprite for the Sprite Batch</param> + <param name="centerX">The start X coordinate (pixel coord)</param> + <param name="centerY">The start Y coordinate (pixel coord)</param> + <param name="width">An optional width override for the sprite. Defaults to Sprite.Width</param> + <param name="height">An optional height override for the sprite. Defaults to Sprite.Height</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to continue the sprite batch</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.CreateTexture(System.Int32,System.Int32,SciChart.Drawing.Common.TextureFormats)"> + <summary> + Creates a Texture with the specified width, height and format. This texture may be modified, and drawn repeatedly using <see cref="!:DrawTexture(ITexture2D, Rect)" /></summary> + <param name="width">The width of the texture in pixels</param> + <param name="height">The height of the texture in pixels</param> + <param name="textureFormat">The texture format.</param> + <returns>A new Texture2D object, which must be disposed when no longer required</returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawTexture(SciChart.Drawing.Common.ITexture2D,System.Windows.Rect,SciChart.Drawing.Common.TextureFiltering)"> + <summary> + Draws the <see cref="T:SciChart.Drawing.Common.ITexture2D" /> to the specified viewport rect + </summary> + <param name="texture">The texture.</param> + <param name="viewportRect">The viewport rect.</param> + <param name="filtering">The sampling mode.</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawHeightTextureContours(SciChart.Drawing.Common.ITexture2D,SciChart.Drawing.Common.ITexture2D,System.Windows.Rect,System.Windows.Media.Color,System.Single,System.Single,System.Single,System.Single,System.Single)"> + <summary> + Draws contours for a height texture the texture. + </summary> + <param name="texture">The float texture.</param> + <param name="viewportRect">The viewport rect.</param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.AsExtremeRenderContext"> + <summary> + Gets <see cref="T:SciChart.Drawing.Common.IExtremeRenderContext2D" /> from this render context + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.IsCompatibleType``1(``0)"> + <summary> + Determines whether the primitive type T is compatible with this <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance + </summary> + <typeparam name="T"></typeparam> + <param name="obj">The object.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderContext2D.DrawPixelsVertically(System.Int32,System.Int32,System.Int32[],System.Collections.Generic.IList{System.Int32},System.Double,System.Boolean,System.Boolean)"> + <summary> + Draws vertical scan line for heatmap + from bottom to top, from yStart to yEnd + </summary> + <param name="xLeft">Screen X coordinate where to draw pixels</param> + <param name="xRight">Screen X coordinate where to draw pixels</param> + <param name="yCoordinates"> An array of yCoordinates on YAxis</param> + <param name="pixelColorsArgb">The list of pixel colors to draw</param> + <param name="opacity">The Opacity of the line from 0.0 to 1.0</param> + <param name="isUniform">if set to <c>true</c> then X values are to each other and the same is for Y values.</param> + <param name="yAxisIsFlipped">if set to <c>true</c> then y axis is flipped.</param> + </member> + <member name="T:SciChart.Drawing.Common.TextureMappingMode"> + <summary> + Defines enumeration constants to describe how textures are mapped. + If textures are mapped <see cref="F:SciChart.Drawing.Common.TextureMappingMode.PerScreen" />, then a single + large texture is shared for all elements that use this texture. Else, if <see cref="F:SciChart.Drawing.Common.TextureMappingMode.PerPrimitive" /> + then individual primitives have separate textures. + </summary> + </member> + <member name="F:SciChart.Drawing.Common.TextureMappingMode.PerScreen"> + <summary> + with this mode texture coordinates equal to screen coordinates + </summary> + </member> + <member name="F:SciChart.Drawing.Common.TextureMappingMode.PerPrimitive"> + <summary> + with this mode entire texture is fit into single primitive + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IRenderSurface"> + <summary> + Common interface for a RenderSurface, <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + </member> + <member name="E:SciChart.Drawing.Common.IRenderSurface.Draw"> + <summary> + Raised each time the render surface is to be drawn. Handle this event to paint to the surface + </summary> + </member> + <member name="E:SciChart.Drawing.Common.IRenderSurface.Rendered"> + <summary> + Raised immediately after a render operation has completed + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IRenderSurface.NeedsResizing"> + <summary> + Returns True if the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> size has changed and the viewport needs resizing + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IRenderSurface.IsSizeValidForDrawing"> + <summary> + Returns true if the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> size is valid for drawing + </summary> + </member> + <member name="P:SciChart.Drawing.Common.IRenderSurface.Style"> + <summary> + Gets or sets a <see cref="P:SciChart.Drawing.Common.IRenderSurface.Style" /> to apply to the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="P:SciChart.Drawing.Common.IRenderSurface.Services"> + <summary> + Gets or sets the <see cref="T:SciChart.Core.Utility.IServiceContainer" /> instance + </summary> + <value>The services.</value> + <remarks></remarks> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface.ClearSeries"> + <summary> + Clears all <see cref="T:System.Windows.FrameworkElement" /> Visual Children on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface.Clear"> + <summary> + Clears the viewport + </summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface.RecreateSurface"> + <summary> + Recreates the elements required by the Viewport, called once at startup and when the surface is resized + </summary> + </member> + <member name="T:SciChart.Drawing.Common.IRenderSurface2D"> + <summary> + Defines the interface to a RenderSurface, which is a viewport used to draw 2D graphics in a fast manner. + The renderer architecture is plugin based, meaning we have + build multiple implementations of <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" />. + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> + <seealso cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + </member> + <member name="P:SciChart.Drawing.Common.IRenderSurface2D.ChildSeries"> + <summary> + Gets the ChildSeries in this <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> instance. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface2D.GetRenderContext"> + <summary> + Creates an <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> instance to perform drawing operations. Note this is only valid for the current render pass + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface2D.ContainsSeries(System.Windows.FrameworkElement)"> + <summary> + Returns True if the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> contains the <see cref="T:System.Windows.FrameworkElement" /> instance + </summary> + <param name="renderableSeries">the RenderableSeries instance as <see cref="T:System.Windows.FrameworkElement" /></param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface2D.AddSeries(System.Windows.FrameworkElement)"> + <summary> + Adds the <see cref="T:System.Windows.FrameworkElement" /> instance as a visual child to the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="renderableSeries"></param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface2D.AddSeries(System.Collections.Generic.IEnumerable{System.Windows.FrameworkElement})"> + <summary> + Adds the <see cref="T:System.Windows.FrameworkElement" /> instances as visual children to the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="renderableSeries"></param> + </member> + <member name="M:SciChart.Drawing.Common.IRenderSurface2D.RemoveSeries(System.Windows.FrameworkElement)"> + <summary> + Removes the <see cref="T:System.Windows.FrameworkElement" /> from the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="renderableSeries"></param> + </member> + <member name="T:SciChart.Drawing.Common.ISprite2D"> + <summary> + Defines the interface to a 2D Sprite, a small fixed-size bitmap which is rendered repeatedly to the viewport + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + <seealso cref="T:SciChart.Drawing.Common.RenderContextBase" /> + </member> + <member name="P:SciChart.Drawing.Common.ISprite2D.Width"> + <summary> + Gets the width of the Spite in pixels + </summary> + </member> + <member name="P:SciChart.Drawing.Common.ISprite2D.Height"> + <summary> + Gets the height of the Sprite in pixels + </summary> + </member> + <member name="T:SciChart.Drawing.Common.TextureFormats"> + <summary> + Defines TextureFormats for <see cref="T:SciChart.Drawing.Common.ITexture2D" /> derived types + </summary> + </member> + <member name="F:SciChart.Drawing.Common.TextureFormats.Bgra8"> + <summary> + Texture pixel format is Blue Green Red Alpha (8 bit per channel) + </summary> + </member> + <member name="T:SciChart.Drawing.Common.TextureFiltering"> + <summary> + Defines the texture filtering mode. Texture filtering is the method used to determine the texture color + for a texture mapped pixel, using the colors of nearby texels (pixels of the texture) + </summary> + </member> + <member name="F:SciChart.Drawing.Common.TextureFiltering.Point"> + <summary> + Point filtering samples a texture without considering values from nearby texels. Final image looks sharp. + </summary> + </member> + <member name="F:SciChart.Drawing.Common.TextureFiltering.Linear"> + <summary> + Linear filtering samples a texture by linear interpolation of values from nearby texels. Final image looks smoothed. + Supported only by DirectX render context. + </summary> + </member> + <member name="T:SciChart.Drawing.Common.ITexture2D"> + <summary> + Defines the interface to a 2D texture, used to draw images on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="P:SciChart.Drawing.Common.ITexture2D.Width"> + <summary> + Gets the width of the texture + </summary> + </member> + <member name="P:SciChart.Drawing.Common.ITexture2D.Height"> + <summary> + Gets the height of the texture + </summary> + </member> + <member name="P:SciChart.Drawing.Common.ITexture2D.TextureFormat"> + <summary> + Gets the texture format for this texture + </summary> + </member> + <member name="M:SciChart.Drawing.Common.ITexture2D.SetData(System.Int32[])"> + <summary> + Sets int[] pixel data on the Texture. Assumes <see cref="F:SciChart.Drawing.Common.TextureFormats.Bgra8" /></summary> + <param name="colorData">The color data for pixels.</param> + </member> + <member name="M:SciChart.Drawing.Common.ITexture2D.SetFloatData(System.Single[])"> + <summary> + Sets int[] pixel data on the Texture. Assumes <see cref="F:SciChart.Drawing.Common.TextureFormats.Bgra8" /></summary> + <param name="colorData">The color data for pixels.</param> + </member> + <member name="T:SciChart.Drawing.Common.IVxRenderContext"> + <summary> + Defines the interface to a Twister 2D RenderContext, allowing drawing, blitting and creation of pens and brushes on the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawLinesBatch(SciChart.Charting2D.Interop.XyColorVertex[],System.Int32,SciChart.Drawing.Common.IPen2D,System.Boolean,System.Boolean,System.Nullable{System.Boolean},SciChart.Charting2D.Interop.SCRTVertexTransform)"> + <summary> + Draws lines from <see cref="T:SciChart.Charting2D.Interop.XyColorVertex" /> array as a single batched call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XyColorVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="pen">The default line pen.</param> + <param name="isStrips">If set to <c>false</c> draw a line in segments.</param> + <param name="isDigital">If set to <c>true</c> draw a digital, stepped line.</param> + <param name="isDrawNanAsGaps">If set to <c>true</c> double.NaN gaps are rendered as gaps, otherwise as closed lines. Null means regular line.</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawSpritesBatch(SciChart.Charting2D.Interop.XySpriteVertex[],System.Int32,SciChart.Drawing.Common.ISprite2D,SciChart.Drawing.Common.ISprite2D,SciChart.Charting2D.Interop.SCRTVertexTransform,System.Single)"> + <summary> + Draws sprites defined by the <see cref="T:SciChart.Drawing.Common.ISprite2D" /> from an <see cref="T:SciChart.Charting2D.Interop.XySpriteVertex" /> array as a single batched call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XyColorVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="sprite">The sprite to draw at each point</param> + <param name="strokeSprite">The sprite to draw stroke at each point</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + <param name="centeredAmount"></param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawBandsBatch(SciChart.Charting2D.Interop.XyyBandVertex[],System.Int32,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,SciChart.Drawing.Common.IBrush2D,System.Boolean,SciChart.Charting2D.Interop.SCRTVertexTransform,SciChart.Charting2D.Interop.SCRTPalette)"> + <summary> + Draws two lines and a band polygon between the Y0 and Y1 points on each <see cref="T:SciChart.Charting2D.Interop.XyyBandVertex" />, as a single batched call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XyyBandVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="penA">The pen to draw the Y0 line.</param> + <param name="penB">The pen to draw the Y1 line.</param> + <param name="brushP">The brush used to fill the band when Y0 > Y1.</param> + <param name="brushN">The brush used to fill the band when Y0 < Y1.</param> + <param name="isDigital">If set to <c>true</c> draw a digital line/band.</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + <param name="palette">The optional colors to apply to each point during rendering. Null means default colors.</param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawMountainBatch(SciChart.Charting2D.Interop.XyyBandVertex[],System.Int32,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,System.Boolean,SciChart.Charting2D.Interop.SCRTVertexTransform,SciChart.Charting2D.Interop.SCRTPalette)"> + <summary> + Draws a mountain or area between Y0 and Y1 in the <see cref="T:SciChart.Charting2D.Interop.XyyBandVertex" /> array, as a single batched draw call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XyyBandVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="pen">The pen to draw the Y0 line.</param> + <param name="brush">The brush used to fill the area when Y0 > Y1.</param> + <param name="isDigital">If set to <c>true</c> draw a digital line/mountain.</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + <param name="palette">The optional colors to apply to each point during rendering. Null means default colors.</param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawCandlesBatch(SciChart.Charting2D.Interop.XohlcCandleVertex[],System.Int32,System.Single,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,SciChart.Drawing.Common.IBrush2D,SciChart.Charting2D.Interop.SCRTVertexTransform)"> + <summary> + Draws candlesticks from the <see cref="T:SciChart.Charting2D.Interop.XohlcCandleVertex" /> array, as a single batched draw call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XohlcCandleVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="width">The width of each candle in pixels</param> + <param name="penHigh">The pen to paint wicks if the candle is an UP candle</param> + <param name="penLow">The pen to paint wicks if the candle is a DOWN candle</param> + <param name="brushHigh">The brush to fill candles if the candle is UP</param> + <param name="brushLow">The brush to fill candles if the candle is DOWN</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawOhlcBatch(SciChart.Charting2D.Interop.XohlcCandleVertex[],System.Int32,System.Single,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IPen2D,SciChart.Charting2D.Interop.SCRTVertexTransform)"> + <summary> + Draws OHLC bars from the <see cref="T:SciChart.Charting2D.Interop.XohlcCandleVertex" /> array, as a single batched draw call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XohlcCandleVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="width">The width of each bar in pixels</param> + <param name="penHigh">The pen to paint wicks if the bar is an UP bar</param> + <param name="penLow">The pen to paint wicks if the bar is a DOWN bar</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawColumnsBatch(SciChart.Charting2D.Interop.XyColumnVertex[],System.Int32,SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,SciChart.Charting2D.Interop.SCRTVertexTransform)"> + <summary> + Draws columns from the <see cref="T:SciChart.Charting2D.Interop.XyColumnVertex" /> array, as a single batched draw call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XyColumnVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="pen">The pen to draw the stroke line.</param> + <param name="brush">The brush used to fill the area.</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + </member> + <member name="M:SciChart.Drawing.Common.IVxRenderContext.DrawRectsBatch(SciChart.Charting2D.Interop.XyRectVertex[],System.Int32,SciChart.Drawing.Common.ISprite2D,SciChart.Charting2D.Interop.SCRTVertexTransform)"> + <summary> + Draws rectangles from the <see cref="T:SciChart.Charting2D.Interop.XyRectVertex" /> array, as a single batched draw call. + </summary> + <param name="points">The <see cref="T:SciChart.Charting2D.Interop.XyRectVertex" /> array containing data to draw.</param> + <param name="count">The number of points to draw.</param> + <param name="sprite">The sprite to draw at each point</param> + <param name="vertexTransform">The optional per-vertex transform to apply to each point during rendering. Null means identity matrix.</param> + </member> + <member name="T:SciChart.Drawing.Common.RenderContextBase"> + <summary> + Defines the base class for <see cref="T:SciChart.Drawing.Common.IRenderContext2D" /> implementors, allowing drawing, blitting and creation of pens and brushes on the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderContextBase.Layers"> + <summary> + Gets a collection of <see cref="T:SciChart.Drawing.Common.RenderOperationLayer" /> layers, which allow rendering operations to be posted to a layered queue for later + execution in order (and correct Z-ordering). + </summary> + <seealso cref="T:SciChart.Drawing.Common.RenderLayer"></seealso> + <seealso cref="T:SciChart.Drawing.Common.RenderOperationLayer"></seealso> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase"></seealso> + <example> + <code title="RenderOperationLayers Example" description="Demonstrates how to enqueue operations to the RenderOperationLayers collection and later flush to ensure rendering operations get processed in the correct Z-order" lang="C#"> + RenderOperationLayers layers = renderContext.Layers; + + // Enqueue some operations in the layers in any order + layers[RenderLayer.AxisMajorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + layers[RenderLayer.AxisBands].Enqueue(() => renderContext.DrawRectangle(/* .. */)); + layers[RenderLayer.AxisMinorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + + // Processes all layers by executing enqueued operations in order of adding, + // and in Z-order of layers + layers.Flush();</code> + </example> + </member> + <member name="P:SciChart.Drawing.Common.RenderContextBase.ViewportSize"> + <summary> + Gets the size of the current viewport for this render operation + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.SetPrimitivesCachingEnabled(System.Boolean)"> + <summary> + enables/disables primitves chaching optimization ( Direct3D renderer only ) + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.CreateBrush(System.Windows.Media.Color,System.Double,System.Nullable{System.Boolean})"> + <summary> + Creates a <see cref="T:SciChart.Drawing.Common.IBrush2D" /> valid for the current render pass. Use this to draw rectangles, polygons and shaded areas + </summary> + <param name="color">The color of the brush, supports transparency</param> + <param name="opacity">The opacity of the brush</param> + <param name="alphaBlend">If true, use alphablending when shading. If null, auto-detect from the Color</param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IBrush2D" /> instance + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.CreateBrush(System.Windows.Media.Brush,System.Double,SciChart.Drawing.Common.TextureMappingMode)"> + <summary> + Creates a <see cref="T:SciChart.Drawing.Common.IBrush2D" /> from WPF Brush valid for the current render pass. Use this to draw rectangles, polygons and shaded areas + </summary> + <param name="brush">The WPF Brush to use as a source, e.g. this can be a <seealso cref="T:System.Windows.Media.SolidColorBrush" />, or it can be a <seealso cref="T:System.Windows.Media.LinearGradientBrush" />. Note that solid colors support transparency and are faster than gradient brushes</param> + <param name="opacity">The opacity of the brush</param> + <param name="textureMappingMode"></param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IBrush2D" /> instance + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.CreatePen(System.Windows.Media.Color,System.Boolean,System.Single,System.Double,System.Double[],System.Windows.Media.PenLineCap)"> + <summary> + Creates a <see cref="T:SciChart.Drawing.Common.IPen2D" /> valid for the current render pass. Use this to draw outlines, quads and lines + </summary> + <param name="color">The color of the pen, supports transparency</param> + <param name="antiAliasing">If true, use antialiasing</param> + <param name="strokeThickness">The strokethickness, default=1.0</param> + <param name="opacity">The opecity of the pen</param> + <param name="strokeDashArray"></param> + <param name="strokeEndLineCap"></param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IPen2D" /> instance + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.CreateSprite(System.Windows.FrameworkElement)"> + <summary> + Creates a Sprite from FrameworkElement by rendering to bitmap. This may be used in the <see cref="M:SciChart.Drawing.Common.RenderContextBase.DrawSprite(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Windows.Point)" /> method + to draw to the screen repeatedly + </summary> + <param name="fe">The FrameworkElement to render</param> + <returns>The sprite which may be drawn in SciChart</returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.CreateSprite(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Creates a Sprite from WriteableBitmap. This may be used in the <see cref="M:SciChart.Drawing.Common.RenderContextBase.DrawSprite(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Windows.Point)" /> method + to draw to the screen repeatedly + </summary> + <param name="spriteContent">The WriteableBitmap containing the sprite content</param> + <returns>The sprite which may be drawn in SciChart</returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.Clear"> + <summary> + Clears the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawSprite(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Windows.Point)"> + <summary> + Blits the source image onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="srcSprite">The source sprite to render</param> + <param name="srcRect">The source rectangle</param> + <param name="destPoint">The destination point, which will be the top-left coordinate of the sprite after blitting</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawSprites(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Batch draw of the source sprite onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="sprite2D">The sprite to render</param> + <param name="srcRect">The source rectangle</param> + <param name="points">The points to draw sprites at</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawSprites(SciChart.Drawing.Common.ISprite2D,System.Collections.Generic.IEnumerable{System.Windows.Rect})"> + <summary> + Batch draw of the source sprite onto the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="sprite2D">The sprite to render</param> + <param name="dstRects">The destination rectangles to draw sprites at</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.FillRectangle(SciChart.Drawing.Common.IBrush2D,System.Windows.Point,System.Windows.Point,System.Double)"> + <summary> + Fills a rectangle on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="brush">The brush</param> + <param name="pt1"></param> + <param name="pt2"></param> + <param name="gradientRotationAngle">The angle which the brush is rotated by</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.FillRectangle(System.Int32,System.Windows.Point,System.Windows.Point)"> + <summary> + Fills a rectangle on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="color">The brush</param> + <param name="pt1"></param> + <param name="pt2"></param> + <param name="gradientRotationAngle">The angle which the brush is rotated by</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.FillArea(SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Tuple{System.Windows.Point,System.Windows.Point}},System.Boolean,System.Double)"> + <summary> + Fills an area, limited by two line segments, e.g. as in a stacked mountain chart, using the specified <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="brush">The brush</param> + <param name="lines">The list of lines representing polygon segments</param> + <param name="isVerticalChart">Value, indicates whether chart is vertical</param> + <param name="gradientRotationAngle">The angle which the brush is rotated by</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawEllipse(SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,System.Windows.Point,System.Double,System.Double)"> + <summary> + Draws an Ellipse on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified outline <see cref="T:SciChart.Drawing.Common.IPen2D">Pen</see> and fill <see cref="T:SciChart.Drawing.Common.IBrush2D">Brush</see></summary> + <param name="strokePen">The stroke pen</param> + <param name="fillBrush">The fill brush</param> + <param name="center">The center of the ellipse in pixels</param> + <param name="width">The width of the ellipse in pixels</param> + <param name="height">The height of the ellipse in pixels</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawEllipses(SciChart.Drawing.Common.IPen2D,SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Windows.Point},System.Double,System.Double)"> + <summary> + Draws 0..N Ellipses at the points passed in with the same width, height, pen and brush + </summary> + <param name="strokePen"></param> + <param name="fillBrush"></param> + <param name="centres">The points to draw ellipses at</param> + <param name="width">The common width for all ellipses</param> + <param name="height">The common height for all ellipses</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DisposeResourceAfterDraw(System.IDisposable)"> + <summary> + Call this method, passing in <see cref="T:System.IDisposable" /> instance to dispose after the render pass completes. + Called internally by SciChart to lazy-dispose of Direct2D and Direct3D brushes and textures + </summary> + <param name="disposable"></param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawPixelsVertically(System.Int32,System.Int32,System.Int32,System.Int32,System.Collections.Generic.IList{System.Int32},System.Double,System.Boolean)"> + <summary> + Draws vertical scan line for heatmap + from bottom to top, from yStart to yEnd + </summary> + <param name="xLeft">Screen X coordinate where to draw pixels</param> + <param name="xRight">Screen X coordinate where to draw pixels</param> + <param name="yStartBottom">Screen Y coordinate of vertical scan line's bottom. + Can be located outdide of visible area, in this case not all pixels in list are rendered</param> + <param name="yEndTop">Screen Y coordinate of vertical scan line's top. + Can be located outdide of visible area, in this case not all pixels in list are rendered</param> + <param name="pixelColorsArgb">The colors to apply to the vertical scanline</param> + <param name="opacity">The opacity of the vertical scaline, from 0.0 to 1.0</param> + <param name="yAxisIsFlipped">if set to <c>true</c> then y axis is flipped.</param> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawPixelsVertically(System.Int32,System.Int32,System.Int32[],System.Collections.Generic.IList{System.Int32},System.Double,System.Boolean,System.Boolean)"> + <summary> + Draws vertical scan line for heatmap + from bottom to top, from yStart to yEnd + </summary> + <param name="xLeft">Screen X coordinate where to draw pixels</param> + <param name="xRight">Screen X coordinate where to draw pixels</param> + <param name="yCoordinates"> An array of yCoordinates on YAxis</param> + <param name="pixelColorsArgb">The list of pixel colors to draw</param> + <param name="opacity">The Opacity of the line from 0.0 to 1.0</param> + <param name="isUniform">if set to <c>true</c> then X values are to each other and the same is for Y values.</param> + <param name="yAxisIsFlipped">if set to <c>true</c> then y axis is flipped.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawQuad(SciChart.Drawing.Common.IPen2D,System.Windows.Point,System.Windows.Point)"> + <summary> + Draws a Quad on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IPen2D" /></summary> + <param name="pen">The Pen</param> + <param name="pt1"></param> + <param name="pt2"></param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawLine(SciChart.Drawing.Common.IPen2D,System.Windows.Point,System.Windows.Point)"> + <summary> + Draws a single line on the + <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified + <see cref="T:SciChart.Drawing.Common.IPen2D" />. + Note for a faster implementation in some rasterizers, use DrawLines + </summary> + <param name="pen">The pen</param> + <param name="pt1">The start of the line in pixels</param> + <param name="pt2">The end of the line in pixels</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawLines(SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Draws a multi-point line on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specified <see cref="T:SciChart.Drawing.Common.IPen2D" /></summary> + <param name="pen">The pen</param> + <param name="points">The points.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.FillPolygon(SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Windows.Point})"> + <summary> + Fills a polygon on the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> using the specifie <see cref="T:SciChart.Drawing.Common.IBrush2D" /></summary> + <param name="brush">The brush</param> + <param name="points">The list of points defining the closed polygon, where X,Y coordinates in clockwise direction</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.DrawText(System.Windows.Rect,System.Windows.Media.Color,System.Single,System.String,System.Windows.Media.FontFamily,System.Windows.FontWeight,System.Windows.FontStyle)"> + <summary> + Draws text if it does not go outside + </summary> + <param name="dstBoundingRect"></param> + <param name="foreColor"></param> + <param name="fontSize"></param> + <param name="text"></param> + <param name="fontFamily"></param> + <param name="fontWeight"></param> + <param name="fontStyle"></param> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.BeginLine(SciChart.Drawing.Common.IPen2D,System.Double,System.Double)"> + <summary> + Begins a Polyline segment, returning the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" />. This is the fastest way to draw lines and simply a proxy to <see cref="M:SciChart.Drawing.Common.RenderContextBase.DrawLines(SciChart.Drawing.Common.IPen2D,System.Collections.Generic.IEnumerable{System.Windows.Point})" /> method. + </summary> + <param name="pen">The pen for the line segment</param> + <param name="startX">The start X coordinate (pixel coord)</param> + <param name="startY">The start Y coordinate (pixel coord)</param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to continue the line + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.BeginPolygon(SciChart.Drawing.Common.IBrush2D,System.Double,System.Double,System.Double)"> + <summary> + Begins a filled Polygon segment, returning the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" />. This is the fastest way to draw polygon and simply a proxy to <see cref="M:SciChart.Drawing.Common.RenderContextBase.FillArea(SciChart.Drawing.Common.IBrush2D,System.Collections.Generic.IEnumerable{System.Tuple{System.Windows.Point,System.Windows.Point}},System.Boolean,System.Double)" /> method. + </summary> + <param name="brush">The brush for the polygon fill</param> + <param name="startX">The start X coordinate (pixel coord)</param> + <param name="startY">The start Y coordinate (pixel coord)</param> + <param name="gradientRotationAngle">The angle which the <param name="brush"></param> is rotated by</param> + <returns> + The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to continue the polygon + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.BeginSpriteBatch(SciChart.Drawing.Common.ISprite2D,System.Double,System.Double,System.Nullable{System.Double},System.Nullable{System.Double})"> + <summary> + Begins a Sprite Batch, returning the <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" />. This is the fastest way to draw sprites and simply a proxy to <see cref="M:SciChart.Drawing.Common.RenderContextBase.DrawSprites(SciChart.Drawing.Common.ISprite2D,System.Windows.Rect,System.Collections.Generic.IEnumerable{System.Windows.Point})" /> method. + </summary> + <param name="sprite">The sprite for the Sprite Batch</param> + <param name="centerX">The start X coordinate (pixel coord)</param> + <param name="centerY">The start Y coordinate (pixel coord)</param> + <param name="width">An optional width override for the sprite. Defaults to Sprite.Width</param> + <param name="height">An optional height override for the sprite. Defaults to Sprite.Height</param> + <returns>The <see cref="T:SciChart.Drawing.Common.IPathDrawingContext" /> to continue the sprite batch</returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.ClipZeroLineForArea(System.Double,System.Boolean)"> + <summary> + Used internally: Clips the zero line (e.g. in mountain fills) to the viewport + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.ClipArea(System.Collections.Generic.IEnumerable{System.Windows.Point},System.Int32,System.Int32)"> + <summary> + Used internally to clip a polygon or line-segment to the viewport + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.IsInBounds(System.Windows.Point)"> + <summary> + Returns true if the point is inside the viewport + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderContextBase.ClipArea(System.Collections.Generic.IEnumerable{System.Tuple{System.Windows.Point,System.Windows.Point}})"> + <summary> + Used internally to clip the area of a StackedMountainSeries to the viewport + </summary> + <param name="lines">Collection of lines, which represent bounds of a polygon segment</param> + </member> + <member name="T:SciChart.Drawing.Common.RenderedEventArgs"> + <summary> + Event args used when the <see cref="E:SciChart.Drawing.Common.IRenderSurface.Rendered" /> event is raised + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + </member> + <member name="M:SciChart.Drawing.Common.RenderedEventArgs.#ctor(System.Double)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.Common.RenderedEventArgs" /> class. + </summary> + <param name="duration">The duration of the last render operation in milliseconds</param> + </member> + <member name="P:SciChart.Drawing.Common.RenderedEventArgs.Duration"> + <summary> + Gets the duration of the last render operation in milliseconds + </summary> + </member> + <member name="T:SciChart.Drawing.Common.RenderOperationLayer"> + <summary> + Stores a queue of <see cref="T:System.Action" /> operations to perform, intended to be used to queue rendering operations and re-arrange Z-order + </summary> + <seealso cref="T:SciChart.Drawing.Common.RenderLayer" /> + <seealso cref="T:SciChart.Drawing.Common.RenderOperationLayer" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <example> + <code title="RenderOperationLayers Example" description="Demonstrates how to enqueue operations to the RenderOperationLayers collection and later flush to ensure rendering operations get processed in the correct Z-order" lang="C#"> + RenderOperationLayers layers = renderContext.Layers; + + // Enqueue some operations in the layers in any order + layers[RenderLayer.AxisMajorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + layers[RenderLayer.AxisBands].Enqueue(() => renderContext.DrawRectangle(/* .. */)); + layers[RenderLayer.AxisMinorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + + // Processes all layers by executing enqueued operations in order of adding, + // and in Z-order of layers + layers.Flush();</code> + </example> + </member> + <member name="M:SciChart.Drawing.Common.RenderOperationLayer.Enqueue(System.Action)"> + <summary> + Enqueues an operation to the layer + </summary> + <param name="operation">The operation to queue</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderOperationLayer.Flush"> + <summary> + Flushes, the layer, which processes all operations and clears the queue + </summary> + </member> + <member name="T:SciChart.Drawing.Common.RenderLayer"> + <summary> + Enumeration Constants to define the layers in <see cref="T:SciChart.Drawing.Common.RenderOperationLayers" /></summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderLayer.AxisBands"> + <summary> + The Axis Bands render layer, Z-order = 0 + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderLayer.AxisMinorGridlines"> + <summary> + The Axis Minor Gridlines render layer, Z-order = 1 + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderLayer.AxisMajorGridlines"> + <summary> + The Axis Major Gridlines render layer, Z-order = 2 + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderLayer.RenderableSeries"> + <summary> + The RenderableSeries render layer, Z-order = 3 + </summary> + </member> + <member name="T:SciChart.Drawing.Common.RenderOperationLayers"> + <summary> + A collection of <see cref="T:SciChart.Drawing.Common.RenderOperationLayer" /> layers, which allow rendering operations to be posted to a layered queue for later + execution in order (and correct Z-ordering). + </summary> + <seealso cref="T:SciChart.Drawing.Common.RenderLayer"></seealso> + <seealso cref="T:SciChart.Drawing.Common.RenderOperationLayer"></seealso> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase"></seealso> + <example> + <code title="RenderOperationLayers Example" description="Demonstrates how to enqueue operations to the RenderOperationLayers collection and later flush to ensure rendering operations get processed in the correct Z-order" lang="C#"> + RenderOperationLayers layers = renderContext.Layers; + + // Enqueue some operations in the layers in any order + layers[RenderLayer.AxisMajorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + layers[RenderLayer.AxisBands].Enqueue(() => renderContext.DrawRectangle(/* .. */)); + layers[RenderLayer.AxisMinorGridlines].Enqueue(() => renderContext.DrawLine(/* .. */)); + + // Processes all layers by executing enqueued operations in order of adding, + // and in Z-order of layers + layers.Flush();</code> + </example> + </member> + <member name="P:SciChart.Drawing.Common.RenderOperationLayers.Item(SciChart.Drawing.Common.RenderLayer)"> + <summary> + Gets the <see cref="T:SciChart.Drawing.Common.RenderOperationLayer" /> with the specified <see cref="T:SciChart.Drawing.Common.RenderLayer" />. + </summary> + <value> + The <see cref="T:SciChart.Drawing.Common.RenderOperationLayer" />. + </value> + <param name="layer">The layer to get.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderOperationLayers.GetEnumerator"> + <summary> + Returns an enumerator that iterates through a collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection. + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderOperationLayers.System#Collections#IEnumerable#GetEnumerator"> + <summary> + Returns an enumerator that iterates through a collection. + </summary> + <returns> + An <see cref="T:System.Collections.IEnumerator" /> object that can be used to iterate through the collection. + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderOperationLayers.Flush"> + <summary> + Flushes the <see cref="T:SciChart.Drawing.Common.RenderOperationLayer" /> collection, processing and executing all render operations according to the + Z-order defined by the <see cref="T:SciChart.Drawing.Common.RenderLayer" /> enumeration + </summary> + </member> + <member name="T:SciChart.Drawing.Common.RenderSurfaceBase"> + <summary> + An abstract base class for the RenderSurface, which is a viewport used within the a SciChartSurface to + render RenderableSeries types in a fast manner. The renderer architecture is plugin based, meaning we have + build multiple implementations of <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" />. + </summary> + <seealso cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> + <seealso cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.MaxFrameRateProperty"> + <summary> + Defines the MaxFrameRate DependencyProperty + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.UseResizeThrottleProperty"> + <summary> + Defines the UseResizeThrottle DependencyProperty + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.ResizeThrottleMsProperty"> + <summary> + Defines the ResizeThrottleMs DependencyProperty + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.ShowLicensingWarningsProperty"> + <summary> + Defines the ShowLicensingWarnings DependencyProperty + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.IsPolarChartProperty"> + <summary> + Defines the IsPolarChart DependencyProperty + </summary> + </member> + <member name="E:SciChart.Drawing.Common.RenderSurfaceBase.Draw"> + <summary> + Raised each time the render surface is to be drawn. Handle this event to paint to the surface + </summary> + </member> + <member name="E:SciChart.Drawing.Common.RenderSurfaceBase.Rendered"> + <summary> + Raised immediately after a render operation has completed + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.RectIdentifier"> + <summary> + A GUID to identify the hit-test rect on this RenderSurface + </summary> + </member> + <member name="F:SciChart.Drawing.Common.RenderSurfaceBase.RenderWriteableBitmap"> + <summary> + The WriteableBitmap instance used by this RenderSurface + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.IsDisposed"> + <summary> + Gets whether an instance of the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> class is disposed or not. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> class. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.Finalize"> + <summary> + Finalizes an instance of the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> class. + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.FontCache"> + <summary> + Returns the FontCache (for drawing font characters) of the current RenderSurface + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.Services"> + <summary> + Gets or sets the <see cref="T:SciChart.Core.Utility.IServiceContainer" /> instance + </summary> + <value>The services.</value> + <remarks></remarks> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.UseThreadedRenderTimer"> + <summary> + Experimental. Switches the RenderTimer using CompositionTarget.Rendering for a ThreadedRenderScheduler which uses background thread to initiate drawing at high priority + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.IsPolarChart"> + <summary> + Gets whether the SciChartSurface is a polar chart or not + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.ShowLicensingWarnings"> + <summary> + When True, Licensing warnings such as missing Runtime Keys, or invalid license tokens, are displayed on the SciChart UI. Set this property to false to hide such warnings. + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.Grid"> + <summary> + Gets the root element <see cref="P:SciChart.Drawing.Common.RenderSurfaceBase.Grid" /> which hosts components in the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.SeriesPanel"> + <summary> + Gets the SeriesPanel <see cref="P:SciChart.Drawing.Common.RenderSurfaceBase.Grid" /> which hosts RenderableSeries, allowing them to participate in binding and visual tree operations + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.MaxFrameRate"> + <summary> + Gets or sets the Maximum Frame Rate of this RenderSurface. By default this is bound to the parent SciChartSurface.MaxFrameRate + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.ResizeThrottleMs"> + <summary> + Gets or sets a timeout for resizing, e.g. 100ms means that the RenderSurface will batch up all Resize events received within a 100ms window. This reduces the CPU usage on resize. Also see <see cref="P:SciChart.Drawing.Common.RenderSurfaceBase.UseResizeThrottle" /> dependency property, which must be true + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.UseResizeThrottle"> + <summary> + If true, uses the <see cref="P:SciChart.Drawing.Common.RenderSurfaceBase.ResizeThrottleMs" /> value to batch up Resize Events received within a certain time window, reducing the CPU load on resize + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.NeedsResizing"> + <summary> + Returns True if the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> size has changed and the viewport needs resizing + </summary> + <remarks></remarks> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.IsSizeValidForDrawing"> + <summary> + Returns true if the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> size is valid for drawing + </summary> + </member> + <member name="P:SciChart.Drawing.Common.RenderSurfaceBase.ChildSeries"> + <summary> + Gets the child RenderableSeries in this <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /> instance + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.InvalidateElement"> + <summary> + Invalidates the RenderSurface, causing a repaint to occur + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.Clear"> + <summary> + Clears the viewport + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.ContainsSeries(System.Windows.FrameworkElement)"> + <summary> + Returns True if the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> contains the <see cref="T:System.Windows.FrameworkElement" /> instance + </summary> + <param name="renderableSeries">the <see cref="T:System.Windows.FrameworkElement" /> instance</param> + <returns> + <c>true</c> if the specified renderable series contains series; otherwise, <c>false</c>.</returns> + <remarks></remarks> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.AddSeries(System.Collections.Generic.IEnumerable{System.Windows.FrameworkElement})"> + <summary> + Adds the <see cref="T:System.Windows.FrameworkElement" /> instance to the <see cref="T:SciChart.Drawing.Common.IRenderSurface2D" /></summary> + <param name="renderableSeries"></param> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.AddSeries(System.Windows.FrameworkElement)"> + <summary> + Adds the <see cref="T:System.Windows.FrameworkElement" /> instance to the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + <param name="renderableSeries">The renderable series.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.RemoveSeries(System.Windows.FrameworkElement)"> + <summary> + Removes the <see cref="T:System.Windows.FrameworkElement" /> from the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + <param name="renderableSeries">The renderable series.</param> + <remarks></remarks> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.ClearSeries"> + <summary> + Clears all <see cref="T:System.Windows.FrameworkElement" /> on the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /></summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.Dispose(System.Boolean)"> + <summary> + Releases unmanaged and - optionally - managed resources. + </summary> + <param name="disposing"> + <c>true</c> to release both managed and unmanaged resources; <c>false</c> to release only unmanaged resources.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.RecreateSurface"> + <summary> + Recreates the elements required by the Viewport, called once at startup and when the surface is resized + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.PublishResizedMessage(System.Int32,System.Int32)"> + <summary> + Publishes <see cref="T:SciChart.Core.Messaging.RenderSurfaceResizedMessage" /> with actual viewport size + </summary> + <param name="width"></param> + <param name="height"></param> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.GetRenderContext"> + <summary> + When overridden in a derived class, returns a RenderContext valid for the current render pass + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.DisposeUnmanagedResources"> + <summary> + Derived classes may override this method to be notified when to dispose of unmanaged resources. Called when the + <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is disposed + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.OnRenderTimeElapsed"> + <summary> + Called when the <see cref="E:System.Windows.Media.CompositionTarget.Rendering" /> event is raised + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.OnDraw"> + <summary> + Raises the <see cref="E:SciChart.Drawing.Common.IRenderSurface.Draw">Draw</see> event which precedes the render operation + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.OnRendered(System.Double)"> + <summary> + Raises the Rendered event with the specified duration + </summary> + <param name="duration">The duration.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.OnRenderSurfaceBaseLoaded(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is loaded into the visual tree + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.RoutedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.OnRenderSurfaceBaseUnloaded(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Called when the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is Unloaded from the visual tree + </summary> + <param name="sender">The sender.</param> + <param name="e">The <see cref="T:System.Windows.RoutedEventArgs" /> instance containing the event data.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.TranslatePoint(System.Windows.Point,SciChart.Core.Framework.IHitTestable)"> + <summary> + Translates the point relative to the other <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The input point relative to this <see cref="T:SciChart.Core.Framework.IHitTestable" /></param> + <param name="relativeTo">The other <see cref="T:SciChart.Core.Framework.IHitTestable" /> to use when transforming the point</param> + <returns> + The transformed Point + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.IsPointWithinBounds(System.Windows.Point)"> + <summary> + Returns true if the Point is within the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="point">The point to test</param> + <returns> + true if the Point is within the bounds + </returns> + </member> + <member name="M:SciChart.Drawing.Common.RenderSurfaceBase.GetBoundsRelativeTo(SciChart.Core.Framework.IHitTestable)"> + <summary> + Gets the bounds of the current <see cref="T:SciChart.Core.Framework.IHitTestable" /> element relative to another <see cref="T:SciChart.Core.Framework.IHitTestable" /> element + </summary> + <param name="relativeTo"></param> + <returns></returns> + </member> + <member name="T:SciChart.Drawing.Common.RenderTimer"> + <summary> + <para>A timer which uses either <see cref="E:System.Windows.Media.CompositionTarget.Rendering" /> event (in case of maxFrameRate supplied as null to Constructor) or DispatcherTimer. </para> + <para>Used by <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> derived types to trigger drawing</para> + </summary> + </member> + <member name="M:SciChart.Drawing.Common.RenderTimer.#ctor(System.Nullable{System.Double},SciChart.Core.Framework.IDispatcherFacade,System.Action)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.Common.RenderTimer" /> class. + </summary> + <param name="maxFrameRate">The maximum frame rate. When null, uses <see cref="E:System.Windows.Media.CompositionTarget.Rendering" /> event. Else, uses a dispatcher timer</param> + <param name="dispatcher">The dispatcher.</param> + <param name="renderOperation">The operation to invoke on timer tick.</param> + </member> + <member name="M:SciChart.Drawing.Common.RenderTimer.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Drawing.Common.ThreadedRenderScheduler"> + <summary> + <para>A timer which uses <see cref="T:System.Timers.Timer" /> to signal when rendering should occur. This can be used to solve problems with WinForms / WPF message loops and priority in certain high performance scenarios</para> + <para>Used by <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> derived types to trigger drawing</para> + </summary> + </member> + <member name="M:SciChart.Drawing.Common.ThreadedRenderScheduler.#ctor(System.Nullable{System.Double},SciChart.Core.Framework.IDispatcherFacade,System.Action)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.Common.RenderTimer" /> class. + </summary> + <param name="maxFrameRate">The maximum frame rate. When null, uses <see cref="E:System.Windows.Media.CompositionTarget.Rendering" /> event. Else, uses a dispatcher timer</param> + <param name="dispatcher">The dispatcher.</param> + <param name="renderOperation">The operation to invoke on timer tick.</param> + </member> + <member name="M:SciChart.Drawing.Common.ThreadedRenderScheduler.Dispose"> + <summary> + Performs application-defined tasks associated with freeing, releasing, or resetting unmanaged resources. + </summary> + </member> + <member name="T:SciChart.Drawing.Extensions.FrameworkElementExtensions"> + <summary> + Extension methods for FrameworkElements + </summary> + </member> + <member name="M:SciChart.Drawing.Extensions.FrameworkElementExtensions.Databind(System.Windows.FrameworkElement,System.Windows.DependencyProperty,System.Object,System.String,System.Windows.Data.BindingMode,System.Windows.Data.IValueConverter)"> + <summary> + Databinds the source property to the destination property + </summary> + <param name="dest">The destination object.</param> + <param name="destProperty">The destination property.</param> + <param name="source">The source object.</param> + <param name="sourcePath">The source path.</param> + <param name="mode">The Binding mode.</param> + </member> + <member name="M:SciChart.Drawing.Extensions.FrameworkElementExtensions.RenderToBitmap(System.Windows.FrameworkElement)"> + <summary> + Renders a FrameworkElement to bitmap + </summary> + <param name="element">The element.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Extensions.FrameworkElementExtensions.RenderToBitmap(System.Windows.FrameworkElement,System.Int32,System.Int32)"> + <summary> + Renders a FrameworkElement to bitmap at the requested width, height + </summary> + <param name="element">The element.</param> + <param name="width">The width.</param> + <param name="height">The height.</param> + <returns></returns> + </member> + <member name="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface"> + <summary> + Provides a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> implementation that uses a High-Quality software rasterizer, capable of rendering with sub-pixel accuracy. + The downside is, the <see cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> uses a more accurate floating-point math rendering engine which is slower than the <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> counterpart + </summary> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="F:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface._emptyStrideRow"> + <summary> + An empty row, used to fast clear bitmaps + </summary> + </member> + <member name="M:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface.RecreateSurface"> + <summary> + Recreates the WriteableBitmap used by the Viewport + </summary> + <remarks></remarks> + </member> + <member name="M:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface.GetRenderContext"> + <summary> + When overridden in a derived class, returns a RenderContext valid for the current render pass + </summary> + <returns></returns> + </member> + <member name="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface"> + <summary> + Provides a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> implementation that uses a High-Speed software rasterizer, capable of outputting many millions of points (line-series) + at interactive framerates. The downside is, the <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> uses integer fixed-point math which results in jagged lines. + </summary> + <seealso cref="T:SciChart.Drawing.HighQualityRasterizer.HighQualityRenderSurface" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface.GetRenderContext"> + <summary> + When overridden in a derived class, returns a RenderContext valid for the current render pass + </summary> + <returns></returns> + </member> + <!-- Badly formed XML comment ignored for member "M:SciChart.Drawing.Tessellator.Geom.EdgeEval(SciChart.Drawing.Tessellator.MeshUtils.Vertex,SciChart.Drawing.Tessellator.MeshUtils.Vertex,SciChart.Drawing.Tessellator.MeshUtils.Vertex)" --> + <member name="T:SciChart.Drawing.TextureCache"> + <summary> + The TextureCache is used by the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> to cache frequently used textures, such as Sprites or Gradient Brushes. + The maximum memory size is set by <see cref="F:SciChart.Drawing.TextureCache.MaxMemorySize" /> (default 32MBytes), and maximum number of items held is set by <see cref="F:SciChart.Drawing.TextureCache.MaxItemsCount" /> (default 2048). + </summary> + </member> + <member name="F:SciChart.Drawing.TextureCache.MaxMemorySize"> + <summary> + The maximum memory size that the TextureCache can hold + </summary> + </member> + <member name="F:SciChart.Drawing.TextureCache.MaxItemsCount"> + <summary> + The maximum items count that the TextureCache can hold + </summary> + </member> + <member name="M:SciChart.Drawing.TextureCache.AddTexture(System.Windows.Size,System.Windows.Media.Brush,System.Byte[])"> + <summary> + Adds the texture to the Texturecache + </summary> + <param name="size">The size of the texture in pixels.</param> + <param name="brush">The brush used as a key for texture cache.</param> + <param name="texture">The texture.</param> + </member> + <member name="M:SciChart.Drawing.TextureCache.GetByteTexture(System.Windows.Size,System.Windows.Media.Brush)"> + <summary> + Gets the Texture of Size N and keyed by Brush + </summary> + <param name="size">The size.</param> + <param name="brush">The brush.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.TextureCache.GetWriteableBitmapTexture(System.Windows.FrameworkElement)"> + <summary> + Gets the WriteableBitmap Texture keyed by FrameworkElement + </summary> + <param name="fe">The fe.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.TextureCache.AddTexture(System.Windows.Size,System.Windows.Media.Brush,System.Int32[])"> + <summary> + Adds a texture keyed by Size and Brush to the cache + </summary> + <param name="size">The size.</param> + <param name="brush">The brush.</param> + <param name="texture">The texture.</param> + </member> + <member name="M:SciChart.Drawing.TextureCache.GetIntTexture(System.Windows.Size,System.Windows.Media.Brush)"> + <summary> + Gets the Texture keyed by Size and Brush + </summary> + <param name="size">The size.</param> + <param name="brush">The brush.</param> + <returns></returns> + </member> + <member name="T:SciChart.Drawing.Utility.PointUtil"> + <summary> + Provides helper methods for manipulations with points + </summary> + </member> + <member name="T:SciChart.Drawing.Utility.PointUtil.Line"> + <summary> + Represents a straight line between two points + </summary> + </member> + <member name="F:SciChart.Drawing.Utility.PointUtil.Line.X1"> + <summary> + The X coord of the first point + </summary> + </member> + <member name="F:SciChart.Drawing.Utility.PointUtil.Line.Y1"> + <summary> + The Y coord of the first point + </summary> + </member> + <member name="F:SciChart.Drawing.Utility.PointUtil.Line.X2"> + <summary> + The X coord of the second point + </summary> + </member> + <member name="F:SciChart.Drawing.Utility.PointUtil.Line.Y2"> + <summary> + The Y coord of the second point + </summary> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.Line.#ctor(System.Windows.Point,System.Windows.Point)"> + <summary> + Creates a new instance of the <see cref="T:SciChart.Drawing.Utility.PointUtil.Line" /> type + </summary> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.Line.#ctor(System.Double,System.Double,System.Double,System.Double)"> + <summary> + Creates a new instance of the <see cref="T:SciChart.Drawing.Utility.PointUtil.Line" /> type + </summary> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.LineSegmentsIntersection2D(SciChart.Drawing.Utility.PointUtil.Line,SciChart.Drawing.Utility.PointUtil.Line,System.Windows.Point@)"> + <summary> + Looks for the intersection point for the two lines passed in + </summary> + <param name="firstLine">The first line</param> + <param name="secondLine">The second line</param> + <param name="intersectionPoint">If the lines intersect, holds the intersection point</param> + <returns>The value indicating whether an intersection occurs</returns> + <remarks>See http://paulbourke.net/geometry/lineline2d/Helpers.cs </remarks> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.LineIntersection2D(SciChart.Drawing.Utility.PointUtil.Line,SciChart.Drawing.Utility.PointUtil.Line,System.Windows.Point@)"> + <summary> + Looks for the intersection point for the two lines passed in + </summary> + <param name="l1">The first line</param> + <param name="l2">The second line</param> + <param name="intersectionPoint">If the lines intersect, holds the intersection point</param> + <returns>The value indicating whether an intersection occurs</returns> + <remarks>See http://paulbourke.net/geometry/lineline2d/Helpers.cs </remarks> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.IsHitOnPolygon(System.Windows.Point,System.Windows.Point[])"> + <summary> + Get whether the coordinate mouse point is on the polygon + </summary> + <param name="mousePoint">Mouse point</param> + <param name="polygonPoints">polygon points</param> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.RectangleIntersectCircle(System.Windows.Point,System.Windows.Point,System.Double,System.Double,System.Double)"> + <summary></summary> + <param name="startSelectionPoint"></param> + <param name="endSelectionPoint"></param> + <param name="centerX"></param> + <param name="centerY"></param> + <param name="radius"></param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.Distance(System.Windows.Point,System.Windows.Point)"> + <summary> + Distance between two Points + </summary> + <param name="point1">The point1.</param> + <param name="point2">The point2.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.PolarDistance(System.Windows.Point,System.Windows.Point)"> + <summary> + Distance between two Points in polar coordinates + </summary> + <param name="point1">The point1.</param> + <param name="point2">The point2.</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.DistanceFromLine(System.Windows.Point,System.Windows.Point,System.Windows.Point,System.Boolean)"> + <summary> + Compute the distance from AB to C + </summary> + <param name="pt">The pt.</param> + <param name="start">The start.</param> + <param name="end">The end.</param> + <param name="isSegment">if isSegment is true, AB is a segment, not a line..</param> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.Utility.PointUtil.IsInBounds(System.Windows.Point,System.Windows.Size)"> + <summary> + Determines whether the point is in bounds for the viewport size. + </summary> + <param name="point">The point.</param> + <param name="viewportSize">Size of the viewport.</param> + <returns></returns> + </member> + <member name="T:SciChart.Drawing.Utility.SutherlandHodgman"> + <summary> + Sutherland–Hodgman polygon clipping algorithm + </summary> + <remarks>https://en.wikipedia.org/wiki/Sutherland%E2%80%93Hodgman_algorithm</remarks> + </member> + <member name="M:SciChart.Drawing.Utility.SutherlandHodgman.GetIntersectedPolygon(System.Collections.Generic.IEnumerable{System.Windows.Point},System.Windows.Rect)"> + <summary> + This clips the subject polygon against the clip polygon (gets the intersection of the two polygons) + </summary> + <remarks> + Based on the psuedocode from: + http://en.wikipedia.org/wiki/Sutherland%E2%80%93Hodgman + </remarks> + <param name="subjectPoly">Can be concave or convex</param> + <param name="clipPoly">Must be convex</param> + <returns>The intersection of the two polygons (or null)</returns> + </member> + <member name="T:SciChart.Drawing.VisualXcceleratorRasterizer.ColorExtensions"> + <summary> + Provides methods to convert a <see cref="T:System.Windows.Media.Color" /> to a single 32-bit value and back, a single 32-bit value to a <see cref="T:System.Windows.Media.Color" /></summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.ColorExtensions.ToArgb(System.Windows.Media.Color)"> + <summary> + Converts a <see cref="T:System.Windows.Media.Color" /> to UInt32 returning all four color components A,R,G,B in a single 32-bit value + </summary> + <param name="color"></param> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.ColorExtensions.ToColor(System.UInt32)"> + <summary> + Converts a UInt32 ARGB Color to <see cref="T:System.Windows.Media.Color" /> struct + </summary> + <param name="color"></param> + <returns></returns> + </member> + <member name="T:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode"> + <summary> + Enumeration constants to define the usage of DirectX in SciChart + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode.None"> + <summary></summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode.AutoDetect"> + <summary> + Auto-detects DirectX mode for D3D Chart Rendering + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode.DirectX9c"> + <summary> + Force using DirectX9c for D3D Chart Rendering + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode.DirectX11"> + <summary> + Force using DirectX11 for D3D Chart Rendering + </summary> + </member> + <member name="T:SciChart.Drawing.VisualXcceleratorRasterizer.FullScreenAntiAliasingMode"> + <summary> + Enumeration constants to define the Full Screen AntiAliasing mode on the SciChartSurface and SciChart3DSurface + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.FullScreenAntiAliasingMode.None"> + <summary> + No Antialiasing + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.FullScreenAntiAliasingMode.MSAA2x"> + <summary> + Enables Multi-Sample AntiAliasing x2 + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.FullScreenAntiAliasingMode.MSAA4x"> + <summary> + Enables Multi-Sample AntiAliasing x4 + </summary> + </member> + <member name="F:SciChart.Drawing.VisualXcceleratorRasterizer.FullScreenAntiAliasingMode.MSAA8x"> + <summary> + Enables Multi-Sample AntiAliasing x8 + </summary> + </member> + <member name="T:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface"> + <summary> + Provides a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> implementation that uses The Visual Xccelerator Engine + </summary> + </member> + <member name="P:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.Pipeline"> + <summary> + The render pipeline of the <see cref="T:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface" /></summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.#ctor(SciChart.Drawing.VisualXcceleratorRasterizer.VxRenderSettings)"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.#ctor(System.Boolean)"> + <summary> + Internal access for testing. + </summary> + </member> + <member name="P:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.IsRemoteDesktop"> + <summary> + Determines if the code is being run under Remote Desktop. + </summary> + </member> + <member name="P:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.UseAlternativeFillSource"> + <summary> + When false (default), uses <see cref="T:System.Windows.Interop.D3DImage" /> for hardware accelerated texture sharing. + When true, uses software method to FillSource (avoiding use of D3DImage). This can help compatibility on certain systems + </summary> + <example> + To enable compatibility mode for SciChart3DSurface, set this property once, statically, in your application + <code> + void Foo() + { + Direct3D11RenderSurface.UseAlternativeFillSource = true; + } + </code></example> + </member> + <member name="P:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.ForceStallUntilGPUIsIdle"> + <summary> + When false (default), there is no waiting for the gpu to finish rendering, and the frame buffer is copied immediately + when true, we force the application to stall until the gpu is idle, this fixes flicker issues that can happen on older hardware + </summary> + <example> + To enable waiting for gpu to finish + <code> + void Foo() + { + Viewport3D.ForceStallUntilGPUIsIdle = true; + } + </code></example> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.GetRenderContext"> + <summary> + Returns a RenderContext valid for the current render pass. + </summary> + <returns></returns> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.FillSourceRDP"> + <summary> + Should be called to fill the WPF Image from the Direct3D Render Target at the end of drawing. + </summary> + <remarks> + Alternative method for filling a WriteableBitmap with DirectX content, avoiding D3DImage + (does not work over RDP due to bug in .NET4.0 implementation of D3DImage) + </remarks> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.FillSource"> + <summary> + Should be called to fill the WPF Image from the Direct3D Render Target at the end of drawing. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.RecreateSurface"> + <summary> + Recreates the elements required by the Viewport, called once at startup and when the surface is resized. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.DisposeUnmanagedResources"> + <summary> + Called when the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is disposed. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.RestartEngineWith(SciChart.Drawing.VisualXcceleratorRasterizer.DirectXMode,SciChart.Drawing.VisualXcceleratorRasterizer.FullScreenAntiAliasingMode,System.Boolean)"> + <summary> + Restarts 3D Engine with configuration flags. + </summary> + <param name="directXMode"></param> + <param name="antiAliasingMode"></param> + <param name="d3d11UseLowerFeaturesLevel"></param> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.AddUnmanagedDisposable(System.IDisposable)"> + <summary> + Called when the elements required by the Viewport have been recreated. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VisualXcceleratorRenderSurface.CleanupDisposables"> + <summary> + Called when the <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> is disposed. + </summary> + </member> + <member name="M:SciChart.Drawing.VisualXcceleratorRasterizer.VxPen.GetSmoothStrokeThickness(System.Boolean,System.Boolean,System.Int32)"> + <summary> + For smooth appearance of non-digital anti-aliased line, the stroke thickness should be greater than 1 pixel + </summary> + </member> + <member name="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface"> + <summary> + Provides a <see cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> implementation that uses a High-Quality software rasterizer, capable of rendering with sub-pixel accuracy. + The downside is, the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> uses a more accurate vector-based rendering engine which is slower than the <see cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> counterpart. + </summary> + <seealso cref="T:SciChart.Drawing.HighSpeedRasterizer.HighSpeedRenderSurface" /> + <seealso cref="T:SciChart.Drawing.Common.RenderSurfaceBase" /> + <seealso cref="T:SciChart.Drawing.Common.IRenderContext2D" /> + </member> + <member name="M:SciChart.Drawing.XamlRasterizer.XamlRenderSurface.#ctor"> + <summary> + Initializes a new instance of the <see cref="T:SciChart.Drawing.XamlRasterizer.XamlRenderSurface" /> class. + </summary> + </member> + <member name="M:SciChart.Drawing.XamlRasterizer.XamlRenderSurface.RecreateSurface"> + <summary> + Recreates the elements required by the Viewport, called once at startup and when the surface is resized + </summary> + </member> + <member name="M:SciChart.Drawing.XamlRasterizer.XamlRenderSurface.GetRenderContext"> + <summary> + When overridden in a derived class, returns a RenderContext valid for the current render pass + </summary> + <returns></returns> + </member> + <member name="T:System.Windows.Media.Imaging.WriteableBitmapExtensions"> + <summary> + Collection of draw extension methods for the Silverlight WriteableBitmap class. + </summary> + <summary> + Collection of extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of blit (copy) extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of interchange extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of filter / convolution extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of draw extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of draw spline extension methods for the WriteableBitmap class. + </summary> + <summary> + Collection of transformation extension methods for the WriteableBitmap class. + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillRectangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Func{System.Int32,System.Int32,System.Int32},System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + Draws a filled rectangle. + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="colorCb">The color.</param> + <param name="blendMode">The blend mode.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillEllipseCentered(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing filled ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="context">The BitmapContext.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + <param name="blendMode">The blend mode. BlendMode.Alpha is the default mode.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillPolygon(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Func{System.Int32,System.Int32,System.Int32},System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + Draws a filled polygon. Add the first point also at the end of the array if the line should be closed. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points of the polygon in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, ..., xn, yn).</param> + <param name="colorCb">The color for the fill.</param> + <param name="blendMode">The blend mode. Default is Alpha</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineBresenham(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a colored line by connecting two points using the Bresenham algorithm. + </summary> + <param name="context">The BitmapContext.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipseCentered(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="context">The BitmapContext.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + /// <param name="thickness">The thickness for the line.</param></member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawPixel(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Sets the color of the pixel. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="context">The BitmapContext.</param> + <param name="w">The width of the bitmap.</param> + <param name="h">The height of the bitmap.</param> + <param name="x1">The x coordinate (row).</param> + <param name="y1">The y coordinate (column).</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Clear(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Media.Color)"> + <summary> + Fills the whole WriteableBitmap with a color. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="color">The color used for filling.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Clear(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Fills the whole WriteableBitmap with an empty color (0). + </summary> + <param name="bmp">The WriteableBitmap.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Clone(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Clones the specified WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <returns>A copy of the WriteableBitmap.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.ForEach(System.Windows.Media.Imaging.WriteableBitmap,System.Func{System.Int32,System.Int32,System.Windows.Media.Color})"> + <summary> + Applies the given function to all the pixels of the bitmap in + order to set their color. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="func">The function to apply. With parameters x, y and a color as a result</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.ForEach(System.Windows.Media.Imaging.WriteableBitmap,System.Func{System.Int32,System.Int32,System.Windows.Media.Color,System.Windows.Media.Color})"> + <summary> + Applies the given function to all the pixels of the bitmap in + order to set their color. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="func">The function to apply. With parameters x, y, source color and a color as a result</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.GetPixeli(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32)"> + <summary> + Gets the color of the pixel at the x, y coordinate as integer. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate of the pixel.</param> + <param name="y">The y coordinate of the pixel.</param> + <returns>The color of the pixel at x, y.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.GetPixel(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32)"> + <summary> + Gets the color of the pixel at the x, y coordinate as a Color struct. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate of the pixel.</param> + <param name="y">The y coordinate of the pixel.</param> + <returns>The color of the pixel at x, y as a Color struct.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.GetBrightness(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32)"> + <summary> + Gets the brightness / luminance of the pixel at the x, y coordinate as byte. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate of the pixel.</param> + <param name="y">The y coordinate of the pixel.</param> + <returns>The brightness of the pixel at x, y.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixeli(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Byte,System.Byte,System.Byte)"> + <summary> + Sets the color of the pixel using a precalculated index (faster). + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="index">The coordinate index.</param> + <param name="r">The red value of the color.</param> + <param name="g">The green value of the color.</param> + <param name="b">The blue value of the color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixel(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Byte,System.Byte,System.Byte)"> + <summary> + Sets the color of the pixel. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate (row).</param> + <param name="y">The y coordinate (column).</param> + <param name="r">The red value of the color.</param> + <param name="g">The green value of the color.</param> + <param name="b">The blue value of the color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixeli(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Byte,System.Byte,System.Byte,System.Byte)"> + <summary> + Sets the color of the pixel including the alpha value and using a precalculated index (faster). + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="index">The coordinate index.</param> + <param name="a">The alpha value of the color.</param> + <param name="r">The red value of the color.</param> + <param name="g">The green value of the color.</param> + <param name="b">The blue value of the color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixel(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Byte,System.Byte,System.Byte,System.Byte)"> + <summary> + Sets the color of the pixel including the alpha value. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate (row).</param> + <param name="y">The y coordinate (column).</param> + <param name="a">The alpha value of the color.</param> + <param name="r">The red value of the color.</param> + <param name="g">The green value of the color.</param> + <param name="b">The blue value of the color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixeli(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Windows.Media.Color)"> + <summary> + Sets the color of the pixel using a precalculated index (faster). + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="index">The coordinate index.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixel(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Sets the color of the pixel. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate (row).</param> + <param name="y">The y coordinate (column).</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixeli(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Byte,System.Windows.Media.Color)"> + <summary> + Sets the color of the pixel using an extra alpha value and a precalculated index (faster). + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="index">The coordinate index.</param> + <param name="a">The alpha value of the color.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixel(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Byte,System.Windows.Media.Color)"> + <summary> + Sets the color of the pixel using an extra alpha value. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate (row).</param> + <param name="y">The y coordinate (column).</param> + <param name="a">The alpha value of the color.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixeli(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32)"> + <summary> + Sets the color of the pixel using a precalculated index (faster). + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="index">The coordinate index.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.SetPixel(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32)"> + <summary> + Sets the color of the pixel. + For best performance this method should not be used in iterative real-time scenarios. Implement the code directly inside a loop. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate (row).</param> + <param name="y">The y coordinate (column).</param> + <param name="color">The color.</param> + </member> + <member name="T:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode"> + <summary> + The blending mode. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Alpha"> + <summary> + Alpha blendiing uses the alpha channel to combine the source and destination. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Additive"> + <summary> + Additive blending adds the colors of the source and the destination. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Subtractive"> + <summary> + Subtractive blending subtracts the source color from the destination. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Mask"> + <summary> + Uses the source color as a mask. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Multiply"> + <summary> + Multiplies the source color with the destination color. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.ColorKeying"> + <summary> + Ignores the specified Color + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.None"> + <summary> + No blending just copies the pixels from the source. + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Blit(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Rect,System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Rect,System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + Copies (blits) the pixels from the WriteableBitmap source to the destination WriteableBitmap (this). + </summary> + <param name="bmp">The destination WriteableBitmap.</param> + <param name="destRect">The rectangle that defines the destination region.</param> + <param name="source">The source WriteableBitmap.</param> + <param name="sourceRect">The rectangle that will be copied from the source to the destination.</param> + <param name="blendMode">The blending mode <see cref="T:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode" />.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Blit(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Rect,System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Rect)"> + <summary> + Copies (blits) the pixels from the WriteableBitmap source to the destination WriteableBitmap (this). + </summary> + <param name="bmp">The destination WriteableBitmap.</param> + <param name="destRect">The rectangle that defines the destination region.</param> + <param name="source">The source WriteableBitmap.</param> + <param name="sourceRect">The rectangle that will be copied from the source to the destination.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Blit(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Point,System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Rect,System.Windows.Media.Color,System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + Copies (blits) the pixels from the WriteableBitmap source to the destination WriteableBitmap (this). + </summary> + <param name="bmp">The destination WriteableBitmap.</param> + <param name="destPosition">The destination position in the destination bitmap.</param> + <param name="source">The source WriteableBitmap.</param> + <param name="sourceRect">The rectangle that will be copied from the source to the destination.</param> + <param name="color">If not Colors.White, will tint the source image. A partially transparent color and the image will be drawn partially transparent.</param> + <param name="blendMode">The blending mode <see cref="T:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode" />.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.ToByteArray(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32)"> + <summary> + Copies the Pixels from the WriteableBitmap into a ARGB byte array starting at a specific Pixels index. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="offset">The starting Pixels index.</param> + <param name="count">The number of Pixels to copy, -1 for all</param> + <returns>The color buffer as byte ARGB values.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.ToByteArray(System.Windows.Media.Imaging.WriteableBitmap,System.Int32)"> + <summary> + Copies the Pixels from the WriteableBitmap into a ARGB byte array. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="count">The number of pixels to copy.</param> + <returns>The color buffer as byte ARGB values.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.ToByteArray(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Copies all the Pixels from the WriteableBitmap into a ARGB byte array. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <returns>The color buffer as byte ARGB values.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FromByteArray(System.Windows.Media.Imaging.WriteableBitmap,System.Byte[],System.Int32,System.Int32)"> + <summary> + Copies color information from an ARGB byte array into this WriteableBitmap starting at a specific buffer index. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="offset">The starting index in the buffer.</param> + <param name="count">The number of bytes to copy from the buffer.</param> + <param name="buffer">The color buffer as byte ARGB values.</param> + <returns>The WriteableBitmap that was passed as parameter.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FromByteArray(System.Windows.Media.Imaging.WriteableBitmap,System.Byte[],System.Int32)"> + <summary> + Copies color information from an ARGB byte array into this WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="count">The number of bytes to copy from the buffer.</param> + <param name="buffer">The color buffer as byte ARGB values.</param> + <returns>The WriteableBitmap that was passed as parameter.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FromByteArray(System.Windows.Media.Imaging.WriteableBitmap,System.Byte[])"> + <summary> + Copies all the color information from an ARGB byte array into this WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="buffer">The color buffer as byte ARGB values.</param> + <returns>The WriteableBitmap that was passed as parameter.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.WriteTga(System.Windows.Media.Imaging.WriteableBitmap,System.IO.Stream)"> + <summary> + Writes the WriteableBitmap as a TGA image to a stream. + Used with permission from Nokola: http://nokola.com/blog/post/2010/01/21/Quick-and-Dirty-Output-of-WriteableBitmap-as-TGA-Image.aspx + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="destination">The destination stream.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FromResource(System.Windows.Media.Imaging.WriteableBitmap,System.String)"> + <summary> + Loads an image from the applications resource file and returns a new WriteableBitmap. The passed WriteableBitmap is not used. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="relativePath">Only the relative path to the resource file. The assembly name is retrieved automatically.</param> + <returns>A new WriteableBitmap containing the pixel data.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FromContent(System.Windows.Media.Imaging.WriteableBitmap,System.String)"> + <summary> + Loads an image from the applications content and returns a new WriteableBitmap. The passed WriteableBitmap is not used. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="relativePath">Only the relative path to the content file.</param> + <returns>A new WriteableBitmap containing the pixel data.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FromStream(System.Windows.Media.Imaging.WriteableBitmap,System.IO.Stream)"> + <summary> + Loads the data from an image stream and returns a new WriteableBitmap. The passed WriteableBitmap is not used. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="stream">The stream with the image data.</param> + <returns>A new WriteableBitmap containing the pixel data.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillRectangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a filled rectangle using <see cref="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Alpha" />. + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillRectangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a filled rectangle using <see cref="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode.Alpha" />. + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillRectangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + Draws a filled rectangle with the specified <see cref="T:System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode" />. + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color.</param> + <param name="blendMode">The blend mode.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillEllipse(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing filled ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillEllipse(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing filled ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillEllipseCentered(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing filled ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillEllipseCentered(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing filled ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillEllipseCentered(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing filled ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + <param name="blendMode">The blend mode.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillPolygon(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Windows.Media.Color)"> + <summary> + Draws a filled polygon. Add the first point also at the end of the array if the line should be closed. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points of the polygon in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, ..., xn, yn).</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillPolygon(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Int32)"> + <summary> + Draws a filled polygon. Add the first point also at the end of the array if the line should be closed. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points of the polygon in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, ..., xn, yn).</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillPolygon(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.BlendMode)"> + <summary> + Draws a filled polygon. Add the first point also at the end of the array if the line should be closed. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points of the polygon in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, ..., xn, yn).</param> + <param name="color">The color for the line.</param> + <param name="blendMode">The blend mode. Default is Alpha</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillQuad(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a filled quad. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="x4">The x-coordinate of the 4th point.</param> + <param name="y4">The y-coordinate of the 4th point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillQuad(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a filled quad. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="x4">The x-coordinate of the 4th point.</param> + <param name="y4">The y-coordinate of the 4th point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillTriangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a filled triangle. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillTriangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a filled triangle. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillBeziers(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Windows.Media.Color)"> + <summary> + Draws a series of filled, cubic Bezier splines each defined by start, end and two control points. + The ending point of the previous curve is used as starting point for the next. + Therfore the inital curve needs four points and the subsequent 3 (2 control and 1 end point). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, cx1, cy1, cx2, cy2, x2, y2, cx3, cx4 ..., xn, yn).</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillBeziers(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Int32)"> + <summary> + Draws a series of filled, cubic Bezier splines each defined by start, end and two control points. + The ending point of the previous curve is used as starting point for the next. + Therfore the inital curve needs four points and the subsequent 3 (2 control and 1 end point). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, cx1, cy1, cx2, cy2, x2, y2, cx3, cx4 ..., xn, yn).</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillCurve(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Windows.Media.Color)"> + <summary> + Draws a filled Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillCurve(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Int32)"> + <summary> + Draws a filled Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillCurveClosed(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Windows.Media.Color)"> + <summary> + Draws a filled, closed Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.FillCurveClosed(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Int32)"> + <summary> + Draws a filled, closed Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.KernelGaussianBlur5x5"> + <summary> + Gaussian blur kernel with the size 5x5 + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.KernelGaussianBlur3x3"> + <summary> + Gaussian blur kernel with the size 3x3 + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.KernelSharpen3x3"> + <summary> + Sharpen kernel with the size 3x3 + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Convolute(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[0:,0:])"> + <summary> + Creates a new filtered WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="kernel">The kernel used for convolution.</param> + <returns>A new WriteableBitmap that is a filtered version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Convolute(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[0:,0:],System.Int32,System.Int32)"> + <summary> + Creates a new filtered WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="kernel">The kernel used for convolution.</param> + <param name="kernelFactorSum">The factor used for the kernel summing.</param> + <param name="kernelOffsetSum">The offset used for the kernel summing.</param> + <returns>A new WriteableBitmap that is a filtered version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Invert(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Creates a new inverted WriteableBitmap and returns it. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <returns>The new inverted WriteableBitmap.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.AlphaBlend(System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Alpha blends 2 premultiplied colors with each other + </summary> + <param name="sa">Source alpha color component</param> + <param name="sr">Premultiplied source red color component</param> + <param name="sg">Premultiplied source green color component</param> + <param name="sb">Premultiplied source blue color component</param> + <param name="destPixel">Premultiplied destination color</param> + <returns>Premultiplied blended color value</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawWuLine(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int16,System.Int16,System.Int16,System.Int16,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws an anti-aliased, alpha blended, colored line by connecting two points using Wu's antialiasing algorithm + Uses the pixels array and the width directly for best performance. + </summary> + <param name="context">An array containing the pixels as int RGBA value.</param> + <param name="pixelWidth">The width of one scanline in the pixels array.</param> + <param name="pixelHeight">The height of the bitmap.</param> + <param name="X0">The x0.</param> + <param name="Y0">The y0.</param> + <param name="X1">The x1.</param> + <param name="Y1">The y1.</param> + <param name="sa">Alpha color component</param> + <param name="sr">Premultiplied red color component</param> + <param name="sg">Premultiplied green color component</param> + <param name="sb">Premultiplied blue color component</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineBresenham(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a colored line by connecting two points using the Bresenham algorithm. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineBresenham(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a colored line by connecting two points using the Bresenham algorithm. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineDDA(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a colored line by connecting two points using a DDA algorithm (Digital Differential Analyzer). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineDDA(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a colored line by connecting two points using a DDA algorithm (Digital Differential Analyzer). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLine(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a colored line by connecting two points using an optimized DDA. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLine(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a colored line by connecting two points using an optimized DDA. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLine(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a colored line by connecting two points using an optimized DDA. + Uses the pixels array and the width directly for best performance. + </summary> + <param name="context">The context containing the pixels as int RGBA value.</param> + <param name="pixelWidth">The width of one scanline in the pixels array.</param> + <param name="pixelHeight">The height of the bitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineAa(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws an anti-aliased line, using an optimized version of Gupta-Sproull algorithm + From http://nokola.com/blog/post/2010/10/14/Anti-aliased-Lines-And-Optimizing-Code-for-Windows-Phone-7e28093First-Look.aspx + <param name="bmp">The WriteableBitmap.</param><param name="x1">The x-coordinate of the start point.</param><param name="y1">The y-coordinate of the start point.</param><param name="x2">The x-coordinate of the end point.</param><param name="y2">The y-coordinate of the end point.</param><param name="color">The color for the line.</param></summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineAa(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws an anti-aliased line, using an optimized version of Gupta-Sproull algorithm + From http://nokola.com/blog/post/2010/10/14/Anti-aliased-Lines-And-Optimizing-Code-for-Windows-Phone-7e28093First-Look.aspx + <param name="bmp">The WriteableBitmap.</param><param name="x1">The x-coordinate of the start point.</param><param name="y1">The y-coordinate of the start point.</param><param name="x2">The x-coordinate of the end point.</param><param name="y2">The y-coordinate of the end point.</param><param name="color">The color for the line.</param></summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawLineAa(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Boolean)"> + <summary> + Draws an anti-aliased line, using an optimized version of Gupta-Sproull algorithm + From http://nokola.com/blog/post/2010/10/14/Anti-aliased-Lines-And-Optimizing-Code-for-Windows-Phone-7e28093First-Look.aspx + <param name="context">The context containing the pixels as int RGBA value.</param><param name="pixelWidth">The width of one scanline in the pixels array.</param><param name="pixelHeight">The height of the bitmap.</param><param name="x1">The x-coordinate of the start point.</param><param name="y1">The y-coordinate of the start point.</param><param name="x2">The x-coordinate of the end point.</param><param name="y2">The y-coordinate of the end point.</param><param name="color">The color for the line.</param></summary> + <param name="context">The context.</param> + <param name="pixelWidth">Width of the pixel.</param> + <param name="pixelHeight">Height of the pixel.</param> + <param name="x1">The x1.</param> + <param name="y1">The y1.</param> + <param name="x2">The x2.</param> + <param name="y2">The y2.</param> + <param name="color">The color.</param> + <param name="skipFirstPixel">if set to <c>true</c> skip first pixel.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawPolyline(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Windows.Media.Color)"> + <summary> + Draws a polyline. Add the first point also at the end of the array if the line should be closed. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points of the polyline in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, ..., xn, yn).</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawPolyline(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Int32)"> + <summary> + Draws a polyline. Add the first point also at the end of the array if the line should be closed. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points of the polyline in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, ..., xn, yn).</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawTriangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a triangle. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawTriangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a triangle. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawQuad(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a quad. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="x4">The x-coordinate of the 4th point.</param> + <param name="y4">The y-coordinate of the 4th point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawQuad(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a quad. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the 1st point.</param> + <param name="y1">The y-coordinate of the 1st point.</param> + <param name="x2">The x-coordinate of the 2nd point.</param> + <param name="y2">The y-coordinate of the 2nd point.</param> + <param name="x3">The x-coordinate of the 3rd point.</param> + <param name="y3">The y-coordinate of the 3rd point.</param> + <param name="x4">The x-coordinate of the 4th point.</param> + <param name="y4">The y-coordinate of the 4th point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawRectangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a rectangle. + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawRectangle(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a rectangle. + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipse(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipse(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipseCentered(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipseCentered(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipse(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color for the line.</param> + <param name="thickness">The thickness for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipse(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + x2 has to be greater than x1 and y2 has to be greater than y1. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the bounding rectangle's left side.</param> + <param name="y1">The y-coordinate of the bounding rectangle's top side.</param> + <param name="x2">The x-coordinate of the bounding rectangle's right side.</param> + <param name="y2">The y-coordinate of the bounding rectangle's bottom side.</param> + <param name="color">The color for the line.</param> + <param name="thickness">The thickness for the line.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawEllipseCentered(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + A Fast Bresenham Type Algorithm For Drawing Ellipses http://homepage.smc.edu/kennedy_john/belipse.pdf + Uses a different parameter representation than DrawEllipse(). + </summary> + <param name="bmp">The BitmapContext.</param> + <param name="xc">The x-coordinate of the ellipses center.</param> + <param name="yc">The y-coordinate of the ellipses center.</param> + <param name="xr">The radius of the ellipse in x-direction.</param> + <param name="yr">The radius of the ellipse in y-direction.</param> + <param name="color">The color for the line.</param> + /// <param name="thickness">The thickness for the line.</param></member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawBezier(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Color)"> + <summary> + Draws a cubic Beziér spline defined by start, end and two control points. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="cx1">The x-coordinate of the 1st control point.</param> + <param name="cy1">The y-coordinate of the 1st control point.</param> + <param name="cx2">The x-coordinate of the 2nd control point.</param> + <param name="cy2">The y-coordinate of the 2nd control point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawBezier(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Draws a cubic Beziér spline defined by start, end and two control points. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x1">The x-coordinate of the start point.</param> + <param name="y1">The y-coordinate of the start point.</param> + <param name="cx1">The x-coordinate of the 1st control point.</param> + <param name="cy1">The y-coordinate of the 1st control point.</param> + <param name="cx2">The x-coordinate of the 2nd control point.</param> + <param name="cy2">The y-coordinate of the 2nd control point.</param> + <param name="x2">The x-coordinate of the end point.</param> + <param name="y2">The y-coordinate of the end point.</param> + <param name="color">The color.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawBeziers(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Windows.Media.Color)"> + <summary> + Draws a series of cubic Beziér splines each defined by start, end and two control points. + The ending point of the previous curve is used as starting point for the next. + Therfore the inital curve needs four points and the subsequent 3 (2 control and 1 end point). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, cx1, cy1, cx2, cy2, x2, y2, cx3, cx4 ..., xn, yn).</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawBeziers(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Int32)"> + <summary> + Draws a series of cubic Beziér splines each defined by start, end and two control points. + The ending point of the previous curve is used as starting point for the next. + Therfore the inital curve needs four points and the subsequent 3 (2 control and 1 end point). + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, cx1, cy1, cx2, cy2, x2, y2, cx3, cx4 ..., xn, yn).</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawCurve(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Windows.Media.Color)"> + <summary> + Draws a Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawCurve(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Int32)"> + <summary> + Draws a Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawCurveClosed(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Windows.Media.Color)"> + <summary> + Draws a closed Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.DrawCurveClosed(System.Windows.Media.Imaging.WriteableBitmap,System.Int32[],System.Single,System.Int32)"> + <summary> + Draws a closed Cardinal spline (cubic) defined by a point collection. + The cardinal spline passes through each point in the collection. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="points">The points for the curve in x and y pairs, therefore the array is interpreted as (x1, y1, x2, y2, x3, y3, x4, y4, x1, x2 ..., xn, yn).</param> + <param name="tension">The tension of the curve defines the shape. Usually between 0 and 1. 0 would be a straight line.</param> + <param name="color">The color for the spline.</param> + </member> + <member name="T:System.Windows.Media.Imaging.WriteableBitmapExtensions.Interpolation"> + <summary> + The interpolation method. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.Interpolation.NearestNeighbor"> + <summary> + The nearest neighbor algorithm simply selects the color of the nearest pixel. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.Interpolation.Bilinear"> + <summary> + Linear interpolation in 2D using the average of 3 neighboring pixels. + </summary> + </member> + <member name="T:System.Windows.Media.Imaging.WriteableBitmapExtensions.FlipMode"> + <summary> + The mode for flipping. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.FlipMode.Vertical"> + <summary> + Flips the image vertical (around the center of the y-axis). + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.WriteableBitmapExtensions.FlipMode.Horizontal"> + <summary> + Flips the image horizontal (around the center of the x-axis). + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Crop(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Int32,System.Int32)"> + <summary> + Creates a new cropped WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="x">The x coordinate of the rectangle that defines the crop region.</param> + <param name="y">The y coordinate of the rectangle that defines the crop region.</param> + <param name="width">The width of the rectangle that defines the crop region.</param> + <param name="height">The height of the rectangle that defines the crop region.</param> + <returns>A new WriteableBitmap that is a cropped version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Crop(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Rect)"> + <summary> + Creates a new cropped WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="region">The rectangle that defines the crop region.</param> + <returns>A new WriteableBitmap that is a cropped version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Resize(System.Windows.Media.Imaging.WriteableBitmap,System.Int32,System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.Interpolation)"> + <summary> + Creates a new resized WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="width">The new desired width.</param> + <param name="height">The new desired height.</param> + <param name="interpolation">The interpolation method that should be used.</param> + <returns>A new WriteableBitmap that is a resized version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Resize(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.Interpolation)"> + <summary> + Creates a new resized bitmap. + </summary> + <param name="srcContext">The source context.</param> + <param name="widthSource">The width of the source pixels.</param> + <param name="heightSource">The height of the source pixels.</param> + <param name="width">The new desired width.</param> + <param name="height">The new desired height.</param> + <param name="interpolation">The interpolation method that should be used.</param> + <returns>A new bitmap that is a resized version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Resize(System.Int32*,System.Int32,System.Int32,System.Int32,System.Int32,System.Windows.Media.Imaging.WriteableBitmapExtensions.Interpolation)"> + <summary> + Creates a new resized bitmap. + </summary> + <param name="pixels">The source pixels.</param> + <param name="widthSource">The width of the source pixels.</param> + <param name="heightSource">The height of the source pixels.</param> + <param name="width">The new desired width.</param> + <param name="height">The new desired height.</param> + <param name="interpolation">The interpolation method that should be used.</param> + <returns>A new bitmap that is a resized version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Rotate(System.Windows.Media.Imaging.WriteableBitmap,System.Int32)"> + <summary> + Rotates the bitmap in 90° steps clockwise and returns a new rotated WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="angle">The angle in degress the bitmap should be rotated in 90° steps clockwise.</param> + <returns>A new WriteableBitmap that is a rotated version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.RotateFree(System.Windows.Media.Imaging.WriteableBitmap,System.Double,System.Boolean)"> + <summary> + Rotates the bitmap in any degree returns a new rotated WriteableBitmap. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="angle">Arbitrary angle in 360 Degrees (positive = clockwise).</param> + <param name="crop">if true: keep the size, false: adjust canvas to new size</param> + <returns>A new WriteableBitmap that is a rotated version of the input.</returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapExtensions.Flip(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Media.Imaging.WriteableBitmapExtensions.FlipMode)"> + <summary> + Flips (reflects the image) eiter vertical or horizontal. + </summary> + <param name="bmp">The WriteableBitmap.</param> + <param name="flipMode">The flip mode.</param> + <returns>A new WriteableBitmap that is a flipped version of the input.</returns> + </member> + <member name="T:System.Windows.Media.Imaging.ReadWriteMode"> + <summary> + Read Write Mode for the BitmapContext. + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.ReadWriteMode.ReadOnly"> + <summary> + On Dispose of a BitmapContext, do not Invalidate + </summary> + </member> + <member name="F:System.Windows.Media.Imaging.ReadWriteMode.ReadWrite"> + <summary> + On Dispose of a BitmapContext, invalidate the bitmap + </summary> + </member> + <member name="T:System.Windows.Media.Imaging.BitmapContext"> + <summary> + A disposable cross-platform wrapper around a WriteableBitmap, allowing a common API for Silverlight + WPF with locking + unlocking if necessary + </summary> + <remarks>Attempting to put as many preprocessor hacks in this file, to keep the rest of the codebase relatively clean</remarks> + </member> + <member name="P:System.Windows.Media.Imaging.BitmapContext.WriteableBitmap"> + <summary> + The Bitmap + </summary> + </member> + <member name="P:System.Windows.Media.Imaging.BitmapContext.Width"> + <summary> + Width of the bitmap + </summary> + </member> + <member name="P:System.Windows.Media.Imaging.BitmapContext.Height"> + <summary> + Height of the bitmap + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.#ctor(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Creates an instance of a BitmapContext, with default mode = ReadWrite + </summary> + <param name="writeableBitmap"></param> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.#ctor(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Media.Imaging.ReadWriteMode)"> + <summary> + Creates an instance of a BitmapContext, with specified ReadWriteMode + </summary> + <param name="writeableBitmap"></param> + <param name="mode"></param> + </member> + <member name="P:System.Windows.Media.Imaging.BitmapContext.Pixels"> + <summary> + The pixels as ARGB integer values, where each channel is 8 bit. + </summary> + </member> + <member name="P:System.Windows.Media.Imaging.BitmapContext.Length"> + <summary> + The number of pixels. + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.BlockCopy(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32)"> + <summary> + Performs a Copy operation from source Bto destination BitmapContext + </summary> + <remarks>Equivalent to calling Buffer.BlockCopy in Silverlight, or native memcpy in WPF</remarks> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.BlockCopy(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Byte[],System.Int32,System.Int32)"> + <summary> + Performs a Copy operation from source BitmapContext to destination Array + </summary> + <remarks>Equivalent to calling Buffer.BlockCopy in Silverlight, or native memcpy in WPF</remarks> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.BlockCopy(System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32[],System.Int32,System.Int32)"> + <summary> + Performs a Copy operation from source BitmapContext to destination Array + </summary> + <remarks>Equivalent to calling Buffer.BlockCopy in Silverlight, or native memcpy in WPF</remarks> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.BlockCopy(System.Int32[],System.Int32,System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32)"> + <summary> + Performs a Copy operation from source Array to destination BitmapContext + </summary> + <remarks>Equivalent to calling Buffer.BlockCopy in Silverlight, or native memcpy in WPF</remarks> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.BlockCopy(System.Byte[],System.Int32,System.Windows.Media.Imaging.BitmapContext,System.Int32,System.Int32)"> + <summary> + Performs a Copy operation from source Array to destination BitmapContext + </summary> + <remarks>Equivalent to calling Buffer.BlockCopy in Silverlight, or native memcpy in WPF</remarks> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.Clear"> + <summary> + Clears the BitmapContext, filling the underlying bitmap with zeros + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapContext.Dispose"> + <summary> + Disposes the BitmapContext, unlocking it and invalidating if WPF + </summary> + </member> + <member name="T:System.Windows.Media.Imaging.BitmapFactory"> + <summary> + Cross-platform factory for WriteableBitmaps + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapFactory.New(System.Int32,System.Int32)"> + <summary> + Creates a new WriteableBitmap of the specified width and height + </summary> + <remarks>For WPF the default DPI is 96x96 and PixelFormat is Pbgra32</remarks> + <param name="pixelWidth"></param> + <param name="pixelHeight"></param> + <returns></returns> + </member> + <member name="M:System.Windows.Media.Imaging.BitmapFactory.ConvertToPbgra32Format(System.Windows.Media.Imaging.BitmapSource)"> + <summary> + Converts the input BitmapSource to the Pbgra32 format WriteableBitmap which is internally used by the WriteableBitmapEx. + </summary> + <param name="source">The source bitmap.</param> + <returns></returns> + </member> + <member name="T:System.Windows.Media.Imaging.WriteableBitmapContextExtensions"> + <summary> + Provides the WriteableBitmap context pixel data + </summary> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapContextExtensions.GetBitmapContext(System.Windows.Media.Imaging.WriteableBitmap)"> + <summary> + Gets a BitmapContext within which to perform nested IO operations on the bitmap + </summary> + <remarks>For WPF the BitmapContext will lock the bitmap. Call Dispose on the context to unlock</remarks> + <param name="bmp"></param> + <returns></returns> + </member> + <member name="M:System.Windows.Media.Imaging.WriteableBitmapContextExtensions.GetBitmapContext(System.Windows.Media.Imaging.WriteableBitmap,System.Windows.Media.Imaging.ReadWriteMode)"> + <summary> + Gets a BitmapContext within which to perform nested IO operations on the bitmap + </summary> + <remarks>For WPF the BitmapContext will lock the bitmap. Call Dispose on the context to unlock</remarks> + <param name="bmp">The bitmap.</param> + <param name="mode">The ReadWriteMode. If set to ReadOnly, the bitmap will not be invalidated on dispose of the context, else it will</param> + <returns></returns> + </member> + <member name="M:MatterHackers.VectorMath.Vector4.op_Explicit(MatterHackers.VectorMath.Vector4)~System.Double*"> + <summary> + Returns a pointer to the first element of the specified instance. + </summary> + <param name="v">The instance.</param> + <returns>A pointer to the first element of v.</returns> + </member> + <member name="M:MatterHackers.VectorMath.Vector4.op_Explicit(MatterHackers.VectorMath.Vector4)~System.IntPtr"> + <summary> + Returns a pointer to the first element of the specified instance. + </summary> + <param name="v">The instance.</param> + <returns>A pointer to the first element of v.</returns> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Examples.ExternalDependencies.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Examples.ExternalDependencies.dll Binary files differnew file mode 100644 index 000000000..f7a69b391 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Examples.ExternalDependencies.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Examples.ExternalDependencies.xml b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Examples.ExternalDependencies.xml new file mode 100644 index 000000000..bf52b797f --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SciChart.Examples.ExternalDependencies.xml @@ -0,0 +1,388 @@ +<?xml version="1.0"?> +<doc> + <assembly> + <name>SciChart.Examples.ExternalDependencies</name> + </assembly> + <members> + <member name="T:SciChart.Examples.ExternalDependencies.Behaviors.EventToCommandBehavior"> + <summary> + Behavior that will connect an UI event to a viewmodel Command, + allowing the event arguments to be passed as the CommandParameter. + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Behaviors.EventToCommandBehavior.AttachHandler(System.String)"> + <summary> + Attaches the handler to the event + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Behaviors.EventToCommandBehavior.ExecuteCommand(System.Object,System.EventArgs)"> + <summary> + Executes the Command + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.BoolToValueConverter"> + <summary> + A ValueConverter which can convert Boolean to any value, e.g. Boolean to Visibility, Boolean to Margin + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Common.BoolToValueConverter.TrueValue"> + <summary> + The value to convert to if the input boolean is true + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Common.BoolToValueConverter.FalseValue"> + <summary> + The value to convert to if the input boolean is false + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Common.BoolToValueConverter.TrueSLValue"> + <summary> + The value to convert to if the input boolean is true and in Silverlight + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.BoolToValueConverter.Convert(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the source data before passing it to the target for display in the UI. + </summary> + <param name="value">The source data being passed to the target.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the target dependency property.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the target dependency property. + </returns> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.BoolToValueConverter.ConvertBack(System.Object,System.Type,System.Object,System.Globalization.CultureInfo)"> + <summary> + Modifies the target data before passing it to the source object. This method is called only in <see cref="F:System.Windows.Data.BindingMode.TwoWay" /> bindings. + </summary> + <param name="value">The target data being passed to the source.</param> + <param name="targetType">The <see cref="T:System.Type" /> of data expected by the source object.</param> + <param name="parameter">An optional parameter to be used in the converter logic.</param> + <param name="culture">The culture of the conversion.</param> + <returns> + The value to be passed to the source object. + </returns> + <exception cref="T:System.NotImplementedException"></exception> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.GridSplitterCollapseMode"> + <summary> + Specifies different collapse modes of a ExtendedGridSplitter. + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Common.GridSplitterCollapseMode.None"> + <summary> + The ExtendedGridSplitter cannot be collapsed or expanded. + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Common.GridSplitterCollapseMode.Next"> + <summary> + The column (or row) to the right (or below) the + splitter's column, will be collapsed. + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Common.GridSplitterCollapseMode.Previous"> + <summary> + The column (or row) to the left (or above) the + splitter's column, will be collapsed. + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter"> + <summary> + An updated version of the standard ExtendedGridSplitter control that includes a centered handle + which allows complete collapsing and expanding of the appropriate grid column or row. + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.OnIsCollapsedChanged(System.Boolean)"> + <summary> + Handles the property change event of the IsCollapsed property. + </summary> + <param name="isCollapsed">The new value for the IsCollapsed property.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.OnCollapseModeChanged(SciChart.Examples.ExternalDependencies.Common.GridSplitterCollapseMode)"> + <summary> + Handles the property change event of the CollapseMode property. + </summary> + <param name="collapseMode">The new value for the CollapseMode property.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.Collapse"> + <summary> + Collapses the target ColumnDefinition or RowDefinition. + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.Expand"> + <summary> + Expands the target ColumnDefinition or RowDefinition. + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.GetCollapseDirection"> + <summary> + Determine the collapse direction based on the horizontal and vertical alignments + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.OnCollapsed(System.EventArgs)"> + <summary> + Raises the Collapsed event. + </summary> + <param name="e">Contains event arguments.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.OnExpanded(System.EventArgs)"> + <summary> + Raises the Expanded event. + </summary> + <param name="e">Contains event arguments.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.GridSplitterButton_Checked(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Handles the Checked event of either the Vertical or Horizontal + GridSplitterHandle ToggleButton. + </summary> + <param name="sender">An instance of the ToggleButton that fired the event.</param> + <param name="e">Contains event arguments for the routed event that fired.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.GridSplitterButton_Unchecked(System.Object,System.Windows.RoutedEventArgs)"> + <summary> + Handles the Unchecked event of either the Vertical or Horizontal + GridSplitterHandle ToggleButton. + </summary> + <param name="sender">An instance of the ToggleButton that fired the event.</param> + <param name="e">Contains event arguments for the routed event that fired.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.AnimateCollapse(System.Object)"> + <summary> + Uses DoubleAnimation and a StoryBoard to animated the collapsing + of the specificed ColumnDefinition or RowDefinition. + </summary> + <param name="definition">The RowDefinition or ColumnDefintition that will be collapsed.</param> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.AnimateExpand(System.Object)"> + <summary> + Uses DoubleAnimation and a StoryBoard to animate the expansion + of the specificed ColumnDefinition or RowDefinition. + </summary> + <param name="definition">The RowDefinition or ColumnDefintition that will be expanded.</param> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.CollapsableGridSplitter.GridCollapseDirection"> + <summary> + An enumeration that specifies the direction the ExtendedGridSplitter will + be collapased (Rows or Columns). + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.ExampleHelpers"> + <summary> + A helper class which is used to invoke commands on the Loaded and Unloaded events of a FrameworkElement + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.FrameworkVisibilityManager"> + <summary> + Used to show or hide UIElements based on framework (WPF, Silverlight) + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.IPowerManager.GetPlans"> + <returns> + All supported power plans. + </returns> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.IPowerManager.OpenControlPanel"> + <summary> + Opens Power Options section of the Control Panel. + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Common.PowerManager.MaximumPerformance"> + <summary> + Indicates that almost no power savings measures will be used. + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Common.PowerManager.Balanced"> + <summary> + Indicates that fairly aggressive power savings measures will be used. + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Common.PowerManager.PowerSourceOptimized"> + <summary> + Indicates that very aggressive power savings measures will be used to help + stretch battery life. + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.PowerManager.GetPlans"> + <returns> + All supported power plans. + </returns> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Common.PowerManager.OpenControlPanel"> + <summary> + Opens Power Options section of the Control Panel. + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Common.SciChartPolarInteractionToolbar"> + <summary> + A toolbar used in examples to simplify zoom, oom extents, rollover, cursor etc... for the polar charts. This also helps us with testing ;) + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Controls.CoverFlow.PlaneProjector"> + <summary> + PlaneProjector - dead simple interactive 3D in WPF. Read more at + http://blogs.msdn.com/greg_schechter/archive/2007/10/26/enter-the-planerator-dead-simple-3d-in-wpf-with-a-stupid-name.aspx + + Greg Schechter - Fall 2007 + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Controls.CoverFlow.PlaneProjector.LayoutInvalidationCatcher"> + <summary> + Wrap this around a class that we want to catch the measure and arrange + processes occuring on, and propagate to the parent PlaneProjector, if any. + Do this because layout invalidations don't flow up out of a + Viewport2DVisual3D object. + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Controls.ExceptionView.ExceptionView"> + <summary> + Interaction logic for ExceptionView.xaml + </summary> + <summary> + ExceptionView + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Controls.ExceptionView.ExceptionView.InitializeComponent"> + <summary> + InitializeComponent + </summary> + </member> + <member name="F:SciChart.Examples.ExternalDependencies.Controls.Toolbar2D.InvokeSnapToSeriesCommandAction.SnapToSelectedSeriesCommandProperty"> + <summary> + Defines the SnapToSelectedSeriesCommand property + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Controls.Toolbar2D.MyCustomAnnotation"> + <summary> + MyCustomAnnotation + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Controls.Toolbar2D.MyCustomAnnotation.InitializeComponent"> + <summary> + InitializeComponent + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Controls.Toolbar2D.SciChartInteractionToolbar"> + <summary> + A toolbar used in examples to simplify zoom, pan, zoom extents, rollover, cursor etc... This also helps us with + testing ;-) + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Data.DoubleSeries"> + <summary> + A data-structure to contain a list of X,Y double-precision points + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Data.FFT2"> + Performs an in-place complex FFT. + + Released under the MIT License + + Copyright (c) 2010 Gerald T. Beauregard + + Permission is hereby granted, free of charge, to any person obtaining a copy + of this software and associated documentation files (the "Software"), to + deal in the Software without restriction, including without limitation the + rights to use, copy, modify, merge, publish, distribute, sublicense, and/or + sell copies of the Software, and to permit persons to whom the Software is + furnished to do so, subject to the following conditions: + + The above copyright notice and this permission notice shall be included in + all copies or substantial portions of the Software. + + THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS + IN THE SOFTWARE. + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.FFT2.#ctor"></member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.FFT2.init(System.UInt32)"> + Initialize class to perform FFT of specified size. + + @param logN Log2 of FFT length. e.g. for 512 pt FFT, logN = 9. + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.FFT2.run(System.Double[],System.Double[],System.Boolean)"> + Performs in-place complex FFT. + + @param xRe Real part of input/output + @param xIm Imaginary part of input/output + @param inverse If true, do an inverse FFT + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.FFT2.BitReverse(System.UInt32,System.UInt32)"> + Do bit reversal of specified number of places of an int + For example, 1101 bit-reversed is 1011 + + @param x Number to be bit-reverse. + @param numBits Number of bits in the number. + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.MovingAverageExtensions.MovingAverage``1(System.Collections.Generic.IEnumerable{``0},System.Func{``0,System.Double},System.Int32)"> + <summary> + Fast MovingAverage LINQ Extension method provided for example purposes on an AS IS BASIS ONLY. ACCURACY OF CALCULATION NOT GAURANTEED + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.MovingAverageExtensions.MovingAverage(System.Collections.Generic.IEnumerable{System.Double},System.Int32)"> + <summary> + Fast MovingAverage LINQ Extension method provided for example purposes on an AS IS BASIS ONLY. ACCURACY OF CALCULATION NOT GAURANTEED + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.MovingAverageExtensions.Macd(System.Collections.Generic.IEnumerable{System.Double},System.Int32,System.Int32,System.Int32)"> + <summary> + Fast Macd LINQ Extension method provided for example purposes on an AS IS BASIS ONLY. ACCURACY OF CALCULATION NOT GAURANTEED + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Data.MovingAverageExtensions.Rsi(System.Collections.Generic.IEnumerable{SciChart.Examples.ExternalDependencies.Data.PriceBar},System.Int32)"> + <summary> + Fast Rsi LINQ Extension method provided for example purposes on an AS IS BASIS ONLY. ACCURACY OF CALCULATION NOT GAURANTEED + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Data.MovingAverage"> + <summary> + Fast Moving Average class provided for example purposes on an AS IS BASIS ONLY. ACCURACY OF CALCULATION NOT GAURANTEED + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Data.PriceSeries.TimeData"> + <summary> + Extracts the DateTime column of the PriceSeries as an array + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Data.PriceSeries.OpenData"> + <summary> + Extracts the Open column of the PriceSeries as an array + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Data.PriceSeries.HighData"> + <summary> + Extracts the High column of the PriceSeries as an array + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Data.PriceSeries.LowData"> + <summary> + Extracts the Low column of the PriceSeries as an array + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Data.PriceSeries.CloseData"> + <summary> + Extracts the Close column of the PriceSeries as an array + </summary> + </member> + <member name="P:SciChart.Examples.ExternalDependencies.Data.PriceSeries.VolumeData"> + <summary> + Extracts the Volume column of the PriceSeries as an array + </summary> + </member> + <member name="T:SciChart.Examples.ExternalDependencies.Resources.Styles.AnnotationStylesResourceDictionary"> + <summary> + AnnotationStylesResourceDictionary + </summary> + </member> + <member name="M:SciChart.Examples.ExternalDependencies.Resources.Styles.AnnotationStylesResourceDictionary.InitializeComponent"> + <summary> + InitializeComponent + </summary> + </member> + </members> +</doc>
\ No newline at end of file diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.D3DCompiler.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.D3DCompiler.dll Binary files differnew file mode 100644 index 000000000..3b7da918b --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.D3DCompiler.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.DXGI.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.DXGI.dll Binary files differnew file mode 100644 index 000000000..8a4f50af8 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.DXGI.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D11.Effects.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D11.Effects.dll Binary files differnew file mode 100644 index 000000000..983c96663 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D11.Effects.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D11.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D11.dll Binary files differnew file mode 100644 index 000000000..f413811be --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D11.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D9.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D9.dll Binary files differnew file mode 100644 index 000000000..54d163434 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Direct3D9.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Mathematics.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Mathematics.dll Binary files differnew file mode 100644 index 000000000..791204219 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.Mathematics.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.dll Binary files differnew file mode 100644 index 000000000..d4163a849 --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/SharpDX.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/sharpdx_direct3d11_1_effects_x64.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/sharpdx_direct3d11_1_effects_x64.dll Binary files differnew file mode 100644 index 000000000..e25ef563e --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/sharpdx_direct3d11_1_effects_x64.dll diff --git a/Software/Visual_Studio/Referenced Assemblies/SciChart/sharpdx_direct3d11_1_effects_x86.dll b/Software/Visual_Studio/Referenced Assemblies/SciChart/sharpdx_direct3d11_1_effects_x86.dll Binary files differnew file mode 100644 index 000000000..c9c8eacbd --- /dev/null +++ b/Software/Visual_Studio/Referenced Assemblies/SciChart/sharpdx_direct3d11_1_effects_x86.dll diff --git a/Software/Visual_Studio/Tango.BL/Enumerations/TechMonitors.cs b/Software/Visual_Studio/Tango.BL/Enumerations/TechMonitors.cs index cb523ca82..da8ee1c2b 100644 --- a/Software/Visual_Studio/Tango.BL/Enumerations/TechMonitors.cs +++ b/Software/Visual_Studio/Tango.BL/Enumerations/TechMonitors.cs @@ -383,7 +383,7 @@ namespace Tango.BL.Enumerations /// (Head Zone 5-6 Heater Current) /// </summary> [Description("Head Zone 5-6 Heater Current")] - HeadZone5_6HeaterCurrent = 82, + HeadZone56HeaterCurrent = 82, /// <summary> /// (Head Zone 5) diff --git a/Software/Visual_Studio/Tango.Emulations/ExternalBridge/EmulatorExternalBridge.cs b/Software/Visual_Studio/Tango.Emulations/ExternalBridge/EmulatorExternalBridge.cs index 1fba528f8..d8c988436 100644 --- a/Software/Visual_Studio/Tango.Emulations/ExternalBridge/EmulatorExternalBridge.cs +++ b/Software/Visual_Studio/Tango.Emulations/ExternalBridge/EmulatorExternalBridge.cs @@ -85,5 +85,7 @@ namespace Tango.Emulations.ExternalBridge { Machine = machine; } + + public bool CompressionEnabled { get; set; } } } diff --git a/Software/Visual_Studio/Tango.Insights/InsightsEvent.cs b/Software/Visual_Studio/Tango.Insights/InsightsEvent.cs new file mode 100644 index 000000000..b3f73e24b --- /dev/null +++ b/Software/Visual_Studio/Tango.Insights/InsightsEvent.cs @@ -0,0 +1,14 @@ +using System; +using System.Collections.Generic; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Tango.Insights +{ + public class InsightsEvent + { + public DateTime Time { get; set; } + public int EventCode { get; set; } + } +} diff --git a/Software/Visual_Studio/Tango.Insights/InsightsFile.cs b/Software/Visual_Studio/Tango.Insights/InsightsFile.cs index 853b23c98..8250dfb9d 100644 --- a/Software/Visual_Studio/Tango.Insights/InsightsFile.cs +++ b/Software/Visual_Studio/Tango.Insights/InsightsFile.cs @@ -13,9 +13,12 @@ namespace Tango.Insights { public List<InsightsFrame> Frames { get; set; } + public List<InsightsEvent> Events { get; set; } + public InsightsFile() { Frames = new List<InsightsFrame>(); + Events = new List<InsightsEvent>(); } public Stream ToStream() diff --git a/Software/Visual_Studio/Tango.Insights/InsightsFrame.cs b/Software/Visual_Studio/Tango.Insights/InsightsFrame.cs index 4ea2a1c13..5212b5471 100644 --- a/Software/Visual_Studio/Tango.Insights/InsightsFrame.cs +++ b/Software/Visual_Studio/Tango.Insights/InsightsFrame.cs @@ -40,7 +40,7 @@ namespace Tango.Insights frame.Time = timeUtc; byte[] data = insightsMonitors.ToBytes(); - byte[] compressedData = SevenZipHelper.Compress(data); + byte[] compressedData = GZipHelper.Compress(data); frame.MonitorsData = compressedData; @@ -55,7 +55,7 @@ namespace Tango.Insights } else { - var uncompressed = SevenZipHelper.Decompress(MonitorsData); + var uncompressed = GZipHelper.Decompress(MonitorsData); var insightsMonitors = InsightsMonitors.Parser.ParseFrom(uncompressed); return insightsMonitors; } diff --git a/Software/Visual_Studio/Tango.Insights/InsightsListener.cs b/Software/Visual_Studio/Tango.Insights/InsightsListener.cs index e534574fc..12d38e846 100644 --- a/Software/Visual_Studio/Tango.Insights/InsightsListener.cs +++ b/Software/Visual_Studio/Tango.Insights/InsightsListener.cs @@ -1,17 +1,23 @@ using System; using System.Collections.Generic; +using System.Diagnostics; using System.Linq; using System.Text; using System.Threading.Tasks; using System.Timers; +using Tango.Core; using Tango.Integration.Operation; using Tango.PMR.Diagnostics; using Tango.PMR.Insights; namespace Tango.Insights { - public class InsightsListener + public class InsightsListener : ExtendedObject { + public const int MIN_SAMPLING_INTERVAL_SECONDS = 1; + public const int MIN_STORAGE_CLEANUP_MINUTES = 1; + public const int MIN_MAX_STORAGE_DURATION_MINUTES = 10; + private InsightsManager _manager; private IMachineOperator _operator; private Timer _timer; @@ -41,19 +47,53 @@ namespace Tango.Insights public InsightsListener(IMachineOperator machineOperator) : this(InsightsManager.Default, machineOperator) { - + + } + + private void InsertInsightsGap() + { + Task.Factory.StartNew(() => + { + try + { + var frame = InsightsFrame.CreateEmpty(DateTime.UtcNow); + _manager.InsertFrame(frame); + Debug.WriteLine("Insights gap frame inserted."); + } + catch (Exception ex) + { + LogManager.Log(ex, "Error inserting insights gap on machine connection/disconnection."); + } + }); } public void Start() { if (!IsStarted) { + if (SamplingInterval.TotalSeconds < MIN_SAMPLING_INTERVAL_SECONDS) + { + SamplingInterval = TimeSpan.FromSeconds(MIN_SAMPLING_INTERVAL_SECONDS); + } + + if (StorageCleanupInterval.TotalMinutes < MIN_STORAGE_CLEANUP_MINUTES) + { + StorageCleanupInterval = TimeSpan.FromMinutes(MIN_STORAGE_CLEANUP_MINUTES); + } + + if (MaxStorageDuration.TotalMinutes < MIN_MAX_STORAGE_DURATION_MINUTES) + { + MaxStorageDuration = TimeSpan.FromMinutes(MIN_MAX_STORAGE_DURATION_MINUTES); + } + if (_timer == null) { _timer = new Timer(); _timer.Interval = SamplingInterval.TotalMilliseconds; } + InsertInsightsGap(); + _writing = false; _timerCount = 0; _deleteTicks = (int)(StorageCleanupInterval.TotalMilliseconds / SamplingInterval.TotalMilliseconds); @@ -62,6 +102,8 @@ namespace Tango.Insights IsStarted = true; _timer.Elapsed += _timer_Elapsed; _timer.Start(); + + LogManager.Log("Insights listener started..."); } } @@ -71,6 +113,7 @@ namespace Tango.Insights { _timer.Stop(); _diagnosticsQueue.Clear(); + LogManager.Log("Insights listener stopped."); } } @@ -86,33 +129,43 @@ namespace Tango.Insights { if (!IsStarted || _writing) return; - _writing = true; + try + { + _writing = true; - InsightsFrame frame = null; + InsightsFrame frame = null; - if (_diagnosticsQueue.Count > 0) - { - var queue = _diagnosticsQueue.ToList(); - _diagnosticsQueue.Clear(); + if (_diagnosticsQueue.Count > 0) + { + var queue = _diagnosticsQueue.ToList(); + _diagnosticsQueue.Clear(); - InsightsMonitors monitorsAvg = InsightsHelper.AverageMonitors(queue); - queue.Clear(); + InsightsMonitors monitorsAvg = InsightsHelper.AverageMonitors(queue); + queue.Clear(); - frame = InsightsFrame.FromInsightsMonitors(monitorsAvg, DateTime.UtcNow.Subtract(SamplingInterval)); - } - else - { - frame = InsightsFrame.CreateEmpty(DateTime.UtcNow.Subtract(SamplingInterval)); - } + frame = InsightsFrame.FromInsightsMonitors(monitorsAvg, DateTime.UtcNow.Subtract(SamplingInterval)); + } + else + { + frame = InsightsFrame.CreateEmpty(DateTime.UtcNow.Subtract(SamplingInterval)); + } + + _manager.InsertFrame(frame); - _manager.InsertFrame(frame); + Debug.WriteLine("Insights frame inserted."); - _timerCount++; + _timerCount++; - if (_timerCount >= _deleteTicks) + if (_timerCount >= _deleteTicks) + { + _timerCount = 0; + int deleted = _manager.DeleteFrames(DateTime.UtcNow.Subtract(MaxStorageDuration)); + Debug.WriteLine($"{deleted} insights frames deleted."); + } + } + catch (Exception ex) { - _timerCount = 0; - _manager.DeleteFrames(DateTime.UtcNow.Subtract(MaxStorageDuration)); + LogManager.Log(ex, "Error occurred on insights frame insertion."); } _writing = false; diff --git a/Software/Visual_Studio/Tango.Insights/InsightsManager.cs b/Software/Visual_Studio/Tango.Insights/InsightsManager.cs index 7597aabf4..65cb2b869 100644 --- a/Software/Visual_Studio/Tango.Insights/InsightsManager.cs +++ b/Software/Visual_Studio/Tango.Insights/InsightsManager.cs @@ -1,10 +1,12 @@ using LiteDB; using System; using System.Collections.Generic; +using System.Data.Entity; using System.IO; using System.Linq; using System.Text; using System.Threading.Tasks; +using Tango.BL; namespace Tango.Insights { @@ -69,7 +71,7 @@ namespace Tango.Insights public virtual List<InsightsFrame> GetFrames(DateTime startUTC, DateTime endUTC) { var collection = GetCollection(); - return collection.Find(x => x.Time >= startUTC && x.Time <= endUTC).ToList(); + return collection.Find(x => x.Time >= startUTC && x.Time <= endUTC).ToList().OrderBy(x => x.Time).ToList(); } public virtual int DeleteFrames(DateTime maxDateUTC) @@ -77,5 +79,30 @@ namespace Tango.Insights var collection = GetCollection(); return collection.DeleteMany(x => x.Time < maxDateUTC); } + + public virtual List<InsightsEvent> GetEvents(DateTime startUTC, DateTime endUTC) + { + using (ObservablesContext db = ObservablesContext.CreateDefault()) + { + List<InsightsEvent> events = db.MachinesEvents + .Where(x => x.DateTime >= startUTC && x.DateTime <= endUTC) + .Include(x => x.EventType) + .Select(x => new InsightsEvent() + { + Time = x.DateTime, + EventCode = x.EventType.Code + }) + .ToList() + .Select(x => new InsightsEvent() + { + Time = new DateTime(x.Time.Ticks, DateTimeKind.Utc), + EventCode = x.EventCode + }) + .OrderBy(x => x.Time) + .ToList(); + + return events; + } + } } } diff --git a/Software/Visual_Studio/Tango.Insights/Tango.Insights.csproj b/Software/Visual_Studio/Tango.Insights/Tango.Insights.csproj index 26b2e8204..9bd24e263 100644 --- a/Software/Visual_Studio/Tango.Insights/Tango.Insights.csproj +++ b/Software/Visual_Studio/Tango.Insights/Tango.Insights.csproj @@ -44,6 +44,7 @@ <Compile Include="..\Versioning\GlobalVersionInfo.cs"> <Link>GlobalVersionInfo.cs</Link> </Compile> + <Compile Include="InsightsEvent.cs" /> <Compile Include="InsightsFile.cs" /> <Compile Include="InsightsHelper.cs" /> <Compile Include="InsightsFrame.cs" /> @@ -52,6 +53,10 @@ <Compile Include="Properties\AssemblyInfo.cs" /> </ItemGroup> <ItemGroup> + <ProjectReference Include="..\Tango.BL\Tango.BL.csproj"> + <Project>{F441FEEE-322A-4943-B566-110E12FD3B72}</Project> + <Name>Tango.BL</Name> + </ProjectReference> <ProjectReference Include="..\Tango.Core\Tango.Core.csproj"> <Project>{a34ee0f0-649d-41c8-8489-b6f1cc6924ee}</Project> <Name>Tango.Core</Name> @@ -60,6 +65,10 @@ <Project>{4206ac58-3b57-4699-8835-90bf6db01a61}</Project> <Name>Tango.Integration</Name> </ProjectReference> + <ProjectReference Include="..\Tango.Logging\Tango.Logging.csproj"> + <Project>{bc932dbd-7cdb-488c-99e4-f02cf441f55e}</Project> + <Name>Tango.Logging</Name> + </ProjectReference> <ProjectReference Include="..\Tango.PMR\Tango.PMR.csproj"> <Project>{e4927038-348d-4295-aaf4-861c58cb3943}</Project> <Name>Tango.PMR</Name> @@ -70,6 +79,9 @@ </ProjectReference> </ItemGroup> <ItemGroup> + <PackageReference Include="EntityFramework"> + <Version>6.2.0</Version> + </PackageReference> <PackageReference Include="Google.Protobuf"> <Version>3.4.1</Version> </PackageReference> diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeScanner.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeScanner.cs index 5cb899bc9..58487985b 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeScanner.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeScanner.cs @@ -245,11 +245,11 @@ namespace Tango.Integration.ExternalBridge if (knownMachine == null) { - newMachine = new ExternalBridgeTcpClient(packet.SerialNumber, address); + newMachine = new ExternalBridgeTcpClient(packet.SerialNumber, address, packet.CompressionEnabled); } else { - newMachine = new ExternalBridgeTcpClient(knownMachine, address); + newMachine = new ExternalBridgeTcpClient(knownMachine, address, packet.CompressionEnabled); } LogManager.Log("Found a new machine via TCP " + newMachine.SerialNumber); @@ -302,7 +302,7 @@ namespace Tango.Integration.ExternalBridge } else { - newMachine = new ExternalBridgeSignalRClient(SignalRConfiguration.Address, SignalRConfiguration.Hub, knownMachine,machine); + newMachine = new ExternalBridgeSignalRClient(SignalRConfiguration.Address, SignalRConfiguration.Hub, knownMachine, machine); } ThreadsHelper.InvokeUINow(() => diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeService.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeService.cs index e1d23685a..438e475a8 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeService.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeService.cs @@ -170,6 +170,10 @@ namespace Tango.Integration.ExternalBridge private set { _fullControlSessionReceiver = value; RaisePropertyChangedAuto(); } } + /// <summary> + /// Gets or sets a value indicating whether to broadcast that compression on connected ITransportAdapter is enabled. + /// </summary> + public bool EnableTransportCompression { get; set; } #endregion @@ -235,6 +239,7 @@ namespace Tango.Integration.ExternalBridge _discoveryService = new UdpDiscoveryService<ExternalBridgeUdpDiscoveryPacket>(_discovery_port, new ExternalBridgeUdpDiscoveryPacket() { SerialNumber = Machine.SerialNumber, + CompressionEnabled = EnableTransportCompression, }); _discoveryService.BeforeBroadcasting -= _discoverySevice_BeforeBroadcasting; @@ -273,6 +278,7 @@ namespace Tango.Integration.ExternalBridge { LogManager.Log("External bridge TCP client connected from: " + e.Socket.GetIPAddress()); ExternalBridgeReceiver receiver = new ExternalBridgeReceiver(e.Socket, MachineOperator); + receiver.Adapter.EnableCompression = EnableTransportCompression; (receiver.Adapter as TcpTransportAdapter).WriteMode = TcpTransportAdapterWriteMode; receiver.LoginRequest += Receiver_LoginRequest; receiver.ColorProfileRequest += Receiver_ColorProfileRequest; @@ -290,6 +296,7 @@ namespace Tango.Integration.ExternalBridge LogManager.Log("External bridge SignalR client connected."); var adapter = new SignalRTransportAdapter(SignalRConfiguration.Address, SignalRConfiguration.Hub, SignalRTransportAdapterMode.JoinSession, Machine.SerialNumber, sessionID); ; + adapter.EnableCompression = EnableTransportCompression; ExternalBridgeReceiver receiver = new ExternalBridgeReceiver(adapter, MachineOperator); receiver.LoginRequest += Receiver_LoginRequest; @@ -604,6 +611,7 @@ namespace Tango.Integration.ExternalBridge { SerialNumber = Machine.SerialNumber, Organization = Machine.Organization.Name, + CompressionEnabled = EnableTransportCompression }); _isSignalRConnected = true; diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeSignalRClient.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeSignalRClient.cs index df612ed96..7c5fc5053 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeSignalRClient.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeSignalRClient.cs @@ -19,12 +19,17 @@ namespace Tango.Integration.ExternalBridge { public ExternalBridgeSignalRClient(String url, String hub, MachineInfo machineInfo) { + CompressionEnabled = machineInfo.CompressionEnabled; + ComponentName = $"External Bridge SignalR Client {_component_counter++}"; SerialNumber = machineInfo.SerialNumber; IPAddress = machineInfo.IPAddress; Machine = ObservablesStaticCollections.Instance.Machines.SingleOrDefault(x => x.SerialNumber == SerialNumber); - Adapter = new SignalRTransportAdapter(url, hub, SignalRTransportAdapterMode.CreateSession, SerialNumber, null, IPAddress); + Adapter = new SignalRTransportAdapter(url, hub, SignalRTransportAdapterMode.CreateSession, SerialNumber, null, IPAddress) + { + EnableCompression = CompressionEnabled + }; KeepAliveTimeout = TimeSpan.FromSeconds(5); KeepAliveRetries = 2; @@ -33,12 +38,17 @@ namespace Tango.Integration.ExternalBridge public ExternalBridgeSignalRClient(String url, String hub, Machine machine, MachineInfo machineInfo) { + CompressionEnabled = machineInfo.CompressionEnabled; + ComponentName = $"External Bridge SignalR Client {_component_counter++}"; SerialNumber = machine.SerialNumber; IPAddress = machineInfo.IPAddress; Machine = machine; - Adapter = new SignalRTransportAdapter(url, hub, SignalRTransportAdapterMode.CreateSession, SerialNumber, null, IPAddress); + Adapter = new SignalRTransportAdapter(url, hub, SignalRTransportAdapterMode.CreateSession, SerialNumber, null, IPAddress) + { + EnableCompression = CompressionEnabled + }; KeepAliveTimeout = TimeSpan.FromSeconds(5); KeepAliveRetries = 2; diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeTcpClient.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeTcpClient.cs index 086b2bc7c..2a6fa1aad 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeTcpClient.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeTcpClient.cs @@ -59,6 +59,11 @@ namespace Tango.Integration.ExternalBridge set { _ipAddress = value; RaisePropertyChangedAuto(); } } + /// <summary> + /// Gets or sets a value indicating whether transport compression is required by the remote machine. + /// </summary> + public bool CompressionEnabled { get; set; } + private bool _enableApplicationLogs; /// <summary> /// Gets or sets a value indicating whether to enable receiving application logs. @@ -281,10 +286,11 @@ namespace Tango.Integration.ExternalBridge /// </summary> /// <param name="serialNumber">The machine serial number.</param> /// <param name="ipAddress">The machine IP address.</param> - public ExternalBridgeTcpClient(String serialNumber, String ipAddress) + public ExternalBridgeTcpClient(String serialNumber, String ipAddress, bool enableCompression) { ComponentName = $"External Bridge TCP Client {_component_counter++}"; SerialNumber = serialNumber; + CompressionEnabled = enableCompression; if (ObservablesStaticCollections.Instance.IsInitialized) { @@ -296,21 +302,28 @@ namespace Tango.Integration.ExternalBridge UseKeepAlive = false; EnableDiagnostics = true; - Adapter = new TcpTransportAdapter(IPAddress, SettingsManager.Default.GetOrCreate<IntegrationSettings>().ExternalBridgeServicePort); + Adapter = new TcpTransportAdapter(IPAddress, SettingsManager.Default.GetOrCreate<IntegrationSettings>().ExternalBridgeServicePort) + { + EnableCompression = CompressionEnabled + }; } - public ExternalBridgeTcpClient(Machine machine, String ipAddress) + public ExternalBridgeTcpClient(Machine machine, String ipAddress, bool enableCompression) { ComponentName = $"External Bridge TCP Client {_component_counter++}"; Machine = machine; SerialNumber = Machine.SerialNumber; + CompressionEnabled = enableCompression; IPAddress = ipAddress; KeepAliveTimeout = TimeSpan.FromSeconds(5); KeepAliveRetries = 2; UseKeepAlive = false; EnableDiagnostics = true; - Adapter = new TcpTransportAdapter(IPAddress, SettingsManager.Default.GetOrCreate<IntegrationSettings>().ExternalBridgeServicePort); + Adapter = new TcpTransportAdapter(IPAddress, SettingsManager.Default.GetOrCreate<IntegrationSettings>().ExternalBridgeServicePort) + { + EnableCompression = CompressionEnabled + }; } /// <summary> diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeUsbClient.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeUsbClient.cs index 57944b8d2..d7246fe7b 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeUsbClient.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/ExternalBridgeUsbClient.cs @@ -68,6 +68,11 @@ namespace Tango.Integration.ExternalBridge } /// <summary> + /// Gets or sets a value indicating whether transport compression is required by the remote machine. + /// </summary> + public bool CompressionEnabled { get; set; } + + /// <summary> /// Connects the transport component. /// </summary> /// <returns></returns> diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeClient.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeClient.cs index d336b6b70..563ef9418 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeClient.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeClient.cs @@ -28,6 +28,11 @@ namespace Tango.Integration.ExternalBridge String SerialNumber { get; set; } /// <summary> + /// Gets or sets a value indicating whether transport compression is required by the remote machine. + /// </summary> + bool CompressionEnabled { get; set; } + + /// <summary> /// Gets the database machine associated with this client. /// </summary> Machine Machine { get; } diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeService.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeService.cs index c7d2c8d5c..f6a4ca110 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeService.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/IExternalBridgeService.cs @@ -62,6 +62,11 @@ namespace Tango.Integration.ExternalBridge TcpTransportAdapterWriteMode TcpTransportAdapterWriteMode { get; set; } /// <summary> + /// Gets or sets a value indicating whether to broadcast that compression on connected ITransportAdapter is enabled. + /// </summary> + bool EnableTransportCompression { get; set; } + + /// <summary> /// Gets a value indicating whether this instance is started. /// </summary> bool IsStarted { get; } diff --git a/Software/Visual_Studio/Tango.Integration/ExternalBridge/Web/MachineInfo.cs b/Software/Visual_Studio/Tango.Integration/ExternalBridge/Web/MachineInfo.cs index a33d073d1..578dd9640 100644 --- a/Software/Visual_Studio/Tango.Integration/ExternalBridge/Web/MachineInfo.cs +++ b/Software/Visual_Studio/Tango.Integration/ExternalBridge/Web/MachineInfo.cs @@ -11,6 +11,7 @@ namespace Tango.Integration.ExternalBridge.Web public String SerialNumber { get; set; } public String Organization { get; set; } public String IPAddress { get; set; } + public bool CompressionEnabled { get; set; } public MachineInfo() { diff --git a/Software/Visual_Studio/Tango.PMR/Diagnostics/DiagnosticsMonitors.cs b/Software/Visual_Studio/Tango.PMR/Diagnostics/DiagnosticsMonitors.cs index 1dbec9290..cc3115da1 100644 --- a/Software/Visual_Studio/Tango.PMR/Diagnostics/DiagnosticsMonitors.cs +++ b/Software/Visual_Studio/Tango.PMR/Diagnostics/DiagnosticsMonitors.cs @@ -23,7 +23,7 @@ namespace Tango.PMR.Diagnostics { byte[] descriptorData = global::System.Convert.FromBase64String( string.Concat( "ChlEaWFnbm9zdGljc01vbml0b3JzLnByb3RvEhVUYW5nby5QTVIuRGlhZ25v", - "c3RpY3MaEURvdWJsZUFycmF5LnByb3RvIvAVChNEaWFnbm9zdGljc01vbml0", + "c3RpY3MaEURvdWJsZUFycmF5LnByb3RvIu8VChNEaWFnbm9zdGljc01vbml0", "b3JzEhQKDERhbmNlcjFBbmdsZRgBIAMoARIUCgxEYW5jZXIyQW5nbGUYAiAD", "KAESFAoMRGFuY2VyM0FuZ2xlGAMgAygBEhwKFEZlZWRlck1vdG9yRnJlcXVl", "bmN5GAQgAygBEhIKCkRyeWVyTW90b3IYBSADKAESEwoLUG9sbGVyTW90b3IY", @@ -65,28 +65,28 @@ namespace Tango.PMR.Diagnostics { "GDkgAygBEh4KFkhlYWRab25lMUhlYXRlckN1cnJlbnQYOiADKAESHgoWSGVh", "ZFpvbmUySGVhdGVyQ3VycmVudBg7IAMoARIeChZIZWFkWm9uZTNIZWF0ZXJD", "dXJyZW50GDwgAygBEh4KFkhlYWRab25lNEhlYXRlckN1cnJlbnQYPSADKAES", - "IAoYSGVhZFpvbmU1XzZIZWF0ZXJDdXJyZW50GD4gAygBEhsKE01peGVyMUhl", - "YXRlckN1cnJlbnQYPyADKAESPgoSRGlzcGVuc2Vyc0lua0xldmVsGEAgAygL", - "MiIuVGFuZ28uUE1SLkRpYWdub3N0aWNzLkRvdWJsZUFycmF5EjwKEE1pZFRh", - "bmtzSW5rTGV2ZWwYQSADKAsyIi5UYW5nby5QTVIuRGlhZ25vc3RpY3MuRG91", - "YmxlQXJyYXkSGgoST3ZlcmFsbFRlbXBlcmF0dXJlGEIgAygBEh4KFkhlYWRa", - "b25lN0hlYXRlckN1cnJlbnQYQyADKAESHAoUSGVhZFpvbmU3VGVtcGVyYXR1", - "cmUYRCADKAESHgoWSGVhZFpvbmU4SGVhdGVyQ3VycmVudBhFIAMoARIcChRI", - "ZWFkWm9uZThUZW1wZXJhdHVyZRhGIAMoARIeChZIZWFkWm9uZTlIZWF0ZXJD", - "dXJyZW50GEcgAygBEhwKFEhlYWRab25lOVRlbXBlcmF0dXJlGEggAygBEh8K", - "F0hlYWRab25lMTBIZWF0ZXJDdXJyZW50GEkgAygBEh0KFUhlYWRab25lMTBU", - "ZW1wZXJhdHVyZRhKIAMoARIfChdIZWFkWm9uZTExSGVhdGVyQ3VycmVudBhL", - "IAMoARIdChVIZWFkWm9uZTExVGVtcGVyYXR1cmUYTCADKAESHwoXSGVhZFpv", - "bmUxMkhlYXRlckN1cnJlbnQYTSADKAESHQoVSGVhZFpvbmUxMlRlbXBlcmF0", - "dXJlGE4gAygBEhoKEkhlYWRCbG93ZXJWb2x0YWdlMRhPIAMoARIaChJIZWFk", - "Qmxvd2VyVm9sdGFnZTIYUCADKAESHwoXSGVhZENvdmVySGVhdGVyMUN1cnJl", - "bnQYUSADKAESIwobSGVhZENvdmVySGVhdGVyMVRlbXBlcmF0dXJlGFIgAygB", - "Eh8KF0hlYWRDb3ZlckhlYXRlcjJDdXJyZW50GFMgAygBEiMKG0hlYWRDb3Zl", - "ckhlYXRlcjJUZW1wZXJhdHVyZRhUIAMoARIZChFXSFNCbG93ZXIyVm9sdGFn", - "ZRhVIAMoARIRCglHYXNTZW5zb3IYViADKAESFwoPSW5jb21pbmdWb2x0YWdl", - "GFcgAygBEhIKCldhc3RlTGV2ZWwYWCADKAESGgoSSGVhZEJsb3dlcjFBaXJG", - "bG93GFkgAygBEhoKEkhlYWRCbG93ZXIyQWlyRmxvdxhaIAMoAUIhCh9jb20u", - "dHdpbmUudGFuZ28ucG1yLmRpYWdub3N0aWNzYgZwcm90bzM=")); + "HwoXSGVhZFpvbmU1NkhlYXRlckN1cnJlbnQYPiADKAESGwoTTWl4ZXIxSGVh", + "dGVyQ3VycmVudBg/IAMoARI+ChJEaXNwZW5zZXJzSW5rTGV2ZWwYQCADKAsy", + "Ii5UYW5nby5QTVIuRGlhZ25vc3RpY3MuRG91YmxlQXJyYXkSPAoQTWlkVGFu", + "a3NJbmtMZXZlbBhBIAMoCzIiLlRhbmdvLlBNUi5EaWFnbm9zdGljcy5Eb3Vi", + "bGVBcnJheRIaChJPdmVyYWxsVGVtcGVyYXR1cmUYQiADKAESHgoWSGVhZFpv", + "bmU3SGVhdGVyQ3VycmVudBhDIAMoARIcChRIZWFkWm9uZTdUZW1wZXJhdHVy", + "ZRhEIAMoARIeChZIZWFkWm9uZThIZWF0ZXJDdXJyZW50GEUgAygBEhwKFEhl", + "YWRab25lOFRlbXBlcmF0dXJlGEYgAygBEh4KFkhlYWRab25lOUhlYXRlckN1", + "cnJlbnQYRyADKAESHAoUSGVhZFpvbmU5VGVtcGVyYXR1cmUYSCADKAESHwoX", + "SGVhZFpvbmUxMEhlYXRlckN1cnJlbnQYSSADKAESHQoVSGVhZFpvbmUxMFRl", + "bXBlcmF0dXJlGEogAygBEh8KF0hlYWRab25lMTFIZWF0ZXJDdXJyZW50GEsg", + "AygBEh0KFUhlYWRab25lMTFUZW1wZXJhdHVyZRhMIAMoARIfChdIZWFkWm9u", + "ZTEySGVhdGVyQ3VycmVudBhNIAMoARIdChVIZWFkWm9uZTEyVGVtcGVyYXR1", + "cmUYTiADKAESGgoSSGVhZEJsb3dlclZvbHRhZ2UxGE8gAygBEhoKEkhlYWRC", + "bG93ZXJWb2x0YWdlMhhQIAMoARIfChdIZWFkQ292ZXJIZWF0ZXIxQ3VycmVu", + "dBhRIAMoARIjChtIZWFkQ292ZXJIZWF0ZXIxVGVtcGVyYXR1cmUYUiADKAES", + "HwoXSGVhZENvdmVySGVhdGVyMkN1cnJlbnQYUyADKAESIwobSGVhZENvdmVy", + "SGVhdGVyMlRlbXBlcmF0dXJlGFQgAygBEhkKEVdIU0Jsb3dlcjJWb2x0YWdl", + "GFUgAygBEhEKCUdhc1NlbnNvchhWIAMoARIXCg9JbmNvbWluZ1ZvbHRhZ2UY", + "VyADKAESEgoKV2FzdGVMZXZlbBhYIAMoARIaChJIZWFkQmxvd2VyMUFpckZs", + "b3cYWSADKAESGgoSSGVhZEJsb3dlcjJBaXJGbG93GFogAygBQiEKH2NvbS50", + "d2luZS50YW5nby5wbXIuZGlhZ25vc3RpY3NiBnByb3RvMw==")); descriptor = pbr::FileDescriptor.FromGeneratedCode(descriptorData, new pbr::FileDescriptor[] { global::Tango.PMR.Diagnostics.DoubleArrayReflection.Descriptor, }, new pbr::GeneratedClrTypeInfo(null, new pbr::GeneratedClrTypeInfo[] { @@ -1011,7 +1011,7 @@ namespace Tango.PMR.Diagnostics { get { return headZone4HeaterCurrent_; } } - /// <summary>Field number for the "HeadZone5_6HeaterCurrent" field.</summary> + /// <summary>Field number for the "HeadZone56HeaterCurrent" field.</summary> public const int HeadZone56HeaterCurrentFieldNumber = 62; private static readonly pb::FieldCodec<double> _repeated_headZone56HeaterCurrent_codec = pb::FieldCodec.ForDouble(498); diff --git a/Software/Visual_Studio/Tango.PMR/Insights/InsightsMonitors.cs b/Software/Visual_Studio/Tango.PMR/Insights/InsightsMonitors.cs index e5faefcc4..f59be38e7 100644 --- a/Software/Visual_Studio/Tango.PMR/Insights/InsightsMonitors.cs +++ b/Software/Visual_Studio/Tango.PMR/Insights/InsightsMonitors.cs @@ -23,7 +23,7 @@ namespace Tango.PMR.Insights { byte[] descriptorData = global::System.Convert.FromBase64String( string.Concat( "ChZJbnNpZ2h0c01vbml0b3JzLnByb3RvEhJUYW5nby5QTVIuSW5zaWdodHMi", - "lRQKEEluc2lnaHRzTW9uaXRvcnMSFAoMRGFuY2VyMUFuZ2xlGAEgASgBEhQK", + "lBQKEEluc2lnaHRzTW9uaXRvcnMSFAoMRGFuY2VyMUFuZ2xlGAEgASgBEhQK", "DERhbmNlcjJBbmdsZRgCIAEoARIUCgxEYW5jZXIzQW5nbGUYAyABKAESHAoU", "RmVlZGVyTW90b3JGcmVxdWVuY3kYBCABKAESEgoKRHJ5ZXJNb3RvchgFIAEo", "ARITCgtQb2xsZXJNb3RvchgGIAEoARITCgtXaW5kZXJNb3RvchgHIAEoARIS", @@ -61,27 +61,27 @@ namespace Tango.PMR.Insights { "ckN1cnJlbnQYOSABKAESHgoWSGVhZFpvbmUxSGVhdGVyQ3VycmVudBg6IAEo", "ARIeChZIZWFkWm9uZTJIZWF0ZXJDdXJyZW50GDsgASgBEh4KFkhlYWRab25l", "M0hlYXRlckN1cnJlbnQYPCABKAESHgoWSGVhZFpvbmU0SGVhdGVyQ3VycmVu", - "dBg9IAEoARIgChhIZWFkWm9uZTVfNkhlYXRlckN1cnJlbnQYPiABKAESGwoT", - "TWl4ZXIxSGVhdGVyQ3VycmVudBg/IAEoARIaChJEaXNwZW5zZXJzSW5rTGV2", - "ZWwYQCADKAESGAoQTWlkVGFua3NJbmtMZXZlbBhBIAMoARIaChJPdmVyYWxs", - "VGVtcGVyYXR1cmUYQiABKAESHgoWSGVhZFpvbmU3SGVhdGVyQ3VycmVudBhD", - "IAEoARIcChRIZWFkWm9uZTdUZW1wZXJhdHVyZRhEIAEoARIeChZIZWFkWm9u", - "ZThIZWF0ZXJDdXJyZW50GEUgASgBEhwKFEhlYWRab25lOFRlbXBlcmF0dXJl", - "GEYgASgBEh4KFkhlYWRab25lOUhlYXRlckN1cnJlbnQYRyABKAESHAoUSGVh", - "ZFpvbmU5VGVtcGVyYXR1cmUYSCABKAESHwoXSGVhZFpvbmUxMEhlYXRlckN1", - "cnJlbnQYSSABKAESHQoVSGVhZFpvbmUxMFRlbXBlcmF0dXJlGEogASgBEh8K", - "F0hlYWRab25lMTFIZWF0ZXJDdXJyZW50GEsgASgBEh0KFUhlYWRab25lMTFU", - "ZW1wZXJhdHVyZRhMIAEoARIfChdIZWFkWm9uZTEySGVhdGVyQ3VycmVudBhN", - "IAEoARIdChVIZWFkWm9uZTEyVGVtcGVyYXR1cmUYTiABKAESGgoSSGVhZEJs", - "b3dlclZvbHRhZ2UxGE8gASgBEhoKEkhlYWRCbG93ZXJWb2x0YWdlMhhQIAEo", - "ARIfChdIZWFkQ292ZXJIZWF0ZXIxQ3VycmVudBhRIAEoARIjChtIZWFkQ292", - "ZXJIZWF0ZXIxVGVtcGVyYXR1cmUYUiABKAESHwoXSGVhZENvdmVySGVhdGVy", - "MkN1cnJlbnQYUyABKAESIwobSGVhZENvdmVySGVhdGVyMlRlbXBlcmF0dXJl", - "GFQgASgBEhkKEVdIU0Jsb3dlcjJWb2x0YWdlGFUgASgBEhEKCUdhc1NlbnNv", - "chhWIAEoARIXCg9JbmNvbWluZ1ZvbHRhZ2UYVyABKAESEgoKV2FzdGVMZXZl", - "bBhYIAEoARIaChJIZWFkQmxvd2VyMUFpckZsb3cYWSABKAESGgoSSGVhZEJs", - "b3dlcjJBaXJGbG93GFogASgBQh4KHGNvbS50d2luZS50YW5nby5wbXIuaW5z", - "aWdodHNiBnByb3RvMw==")); + "dBg9IAEoARIfChdIZWFkWm9uZTU2SGVhdGVyQ3VycmVudBg+IAEoARIbChNN", + "aXhlcjFIZWF0ZXJDdXJyZW50GD8gASgBEhoKEkRpc3BlbnNlcnNJbmtMZXZl", + "bBhAIAMoARIYChBNaWRUYW5rc0lua0xldmVsGEEgAygBEhoKEk92ZXJhbGxU", + "ZW1wZXJhdHVyZRhCIAEoARIeChZIZWFkWm9uZTdIZWF0ZXJDdXJyZW50GEMg", + "ASgBEhwKFEhlYWRab25lN1RlbXBlcmF0dXJlGEQgASgBEh4KFkhlYWRab25l", + "OEhlYXRlckN1cnJlbnQYRSABKAESHAoUSGVhZFpvbmU4VGVtcGVyYXR1cmUY", + "RiABKAESHgoWSGVhZFpvbmU5SGVhdGVyQ3VycmVudBhHIAEoARIcChRIZWFk", + "Wm9uZTlUZW1wZXJhdHVyZRhIIAEoARIfChdIZWFkWm9uZTEwSGVhdGVyQ3Vy", + "cmVudBhJIAEoARIdChVIZWFkWm9uZTEwVGVtcGVyYXR1cmUYSiABKAESHwoX", + "SGVhZFpvbmUxMUhlYXRlckN1cnJlbnQYSyABKAESHQoVSGVhZFpvbmUxMVRl", + "bXBlcmF0dXJlGEwgASgBEh8KF0hlYWRab25lMTJIZWF0ZXJDdXJyZW50GE0g", + "ASgBEh0KFUhlYWRab25lMTJUZW1wZXJhdHVyZRhOIAEoARIaChJIZWFkQmxv", + "d2VyVm9sdGFnZTEYTyABKAESGgoSSGVhZEJsb3dlclZvbHRhZ2UyGFAgASgB", + "Eh8KF0hlYWRDb3ZlckhlYXRlcjFDdXJyZW50GFEgASgBEiMKG0hlYWRDb3Zl", + "ckhlYXRlcjFUZW1wZXJhdHVyZRhSIAEoARIfChdIZWFkQ292ZXJIZWF0ZXIy", + "Q3VycmVudBhTIAEoARIjChtIZWFkQ292ZXJIZWF0ZXIyVGVtcGVyYXR1cmUY", + "VCABKAESGQoRV0hTQmxvd2VyMlZvbHRhZ2UYVSABKAESEQoJR2FzU2Vuc29y", + "GFYgASgBEhcKD0luY29taW5nVm9sdGFnZRhXIAEoARISCgpXYXN0ZUxldmVs", + "GFggASgBEhoKEkhlYWRCbG93ZXIxQWlyRmxvdxhZIAEoARIaChJIZWFkQmxv", + "d2VyMkFpckZsb3cYWiABKAFCHgocY29tLnR3aW5lLnRhbmdvLnBtci5pbnNp", + "Z2h0c2IGcHJvdG8z")); descriptor = pbr::FileDescriptor.FromGeneratedCode(descriptorData, new pbr::FileDescriptor[] { }, new pbr::GeneratedClrTypeInfo(null, new pbr::GeneratedClrTypeInfo[] { @@ -1063,7 +1063,7 @@ namespace Tango.PMR.Insights { } } - /// <summary>Field number for the "HeadZone5_6HeaterCurrent" field.</summary> + /// <summary>Field number for the "HeadZone56HeaterCurrent" field.</summary> public const int HeadZone56HeaterCurrentFieldNumber = 62; private double headZone56HeaterCurrent_; /// <summary> diff --git a/Software/Visual_Studio/Tango.PMR/Integration/ExternalBridgeUdpDiscoveryPacket.cs b/Software/Visual_Studio/Tango.PMR/Integration/ExternalBridgeUdpDiscoveryPacket.cs index df584d5c6..69d835521 100644 --- a/Software/Visual_Studio/Tango.PMR/Integration/ExternalBridgeUdpDiscoveryPacket.cs +++ b/Software/Visual_Studio/Tango.PMR/Integration/ExternalBridgeUdpDiscoveryPacket.cs @@ -23,13 +23,14 @@ namespace Tango.PMR.Integration { byte[] descriptorData = global::System.Convert.FromBase64String( string.Concat( "CiZFeHRlcm5hbEJyaWRnZVVkcERpc2NvdmVyeVBhY2tldC5wcm90bxIVVGFu", - "Z28uUE1SLkludGVncmF0aW9uIkYKIEV4dGVybmFsQnJpZGdlVWRwRGlzY292", + "Z28uUE1SLkludGVncmF0aW9uImIKIEV4dGVybmFsQnJpZGdlVWRwRGlzY292", "ZXJ5UGFja2V0EgwKBFRpbWUYASABKAkSFAoMU2VyaWFsTnVtYmVyGAIgASgJ", - "QiEKH2NvbS50d2luZS50YW5nby5wbXIuaW50ZWdyYXRpb25iBnByb3RvMw==")); + "EhoKEkNvbXByZXNzaW9uRW5hYmxlZBgDIAEoCEIhCh9jb20udHdpbmUudGFu", + "Z28ucG1yLmludGVncmF0aW9uYgZwcm90bzM=")); descriptor = pbr::FileDescriptor.FromGeneratedCode(descriptorData, new pbr::FileDescriptor[] { }, new pbr::GeneratedClrTypeInfo(null, new pbr::GeneratedClrTypeInfo[] { - new pbr::GeneratedClrTypeInfo(typeof(global::Tango.PMR.Integration.ExternalBridgeUdpDiscoveryPacket), global::Tango.PMR.Integration.ExternalBridgeUdpDiscoveryPacket.Parser, new[]{ "Time", "SerialNumber" }, null, null, null) + new pbr::GeneratedClrTypeInfo(typeof(global::Tango.PMR.Integration.ExternalBridgeUdpDiscoveryPacket), global::Tango.PMR.Integration.ExternalBridgeUdpDiscoveryPacket.Parser, new[]{ "Time", "SerialNumber", "CompressionEnabled" }, null, null, null) })); } #endregion @@ -62,6 +63,7 @@ namespace Tango.PMR.Integration { public ExternalBridgeUdpDiscoveryPacket(ExternalBridgeUdpDiscoveryPacket other) : this() { time_ = other.time_; serialNumber_ = other.serialNumber_; + compressionEnabled_ = other.compressionEnabled_; } [global::System.Diagnostics.DebuggerNonUserCodeAttribute] @@ -91,6 +93,17 @@ namespace Tango.PMR.Integration { } } + /// <summary>Field number for the "CompressionEnabled" field.</summary> + public const int CompressionEnabledFieldNumber = 3; + private bool compressionEnabled_; + [global::System.Diagnostics.DebuggerNonUserCodeAttribute] + public bool CompressionEnabled { + get { return compressionEnabled_; } + set { + compressionEnabled_ = value; + } + } + [global::System.Diagnostics.DebuggerNonUserCodeAttribute] public override bool Equals(object other) { return Equals(other as ExternalBridgeUdpDiscoveryPacket); @@ -106,6 +119,7 @@ namespace Tango.PMR.Integration { } if (Time != other.Time) return false; if (SerialNumber != other.SerialNumber) return false; + if (CompressionEnabled != other.CompressionEnabled) return false; return true; } @@ -114,6 +128,7 @@ namespace Tango.PMR.Integration { int hash = 1; if (Time.Length != 0) hash ^= Time.GetHashCode(); if (SerialNumber.Length != 0) hash ^= SerialNumber.GetHashCode(); + if (CompressionEnabled != false) hash ^= CompressionEnabled.GetHashCode(); return hash; } @@ -132,6 +147,10 @@ namespace Tango.PMR.Integration { output.WriteRawTag(18); output.WriteString(SerialNumber); } + if (CompressionEnabled != false) { + output.WriteRawTag(24); + output.WriteBool(CompressionEnabled); + } } [global::System.Diagnostics.DebuggerNonUserCodeAttribute] @@ -143,6 +162,9 @@ namespace Tango.PMR.Integration { if (SerialNumber.Length != 0) { size += 1 + pb::CodedOutputStream.ComputeStringSize(SerialNumber); } + if (CompressionEnabled != false) { + size += 1 + 1; + } return size; } @@ -157,6 +179,9 @@ namespace Tango.PMR.Integration { if (other.SerialNumber.Length != 0) { SerialNumber = other.SerialNumber; } + if (other.CompressionEnabled != false) { + CompressionEnabled = other.CompressionEnabled; + } } [global::System.Diagnostics.DebuggerNonUserCodeAttribute] @@ -175,6 +200,10 @@ namespace Tango.PMR.Integration { SerialNumber = input.ReadString(); break; } + case 24: { + CompressionEnabled = input.ReadBool(); + break; + } } } } diff --git a/Software/Visual_Studio/Tango.SharedUI/Converters/TimeSpanToDaysConverter.cs b/Software/Visual_Studio/Tango.SharedUI/Converters/TimeSpanToDaysConverter.cs new file mode 100644 index 000000000..d9256ac08 --- /dev/null +++ b/Software/Visual_Studio/Tango.SharedUI/Converters/TimeSpanToDaysConverter.cs @@ -0,0 +1,23 @@ +using System; +using System.Collections.Generic; +using System.Globalization; +using System.Linq; +using System.Text; +using System.Threading.Tasks; +using System.Windows.Data; + +namespace Tango.SharedUI.Converters +{ + public class TimeSpanToDaysConverter : IValueConverter + { + public object Convert(object value, Type targetType, object parameter, CultureInfo culture) + { + return ((TimeSpan)value).TotalDays; + } + + public object ConvertBack(object value, Type targetType, object parameter, CultureInfo culture) + { + return TimeSpan.FromDays(double.Parse(value.ToString())); + } + } +} diff --git a/Software/Visual_Studio/Tango.SharedUI/Tango.SharedUI.csproj b/Software/Visual_Studio/Tango.SharedUI/Tango.SharedUI.csproj index edbb21a77..2b75d0531 100644 --- a/Software/Visual_Studio/Tango.SharedUI/Tango.SharedUI.csproj +++ b/Software/Visual_Studio/Tango.SharedUI/Tango.SharedUI.csproj @@ -143,6 +143,7 @@ <Compile Include="Converters\StringToOneLineConverter.cs" /> <Compile Include="Converters\StringToTitleCaseConverter.cs" /> <Compile Include="Converters\StringToWordsConverter.cs" /> + <Compile Include="Converters\TimeSpanToDaysConverter.cs" /> <Compile Include="Converters\TimeSpanToMinutesConverter.cs" /> <Compile Include="Converters\TimeSpanToSecondsConverter.cs" /> <Compile Include="Converters\TimeSpanToTwoDigitsTimeConverter.cs" /> @@ -258,7 +259,7 @@ <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> <ProjectExtensions> <VisualStudio> - <UserProperties BuildVersion_AssemblyInfoFilename="Properties\AssemblyInfo.cs" BuildVersion_UpdateAssemblyVersion="True" BuildVersion_BuildVersioningStyle="None.None.Increment.TimeStamp" BuildVersion_UseGlobalSettings="False" BuildVersion_StartDate="2000/1/1" /> + <UserProperties BuildVersion_StartDate="2000/1/1" BuildVersion_UseGlobalSettings="False" BuildVersion_BuildVersioningStyle="None.None.Increment.TimeStamp" BuildVersion_UpdateAssemblyVersion="True" BuildVersion_AssemblyInfoFilename="Properties\AssemblyInfo.cs" /> </VisualStudio> </ProjectExtensions> </Project>
\ No newline at end of file diff --git a/Software/Visual_Studio/Tango.Transport/Adapters/SignalRTransportAdapter.cs b/Software/Visual_Studio/Tango.Transport/Adapters/SignalRTransportAdapter.cs index de472d993..f2692426f 100644 --- a/Software/Visual_Studio/Tango.Transport/Adapters/SignalRTransportAdapter.cs +++ b/Software/Visual_Studio/Tango.Transport/Adapters/SignalRTransportAdapter.cs @@ -51,11 +51,6 @@ namespace Tango.Transport.Adapters public SignalRTransportAdapterMode Mode { get; set; } /// <summary> - /// Gets or sets a value indicating whether to enable compression/decompression of data. - /// </summary> - public bool EnableCompression { get; set; } - - /// <summary> /// Gets or sets the adapter connection timeout. /// </summary> public TimeSpan ConnectionTimeout { get; set; } @@ -300,7 +295,7 @@ namespace Tango.Transport.Adapters if (EnableCompression) { - var compressed = Compression.SevenZipHelper.Compress(data); + var compressed = Compression.GZipHelper.Compress(data); dataCollection.Add(compressed); } else @@ -341,7 +336,7 @@ namespace Tango.Transport.Adapters { if (EnableCompression) { - OnDataAvailable(Compression.SevenZipHelper.Decompress(data)); + OnDataAvailable(Compression.GZipHelper.Decompress(data)); } else { diff --git a/Software/Visual_Studio/Tango.Transport/Adapters/TcpTransportAdapter.cs b/Software/Visual_Studio/Tango.Transport/Adapters/TcpTransportAdapter.cs index 831f7c5dc..f4bfb0ba8 100644 --- a/Software/Visual_Studio/Tango.Transport/Adapters/TcpTransportAdapter.cs +++ b/Software/Visual_Studio/Tango.Transport/Adapters/TcpTransportAdapter.cs @@ -12,6 +12,7 @@ using System.Threading; using System.Threading.Tasks; using Tango.Core; using Tango.Logging; +using Tango.Transport.Compression; namespace Tango.Transport.Adapters { @@ -176,6 +177,11 @@ namespace Tango.Transport.Adapters try { + if (EnableCompression) + { + data = GZipHelper.Compress(data); + } + data = PostProcessBuffer(data); if (WriteMode == TcpTransportAdapterWriteMode.Direct || immidiate) @@ -241,6 +247,11 @@ namespace Tango.Transport.Adapters } } + if (EnableCompression) + { + data = GZipHelper.Decompress(data); + } + OnDataAvailable(data); } else diff --git a/Software/Visual_Studio/Tango.Transport/Compression/GZipHelper.cs b/Software/Visual_Studio/Tango.Transport/Compression/GZipHelper.cs new file mode 100644 index 000000000..5ec17a35f --- /dev/null +++ b/Software/Visual_Studio/Tango.Transport/Compression/GZipHelper.cs @@ -0,0 +1,42 @@ +using System; +using System.Collections.Generic; +using System.IO; +using System.IO.Compression; +using System.Linq; +using System.Text; +using System.Threading.Tasks; + +namespace Tango.Transport.Compression +{ + public static class GZipHelper + { + public static byte[] Compress(byte[] buffer) + { + using (MemoryStream ms = new MemoryStream()) + { + using (GZipStream zip = new GZipStream(ms, CompressionMode.Compress, true)) + { + zip.Write(buffer, 0, buffer.Length); + } + + return ms.ToArray(); + } + } + + public static byte[] Decompress(byte[] gzBuffer) + { + using (MemoryStream msOut = new MemoryStream()) + { + using (MemoryStream ms = new MemoryStream(gzBuffer)) + { + using (GZipStream zip = new GZipStream(ms, CompressionMode.Decompress)) + { + zip.CopyTo(msOut); + } + } + + return msOut.ToArray(); + } + } + } +} diff --git a/Software/Visual_Studio/Tango.Transport/GenericMessageSerializer.cs b/Software/Visual_Studio/Tango.Transport/GenericMessageSerializer.cs index aa3486dc3..55d07ef37 100644 --- a/Software/Visual_Studio/Tango.Transport/GenericMessageSerializer.cs +++ b/Software/Visual_Studio/Tango.Transport/GenericMessageSerializer.cs @@ -1,5 +1,6 @@ using Google.Protobuf; using Newtonsoft.Json; +using Newtonsoft.Json.Bson; using ProtoBuf; using System; using System.Collections.Generic; @@ -18,6 +19,7 @@ namespace Tango.Transport public enum GenericMessageSerializerMode { Json, + Bson, Protobuf } @@ -25,6 +27,7 @@ namespace Tango.Transport static GenericMessageSerializer() { + Mode = GenericMessageSerializerMode.Bson; ProtoBuf.Meta.RuntimeTypeModel.Default.AutoAddMissingTypes = true; ProtoBuf.Meta.RuntimeTypeModel.Default.AutoAddProtoContractTypesOnly = false; ProtoBuf.Meta.RuntimeTypeModel.Default.InferTagFromNameDefault = true; @@ -37,6 +40,10 @@ namespace Tango.Transport { return JsonConvert.DeserializeObject(Encoding.UTF8.GetString(array), type); } + else if (Mode == GenericMessageSerializerMode.Bson) + { + return DeserializeFromBson(array, type); + } else { AutoProtobuf.Build(type); @@ -54,6 +61,10 @@ namespace Tango.Transport { return JsonConvert.DeserializeObject(byteString.ToStringUtf8(), type); } + else if (Mode == GenericMessageSerializerMode.Bson) + { + return DeserializeFromBson(byteString.ToByteArray(), type); + } else { AutoProtobuf.Build(type); @@ -69,6 +80,10 @@ namespace Tango.Transport { return Encoding.UTF8.GetBytes(JsonConvert.SerializeObject(message)); } + else if (Mode == GenericMessageSerializerMode.Bson) + { + return SerializeToBson(message); + } else { AutoProtobuf.Build<T>(); @@ -87,6 +102,10 @@ namespace Tango.Transport { return (T)Deserialize(typeof(T), array); } + else if (Mode == GenericMessageSerializerMode.Bson) + { + return DeserializeFromBson<T>(array); + } else { AutoProtobuf.Build<T>(); @@ -102,8 +121,14 @@ namespace Tango.Transport { if (Mode == GenericMessageSerializerMode.Json) { - return ByteString.CopyFromUtf8(JsonConvert.SerializeObject(message)); + var byteString = ByteString.CopyFromUtf8(JsonConvert.SerializeObject(message)); + return byteString; } + else if (Mode == GenericMessageSerializerMode.Bson) + { + var byteString = ByteString.CopyFrom(SerializeToBson(message)); + return byteString; + } else { AutoProtobuf.Build<T>(); @@ -118,6 +143,10 @@ namespace Tango.Transport { return JsonConvert.DeserializeObject<T>(byteString.ToStringUtf8()); } + else if (Mode == GenericMessageSerializerMode.Bson) + { + return DeserializeFromBson<T>(byteString.ToByteArray()); + } else { AutoProtobuf.Build<T>(); @@ -133,5 +162,38 @@ namespace Tango.Transport var innerMessage = DeserializeFromByteString(genericType, (message as GenericRequest).Data); return innerMessage as T; } + + private static byte[] SerializeToBson(Object obj) + { + MemoryStream ms = new MemoryStream(); + using (BsonWriter writer = new BsonWriter(ms)) + { + JsonSerializer serializer = new JsonSerializer(); + serializer.Serialize(writer, obj); + return ms.ToArray(); + } + } + + private static Object DeserializeFromBson(byte[] data, Type type) + { + MemoryStream ms = new MemoryStream(data); + using (BsonReader reader = new BsonReader(ms)) + { + JsonSerializer serializer = new JsonSerializer(); + Object obj = serializer.Deserialize(reader, type); + return obj; + } + } + + private static T DeserializeFromBson<T>(byte[] data) + { + MemoryStream ms = new MemoryStream(data); + using (BsonReader reader = new BsonReader(ms)) + { + JsonSerializer serializer = new JsonSerializer(); + T obj = serializer.Deserialize<T>(reader); + return obj; + } + } } } diff --git a/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs b/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs index 1c397aae3..3c5bed9d0 100644 --- a/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs +++ b/Software/Visual_Studio/Tango.Transport/ITransportAdapter.cs @@ -36,6 +36,11 @@ namespace Tango.Transport long TransferRate { get; } /// <summary> + /// Gets or sets a value indicating whether to enable compression/decompression of data. + /// </summary> + bool EnableCompression { get; set; } + + /// <summary> /// Writes the specified data to the stream. /// </summary> /// <param name="data">The data.</param> diff --git a/Software/Visual_Studio/Tango.Transport/Tango.Transport.csproj b/Software/Visual_Studio/Tango.Transport/Tango.Transport.csproj index 8ed8c0345..2521daa2f 100644 --- a/Software/Visual_Studio/Tango.Transport/Tango.Transport.csproj +++ b/Software/Visual_Studio/Tango.Transport/Tango.Transport.csproj @@ -102,6 +102,7 @@ <Compile Include="Compression\Compress\RangeCoder\RangeCoder.cs" /> <Compile Include="Compression\Compress\RangeCoder\RangeCoderBit.cs" /> <Compile Include="Compression\Compress\RangeCoder\RangeCoderBitTree.cs" /> + <Compile Include="Compression\GZipHelper.cs" /> <Compile Include="Compression\ICoder.cs" /> <Compile Include="Compression\SevenZipHelper.cs" /> <Compile Include="ContinuousResponseAbortedException.cs" /> @@ -187,7 +188,7 @@ <Import Project="$(MSBuildToolsPath)\Microsoft.CSharp.targets" /> <ProjectExtensions> <VisualStudio> - <UserProperties BuildVersion_StartDate="2000/1/1" BuildVersion_UseGlobalSettings="False" BuildVersion_BuildVersioningStyle="None.None.Increment.TimeStamp" BuildVersion_UpdateAssemblyVersion="True" BuildVersion_AssemblyInfoFilename="Properties\AssemblyInfo.cs" /> + <UserProperties BuildVersion_AssemblyInfoFilename="Properties\AssemblyInfo.cs" BuildVersion_UpdateAssemblyVersion="True" BuildVersion_BuildVersioningStyle="None.None.Increment.TimeStamp" BuildVersion_UseGlobalSettings="False" BuildVersion_StartDate="2000/1/1" /> </VisualStudio> </ProjectExtensions> </Project>
\ No newline at end of file diff --git a/Software/Visual_Studio/Tango.Transport/TransportAdapterBase.cs b/Software/Visual_Studio/Tango.Transport/TransportAdapterBase.cs index ebae5855a..09acc4ea5 100644 --- a/Software/Visual_Studio/Tango.Transport/TransportAdapterBase.cs +++ b/Software/Visual_Studio/Tango.Transport/TransportAdapterBase.cs @@ -109,6 +109,11 @@ namespace Tango.Transport } } + /// <summary> + /// Gets or sets a value indicating whether to enable compression/decompression of data. + /// </summary> + public bool EnableCompression { get; set; } + #endregion #region Virtual Methods diff --git a/Software/Visual_Studio/Tango.WebRTC/WebRtcTransportAdapter.cs b/Software/Visual_Studio/Tango.WebRTC/WebRtcTransportAdapter.cs index 69d9fb6ae..606f8d5c8 100644 --- a/Software/Visual_Studio/Tango.WebRTC/WebRtcTransportAdapter.cs +++ b/Software/Visual_Studio/Tango.WebRTC/WebRtcTransportAdapter.cs @@ -8,6 +8,7 @@ using Tango.Core; using Tango.Core.Threading; using Tango.Transport; using Tango.Transport.Adapters; +using Tango.Transport.Compression; using Tango.WebRTC.Network; namespace Tango.WebRTC @@ -49,6 +50,11 @@ namespace Tango.WebRTC try { + if (EnableCompression) + { + data = GZipHelper.Compress(data); + } + _client.SendBinary(data); } catch (Exception ex) @@ -189,7 +195,15 @@ namespace Tango.WebRTC private void WebRtc_BinaryMessageReceived(object sender, DataMessageReceivedEventArgs<byte[]> e) { - OnDataAvailable(e.Data); + if (EnableCompression) + { + var decompressed = GZipHelper.Decompress(e.Data); + OnDataAvailable(decompressed); + } + else + { + OnDataAvailable(e.Data); + } } private async void OnOfferRequestReceived(ITransporter transporter, OfferRequest request, string token) diff --git a/Software/Visual_Studio/Web/Tango.MachineService/Properties/AssemblyInfo.cs b/Software/Visual_Studio/Web/Tango.MachineService/Properties/AssemblyInfo.cs index 704da0c08..80b01d98e 100644 --- a/Software/Visual_Studio/Web/Tango.MachineService/Properties/AssemblyInfo.cs +++ b/Software/Visual_Studio/Web/Tango.MachineService/Properties/AssemblyInfo.cs @@ -24,4 +24,4 @@ using System.Runtime.InteropServices; // // You can specify all the values or you can default the Revision and Build Numbers // by using the '*' as shown below: -[assembly: AssemblyVersion("3.0.2.0")] +[assembly: AssemblyVersion("3.0.3.0")] |