Class StockChartBuilder

Inheritance

System.Object

ControlBuilder

StockChartBuilder

Inherited Members

ControlBuilder.Context

System.Object.ToString()

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

Namespace: Syncfusion.EJ2.Charts

Assembly: Syncfusion.EJ2.dll

Syntax

public class StockChartBuilder : ControlBuilder

Constructors

StockChartBuilder()

Declaration

public StockChartBuilder()

StockChartBuilder(StockChart)

Declaration

public StockChartBuilder(StockChart model)

Parameters

Type	Name	Description
StockChart	model

Fields

model

Declaration

public StockChart model

Field Value

Type	Description
StockChart

Properties

HtmlAttr

Declaration

public IDictionary<string, object> HtmlAttr { get; set; }

Property Value

Type	Description
System.Collections.Generic.IDictionary<System.String, System.Object>

ID

Declaration

public string ID { get; set; }

Property Value

Type	Description
System.String

Output

Declaration

public override TextWriter Output { get; set; }

Property Value

Type	Description
System.IO.TextWriter

Overrides

ControlBuilder.Output

Methods

Annotations(Action<StockChartAnnotationSettingsBuilder>)

Declaration

public StockChartBuilder Annotations(Action<StockChartAnnotationSettingsBuilder> annotations)

Parameters

Type	Name	Description
System.Action<StockChartAnnotationSettingsBuilder>	annotations

Returns

Type	Description
StockChartBuilder

Annotations(List<StockChartAnnotationSettings>)

The configuration for annotation in chart.

Declaration

public StockChartBuilder Annotations(List<StockChartAnnotationSettings> annotations)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartAnnotationSettings>	annotations

Returns

Type	Description
StockChartBuilder

Axes(Action<StockChartStockChartAxisBuilder>)

Declaration

public StockChartBuilder Axes(Action<StockChartStockChartAxisBuilder> axes)

Parameters

Type	Name	Description
System.Action<StockChartStockChartAxisBuilder>	axes

Returns

Type	Description
StockChartBuilder

Axes(List<StockChartStockChartAxis>)

Secondary axis collection for the stockChart.

Declaration

public StockChartBuilder Axes(List<StockChartStockChartAxis> axes)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockChartAxis>	axes

Returns

Type	Description
StockChartBuilder

AxisLabelRender(String)

Triggers before each axis label is rendered.

Declaration

public StockChartBuilder AxisLabelRender(string axisLabelRender)

Parameters

Type	Name	Description
System.String	axisLabelRender

Returns

Type	Description
StockChartBuilder

Background(String)

The background color of the stockChart that accepts value in hex and rgba as a valid CSS color string.

Declaration

public StockChartBuilder Background(string background)

Parameters

Type	Name	Description
System.String	background

Returns

Type	Description
StockChartBuilder

Border(StockChartChartBorder)

Options for customizing the color and width of the stockChart border.

Declaration

public StockChartBuilder Border(StockChartChartBorder border)

Parameters

Type	Name	Description
StockChartChartBorder	border

Returns

Type	Description
StockChartBuilder

Border(Action<StockChartBorderBuilder>)

Declaration

public StockChartBuilder Border(Action<StockChartBorderBuilder> border)

Parameters

Type	Name	Description
System.Action<StockChartBorderBuilder>	border

Returns

Type	Description
StockChartBuilder

ChartArea(StockChartChartArea)

Options for configuring the border and background of the stockChart area.

Declaration

public StockChartBuilder ChartArea(StockChartChartArea chartArea)

Parameters

Type	Name	Description
StockChartChartArea	chartArea

Returns

Type	Description
StockChartBuilder

ChartArea(Action<StockChartChartAreaBuilder>)

Declaration

public StockChartBuilder ChartArea(Action<StockChartChartAreaBuilder> chartArea)

Parameters

Type	Name	Description
System.Action<StockChartChartAreaBuilder>	chartArea

