import { ESeriesType } from "../../../types/SeriesType"; import { TSciChart } from "../../../types/TSciChart"; import { StackedMountainRenderableSeries } from "./StackedMountainRenderableSeries"; import { IStackedXyCollectionOptions, StackedXyCollection } from "./StackedXyCollection"; /** * @summary A {@link StackedMountainCollection} allows grouping multiple {@link StackedMountainRenderableSeries} * to create a JavaScript Stacked Mountain chart, or 100% Stacked Mountain chart * @description * Multiple {@link StackedMountainRenderableSeries} are required to create a stacked mountain chart type in SciChart. * These are grouped with a {@link StackedMountainCollection}, which implements {@link IRenderableSeries} and may be added * directly to a {@link SciChartSurface.renderableSeries} collection. * * Code sample below: * ```ts * const stackedMountain0 = new StackedMountainRenderableSeries(wasmContext); * // .. configure mountain 1, including set dataSeries * const stackedMountain1 = new StackedMountainRenderableSeries(wasmContext); * // .. configure mountain 2, including set dataSeries * const stackedMountain2 = new StackedMountainRenderableSeries(wasmContext); * // .. configure mountain 3, including set dataSeries * const stackedMountainCollection = new StackedMountainCollection(wasmContext); * stackedMountainCollection.add(stackedMountain0, stackedMountain1, stackedMountain2); * * sciChartSurface.renderableSeries.add(stackedMountainCollection); * ```` * @remarks This type implements {@link IRenderableSeries} but it is not a renderable series, instead it wraps multiple * {@link StackedMountainRenderableSeries} to create a stacked mountain chart * * --- * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/stacked-mountain-renderable-series/} */ export declare class StackedMountainCollection extends StackedXyCollection { readonly type: ESeriesType; /** * Creates an instance of the {@link StackedMountainCollection} * @param webAssemblyContext The {@link TSciChart | SciChart WebAssembly Context} containing * native methods and access to our WebGL2 WebAssembly Drawing Engine * @param options Optional parameters of type {@link IStackedXyCollectionOptions} to configure the series * * --- * 📚 Docs: {@link https://www.scichart.com/documentation/js/v4/2d-charts/chart-types/stacked-mountain-renderable-series/} */ constructor(webAssemblyContext: TSciChart, options?: IStackedXyCollectionOptions); }