DXEnvelopeIndicator Class

The Envelope overlay indicator.

Namespace: DevExpress.Xamarin.iOS.Charts

Assembly: DevExpress.Xamarin.iOS.Charts.dll

Declaration

public class DXEnvelopeIndicator :
    DXCalculatedSeries

Remarks

This indicator looks as follows:

Envelope Indicator Sample

How to: Specify Indicator Data

This example demonstrates how to implement the calculated series' data source:

// In the ViewDidLoad method.
DXStockSeries stockSeries = InitStock();
this.chart.AddSeries(stockSeries);
this.indicatorChart.AddSeries(
    new DXEnvelopeIndicator {
        Data = new CalculatedSeriesData(stockSeries),
        PointsCount = 20,
        ValueLevel = DXValueLevel.Close,
        DisplayName = "Envelope",
        LegendTextPattern = "{S} (21)",
        ShowInLegend = true
    }
);
// ...

public class CalculatedSeriesData: DXCalculatedSeriesData {
    DXSeries series;    
    public CalculatedSeriesData(DXSeries series) {
        this.series = series;
    }
    public override DXSeries Source => series;
}

The code above uses the classes and members below:

Symbol

Description

DXEnvelopeIndicator

The Envelope overlay indicator.

DXSeries.Data

Gets or sets data the series display on the Chart.

DXEnvelopeIndicator.PointsCount

DXEnvelopeIndicator.ValueLevel

NOTE

The indicator does not require any specific type of the source series' data. The only limitation is the number of source data points should be larger than or equal to PointsCount.

How to: Configure Indicator Hint Options

The chart Hint interacts with series to request values to display, to ask series what axis lines the Crosshair should display, etc:

Hint Options Sample

The following code specifies how the hint displays the series:

series.HintOptions = new DXSeriesCrosshairOptions {
    PointTextPattern = "{S}\r\nL: ${LV$#.#}\r\nU: ${UV$#.#}",
    ShowInLabel = true,
    AxisLineHidden = false,
    AxisLabelHidden = false,
};

The series can utilize the classes and properties below to configure how the hint displays it:

Symbol

Description

HintOptions

DXSeriesCrosshairOptions

DXSeriesHintOptionsBase.PointTextPattern

DXSeriesCrosshairOptions.ShowInLabel

DXSeriesCrosshairOptions.AxisLineHidden

DXSeriesCrosshairOptions.AxisLabelHidden

NOTE

Properties the DXSeriesCrosshairOptions class introduces do not affect the hint when the hint's Behavior is set to DXTooltipHintBehavior. At the same time, all properties the class inherits from its parent influence the hint.

How to: Manage the Indicator Appearance

The series style provides the following parameters that specify a series' appearance:

Area Series Appearance

The code below customizes the MACD indicator's appearance:

indicator.Style = new DXEnvelopeIndicatorStyle {
    UpperStroke = UIColor.FromWhiteAlpha(0.459f, 1.0f),
    UpperStrokeThickness = 1,
    LowerStroke = UIColor.FromWhiteAlpha(0.459f, 1.0f),
    LowerStrokeThickness = 1,
};

This code utilizes the following classes and members:

Symbol

Description

DXEnvelopeIndicator.Style

DXEnvelopeIndicatorStyle

DXEnvelopeIndicatorStyle.UpperStroke

DXEnvelopeIndicatorStyle.UpperStrokeThickness

DXEnvelopeIndicatorStyle.LowerStroke

DXEnvelopeIndicatorStyle.LowerStrokeThickness

Implements

IEquatable<Foundation.NSObject>
Foundation.INSObjectProtocol
ObjCRuntime.INativeObject

Inheritance

See Also