Returns

Type	Description
StockChartBuilder

Crosshair(StockChartCrosshairSettings)

Options for customizing the crosshair of the chart.

Declaration

public StockChartBuilder Crosshair(StockChartCrosshairSettings crosshair)

Parameters

Type	Name	Description
StockChartCrosshairSettings	crosshair

Returns

Type	Description
StockChartBuilder

Crosshair(Action<StockChartCrosshairSettingsBuilder>)

Declaration

public StockChartBuilder Crosshair(Action<StockChartCrosshairSettingsBuilder> crosshair)

Parameters

Type	Name	Description
System.Action<StockChartCrosshairSettingsBuilder>	crosshair

Returns

Type	Description
StockChartBuilder

DataSource(Action<DataManagerBuilder>)

Declaration

public StockChartBuilder DataSource(Action<DataManagerBuilder> dataSource)

Parameters

Type	Name	Description
System.Action<DataManagerBuilder>	dataSource

Returns

Type	Description
StockChartBuilder

DataSource(Object)

Specifies the DataSource for the stockChart. It can be an array of JSON objects or an instance of DataManager.

Declaration

public StockChartBuilder DataSource(object dataSource)

Parameters

Type	Name	Description
System.Object	dataSource

Returns

Type	Description
StockChartBuilder

EnableCustomRange(Boolean)

Custom Range

Declaration

public StockChartBuilder EnableCustomRange(bool enableCustomRange = true)

Parameters

Type	Name	Description
System.Boolean	enableCustomRange

Returns

Type	Description
StockChartBuilder

EnablePeriodSelector(Boolean)

It specifies whether the periodSelector to be rendered in financial chart

Declaration

public StockChartBuilder EnablePeriodSelector(bool enablePeriodSelector = true)

Parameters

Type	Name	Description
System.Boolean	enablePeriodSelector

Returns

Type	Description
StockChartBuilder

EnablePersistence(Boolean)

Enable or disable persisting component's state between page reloads.

Declaration

public StockChartBuilder EnablePersistence(bool enablePersistence = true)

Parameters

Type	Name	Description
System.Boolean	enablePersistence

Returns

Type	Description
StockChartBuilder

EnableRtl(Boolean)

Enable or disable rendering component in right to left direction.

Declaration

public StockChartBuilder EnableRtl(bool enableRtl = true)

Parameters

Type	Name	Description
System.Boolean	enableRtl

Returns

Type	Description
StockChartBuilder

EnableSelector(Boolean)

It specifies whether the range navigator to be rendered in financial chart

Declaration

public StockChartBuilder EnableSelector(bool enableSelector = true)

Parameters

Type	Name	Description
System.Boolean	enableSelector

Returns

Type	Description
StockChartBuilder

ExportType(Object)

It specifies the types of Export types in financial chart.

Declaration

public StockChartBuilder ExportType(object exportType)

Parameters

Type	Name	Description
System.Object	exportType

Returns

Type	Description
StockChartBuilder

Height(String)

The height of the stockChart as a string accepts input both as '100px' or '100%'. If specified as '100%, stockChart renders to the full height of its parent element.

Declaration

public StockChartBuilder Height(string height)

Parameters

Type	Name	Description
System.String	height

Returns

Type	Description
StockChartBuilder

HtmlAttributes(Object)

Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.

Declaration

public StockChartBuilder HtmlAttributes(object htmlAttributes)

Parameters

Type	Name	Description
System.Object	htmlAttributes

Returns

Type	Description
StockChartBuilder

Indicators(Action<StockChartStockChartIndicatorBuilder>)

Declaration

public StockChartBuilder Indicators(Action<StockChartStockChartIndicatorBuilder> indicators)

Parameters

Type	Name	Description
System.Action<StockChartStockChartIndicatorBuilder>	indicators

Returns

Type	Description
StockChartBuilder

Indicators(List<StockChartStockChartIndicator>)

Defines the collection of technical indicators, that are used in financial markets.

Declaration

public StockChartBuilder Indicators(List<StockChartStockChartIndicator> indicators)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockChartIndicator>	indicators

Returns

Type	Description
StockChartBuilder

IndicatorType(Object)

It specifies the types of indicators in financial chart.

Declaration

public StockChartBuilder IndicatorType(object indicatorType)

Parameters

Type	Name	Description
System.Object	indicatorType

Returns

Type	Description
StockChartBuilder

IsMultiSelect(Boolean)

If set true, enables the multi selection in chart. It requires selectionMode to be Point | Series | or Cluster.

Declaration

public StockChartBuilder IsMultiSelect(bool isMultiSelect = true)

Parameters

Type	Name	Description
System.Boolean	isMultiSelect

Returns

Type	Description
StockChartBuilder

IsSelect(Boolean)

If set true, enables the animation in chart.

Declaration

public StockChartBuilder IsSelect(bool isSelect = true)

Parameters

Type	Name	Description
System.Boolean	isSelect

Returns

Type	Description
StockChartBuilder

IsTransposed(Boolean)

It specifies whether the stockChart should be render in transposed manner or not.

Declaration

public StockChartBuilder IsTransposed(bool isTransposed = true)

Parameters

Type	Name	Description
System.Boolean	isTransposed

Returns

Type	Description
StockChartBuilder

LegendClick(String)

Triggers after click on legend.

Declaration

public StockChartBuilder LegendClick(string legendClick)

Parameters

Type	Name	Description
System.String	legendClick

Returns

Type	Description
StockChartBuilder

LegendRender(String)

Triggers before the legend is rendered.

Declaration

public StockChartBuilder LegendRender(string legendRender)

Parameters

Type	Name	Description
System.String	legendRender

Returns

Type	Description
StockChartBuilder

LegendSettings(StockChartStockChartLegendSettings)

Options for customizing the legend of the stockChart.

Declaration

public StockChartBuilder LegendSettings(StockChartStockChartLegendSettings legendSettings)

Parameters

Type	Name	Description
StockChartStockChartLegendSettings	legendSettings

Returns

Type	Description
StockChartBuilder

LegendSettings(Action<StockChartStockChartLegendSettingsBuilder>)

Declaration

public StockChartBuilder LegendSettings(Action<StockChartStockChartLegendSettingsBuilder> legendSettings)

Parameters

Type	Name	Description
System.Action<StockChartStockChartLegendSettingsBuilder>	legendSettings

Returns

Type	Description
StockChartBuilder

Load(String)

Triggers before the range navigator rendering.

Declaration

public StockChartBuilder Load(string load)

Parameters

Type	Name	Description
System.String	load

Returns

Type	Description
StockChartBuilder

Loaded(String)

Triggers after the range navigator rendering.

Declaration

public StockChartBuilder Loaded(string loaded)

Parameters

Type	Name	Description
System.String	loaded

Returns

Type	Description
StockChartBuilder

Locale(String)

Overrides the global culture and localization value for this component. Default global culture is 'en-US'.

Declaration

public StockChartBuilder Locale(string locale)

Parameters

Type	Name	Description
System.String	locale

Returns

Type	Description
StockChartBuilder

Margin(StockChartChartMargin)

Options to customize left, right, top and bottom margins of the stockChart.

Declaration

public StockChartBuilder Margin(StockChartChartMargin margin)

Parameters

Type	Name	Description
StockChartChartMargin	margin

Returns

Type	Description
StockChartBuilder

Margin(Action<StockChartMarginBuilder>)

Declaration

public StockChartBuilder Margin(Action<StockChartMarginBuilder> margin)

Parameters

Type	Name	Description
System.Action<StockChartMarginBuilder>	margin

Returns

Type	Description
StockChartBuilder

OnZooming(String)

Triggers after the zoom selection is completed.

Declaration

public StockChartBuilder OnZooming(string onZooming)

Parameters

Type	Name	Description
System.String	onZooming

Returns

Type	Description
StockChartBuilder

Periods(Action<StockChartStockChartPeriodBuilder>)

Declaration

public StockChartBuilder Periods(Action<StockChartStockChartPeriodBuilder> periods)

Parameters

Type	Name	Description
System.Action<StockChartStockChartPeriodBuilder>	periods

Returns

Type	Description
StockChartBuilder

Periods(List<StockChartStockChartPeriod>)

To configure period selector options.

Declaration

public StockChartBuilder Periods(List<StockChartStockChartPeriod> periods)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockChartPeriod>	periods

Returns

Type	Description
StockChartBuilder

PointClick(String)

Triggers on point click.

Declaration

public StockChartBuilder PointClick(string pointClick)

Parameters

Type	Name	Description
System.String	pointClick

Returns

Type	Description
StockChartBuilder

PointMove(String)

Triggers on point move.

Declaration

public StockChartBuilder PointMove(string pointMove)

Parameters

Type	Name	Description
System.String	pointMove

Returns

Type	Description
StockChartBuilder

PrimaryXAxis(StockChartPrimaryXAxis)

Options to configure the horizontal axis.

Declaration

public StockChartBuilder PrimaryXAxis(StockChartPrimaryXAxis primaryXAxis)

Parameters

Type	Name	Description
StockChartPrimaryXAxis	primaryXAxis

Returns

Type	Description
StockChartBuilder

PrimaryXAxis(Action<StockChartStockChartAxisBuilder>)

Declaration

public StockChartBuilder PrimaryXAxis(Action<StockChartStockChartAxisBuilder> primaryXAxis)

Parameters

Type	Name	Description
System.Action<StockChartStockChartAxisBuilder>	primaryXAxis

Returns

Type	Description
StockChartBuilder

PrimaryYAxis(StockChartPrimaryYAxis)

Options to configure the vertical axis.

Declaration

public StockChartBuilder PrimaryYAxis(StockChartPrimaryYAxis primaryYAxis)

Parameters

Type	Name	Description
StockChartPrimaryYAxis	primaryYAxis

Returns

Type	Description
StockChartBuilder

PrimaryYAxis(Action<StockChartStockChartAxisBuilder>)

Declaration

public StockChartBuilder PrimaryYAxis(Action<StockChartStockChartAxisBuilder> primaryYAxis)

Parameters

Type	Name	Description
System.Action<StockChartStockChartAxisBuilder>	primaryYAxis

Returns

Type	Description
StockChartBuilder

RangeChange(String)

Triggers if the range is changed

Declaration

public StockChartBuilder RangeChange(string rangeChange)

Parameters

Type	Name	Description
System.String	rangeChange

Returns

Type	Description
StockChartBuilder

Render()

Declaration

public HtmlString Render()

Returns

Type	Description
System.Web.HtmlString

Rows(Action<StockChartStockChartRowBuilder>)

Declaration

public StockChartBuilder Rows(Action<StockChartStockChartRowBuilder> rows)

Parameters

Type	Name	Description
System.Action<StockChartStockChartRowBuilder>	rows

Returns

Type	Description
StockChartBuilder

Rows(List<StockChartStockChartRow>)

Options to split stockChart into multiple plotting areas horizontally. Each object in the collection represents a plotting area in the stockChart.

Declaration

public StockChartBuilder Rows(List<StockChartStockChartRow> rows)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockChartRow>	rows

Returns

Type	Description
StockChartBuilder

SelectedDataIndexes(Action<StockChartStockChartSelectedDataIndexBuilder>)

Declaration

public StockChartBuilder SelectedDataIndexes(Action<StockChartStockChartSelectedDataIndexBuilder> selectedDataIndexes)

Parameters

Type	Name	Description
System.Action<StockChartStockChartSelectedDataIndexBuilder>	selectedDataIndexes

Returns

Type	Description
StockChartBuilder

SelectedDataIndexes(List<StockChartStockChartSelectedDataIndex>)

Specifies the point indexes to be selected while loading a chart. It requires selectionMode to be Point | Series | or Cluster.

Declaration

public StockChartBuilder SelectedDataIndexes(List<StockChartStockChartSelectedDataIndex> selectedDataIndexes)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockChartSelectedDataIndex>	selectedDataIndexes

Returns

Type	Description
StockChartBuilder

SelectionMode(SelectionMode)

Specifies whether series or data point has to be selected. They are, none: Disables the selection. series: selects a series. point: selects a point. cluster: selects a cluster of point dragXY: selects points by dragging with respect to both horizontal and vertical axes dragX: selects points by dragging with respect to horizontal axis. dragY: selects points by dragging with respect to vertical axis.

Declaration

public StockChartBuilder SelectionMode(SelectionMode selectionMode)

Parameters

Type	Name	Description
SelectionMode	selectionMode

Returns

Type	Description
StockChartBuilder

SelectorRender(String)

Triggers before render the selector

Declaration

public StockChartBuilder SelectorRender(string selectorRender)

Parameters

Type	Name	Description
System.String	selectorRender

Returns

Type	Description
StockChartBuilder

Series(Action<StockChartStockChartSeriesBuilder>)

Declaration

public StockChartBuilder Series(Action<StockChartStockChartSeriesBuilder> series)

Parameters

Type	Name	Description
System.Action<StockChartStockChartSeriesBuilder>	series

Returns

Type	Description
StockChartBuilder

Series(List<StockChartStockChartSeries>)

The configuration for series in the stockChart.

Declaration

public StockChartBuilder Series(List<StockChartStockChartSeries> series)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockChartSeries>	series

Returns

Type	Description
StockChartBuilder

SeriesRender(String)

Triggers before the series is rendered.

Declaration

public StockChartBuilder SeriesRender(string seriesRender)

Parameters

Type	Name	Description
System.String	seriesRender

Returns

Type	Description
StockChartBuilder

SeriesType(Object)

It specifies the types of series in financial chart.

Declaration

public StockChartBuilder SeriesType(object seriesType)

Parameters

Type	Name	Description
System.Object	seriesType

Returns

Type	Description
StockChartBuilder

StockChartMouseClick(String)

Triggers on clicking the stock chart.

Declaration

public StockChartBuilder StockChartMouseClick(string stockChartMouseClick)

Parameters

Type	Name	Description
System.String	stockChartMouseClick

Returns

Type	Description
StockChartBuilder

StockChartMouseDown(String)

Triggers on mouse down.

Declaration

public StockChartBuilder StockChartMouseDown(string stockChartMouseDown)

Parameters

Type	Name	Description
System.String	stockChartMouseDown

Returns

Type	Description
StockChartBuilder

StockChartMouseLeave(String)

Triggers when cursor leaves the chart.

Declaration

public StockChartBuilder StockChartMouseLeave(string stockChartMouseLeave)

Parameters

Type	Name	Description
System.String	stockChartMouseLeave

Returns

Type	Description
StockChartBuilder

StockChartMouseMove(String)

Triggers on hovering the stock chart.

Declaration

public StockChartBuilder StockChartMouseMove(string stockChartMouseMove)

Parameters

Type	Name	Description
System.String	stockChartMouseMove

Returns

Type	Description
StockChartBuilder

StockChartMouseUp(String)

Triggers on mouse up.

Declaration

public StockChartBuilder StockChartMouseUp(string stockChartMouseUp)

Parameters

Type	Name	Description
System.String	stockChartMouseUp

Returns

Type	Description
StockChartBuilder

StockEventRender(String)

Triggers before the series is rendered.

Declaration

public StockChartBuilder StockEventRender(string stockEventRender)

Parameters

Type	Name	Description
System.String	stockEventRender

Returns

Type	Description
StockChartBuilder

StockEvents(Action<StockChartStockEventBuilder>)

Declaration

public StockChartBuilder StockEvents(Action<StockChartStockEventBuilder> stockEvents)

Parameters

Type	Name	Description
System.Action<StockChartStockEventBuilder>	stockEvents

Returns

Type	Description
StockChartBuilder

StockEvents(List<StockChartStockEvent>)

The configuration for stock events in the stockChart.

Declaration

public StockChartBuilder StockEvents(List<StockChartStockEvent> stockEvents)

Parameters

Type	Name	Description
System.Collections.Generic.List<StockChartStockEvent>	stockEvents

Returns

Type	Description
StockChartBuilder

Theme(ChartTheme)

Specifies the theme for the stockChart.

Declaration

public StockChartBuilder Theme(ChartTheme theme)

Parameters

Type	Name	Description
ChartTheme	theme

Returns

Type	Description
StockChartBuilder

Title(String)

Title of the chart

Declaration

public StockChartBuilder Title(string title)

Parameters

Type	Name	Description
System.String	title

Returns

Type	Description
StockChartBuilder

TitleStyle(StockChartTitleStyle)

Options for customizing the title of the Chart.

Declaration

public StockChartBuilder TitleStyle(StockChartTitleStyle titleStyle)

Parameters

Type	Name	Description
StockChartTitleStyle	titleStyle

Returns

Type	Description
StockChartBuilder

TitleStyle(Action<StockChartFontBuilder>)

Declaration

public StockChartBuilder TitleStyle(Action<StockChartFontBuilder> titleStyle)

Parameters

Type	Name	Description
System.Action<StockChartFontBuilder>	titleStyle

Returns

Type	Description
StockChartBuilder

Tooltip(StockChartTooltipSettings)

Options for customizing the tooltip of the chart.

Declaration

public StockChartBuilder Tooltip(StockChartTooltipSettings tooltip)

Parameters

Type	Name	Description
StockChartTooltipSettings	tooltip

Returns

Type	Description
StockChartBuilder

Tooltip(Action<StockChartTooltipSettingsBuilder>)

Declaration

public StockChartBuilder Tooltip(Action<StockChartTooltipSettingsBuilder> tooltip)

Parameters

Type	Name	Description
System.Action<StockChartTooltipSettingsBuilder>	tooltip

Returns

Type	Description
StockChartBuilder

TooltipRender(String)

Triggers before the tooltip for series is rendered.

Declaration

public StockChartBuilder TooltipRender(string tooltipRender)

Parameters

Type	Name	Description
System.String	tooltipRender

Returns

Type	Description
StockChartBuilder

TrendlineType(Object)

It specifies the types of trendline types in financial chart.

Declaration

public StockChartBuilder TrendlineType(object trendlineType)

Parameters

Type	Name	Description
System.Object	trendlineType

Returns

Type	Description
StockChartBuilder

Width(String)

The width of the stockChart as a string accepts input as both like '100px' or '100%'. If specified as '100%, stockChart renders to the full width of its parent element.

Declaration

public StockChartBuilder Width(string width)

Parameters

Type	Name	Description
System.String	width

Returns

Type	Description
StockChartBuilder

ZoomSettings(StockChartZoomSettings)

Options to enable the zooming feature in the chart.

Declaration

public StockChartBuilder ZoomSettings(StockChartZoomSettings zoomSettings)

Parameters

Type	Name	Description
StockChartZoomSettings	zoomSettings

Returns

Type	Description
StockChartBuilder

ZoomSettings(Action<StockChartZoomSettingsBuilder>)

Declaration

public StockChartBuilder ZoomSettings(Action<StockChartZoomSettingsBuilder> zoomSettings)

Parameters

Type	Name	Description
System.Action<StockChartZoomSettingsBuilder>	zoomSettings

Returns

Type	Description
StockChartBuilder