UNPKG

3.16 kBTypeScriptView Raw
1/**
2 * Module, defining Axis Renderer for vertical 3D axes.
3 */
4/**
5 * ============================================================================
6 * IMPORTS
7 * ============================================================================
8 * @hidden
9 */
10import { AxisRendererY, IAxisRendererYProperties, IAxisRendererYAdapters, IAxisRendererYEvents } from "../axes/AxisRendererY";
11import { Sprite, ISpriteEvents, AMEvent } from "../../core/Sprite";
12import { XYChart3D } from "../types/XYChart3D";
13import { Grid } from "../axes/Grid";
14import { MutableValueDisposer } from "../../core/utils/Disposer";
15/**
16 * ============================================================================
17 * REQUISITES
18 * ============================================================================
19 * @hidden
20 */
21/**
22 * Defines properties for [[AxisRendererY3D]].
23 */
24export interface IAxisRendererY3DProperties extends IAxisRendererYProperties {
25}
26/**
27 * Defines events for [[AxisRendererY3D]].
28 */
29export interface IAxisRendererY3DEvents extends IAxisRendererYEvents {
30}
31/**
32 * Defines adapters for [[AxisRendererY3D]].
33 *
34 * @see {@link Adapter}
35 */
36export interface IAxisRendererY3DAdapters extends IAxisRendererYAdapters, IAxisRendererY3DProperties {
37}
38/**
39 * ============================================================================
40 * MAIN CLASS
41 * ============================================================================
42 * @hidden
43 */
44/**
45 * Renderer for vertical 3D axis.
46 *
47 * @see {@link IAxisRendererY3DEvents} for a list of available events
48 * @see {@link IAxisRendererY3DAdapters} for a list of available Adapters
49 */
50export declare class AxisRendererY3D extends AxisRendererY {
51 /**
52 * Defines available properties.
53 */
54 _properties: IAxisRendererY3DProperties;
55 /**
56 * Defines available adapters.
57 */
58 _adapter: IAxisRendererY3DAdapters;
59 /**
60 * Defines available events.
61 */
62 _events: IAxisRendererY3DEvents;
63 /**
64 * A related chart.
65 *
66 * @todo Description
67 */
68 protected _chart: MutableValueDisposer<XYChart3D>;
69 /**
70 * Constructor.
71 *
72 * @param axis Related axis
73 */
74 constructor();
75 /**
76 * Updates and positions a grid element.
77 *
78 * @ignore Exclude from docs
79 * @param grid Grid element
80 * @param position Starting position
81 * @param endPosition End position
82 */
83 updateGridElement(grid: Grid, position: number, endPosition: number): void;
84 /**
85 * Updates and positions the base grid element.
86 *
87 * @ignore Exclude from docs
88 */
89 updateBaseGridElement(): void;
90 /**
91 * Chart, associated with the Axis.
92 *
93 * @ignore Exclude from docs
94 * @param value Chart
95 */
96 /**
97 * @ignore Exclude from docs
98 * @return Chart
99 */
100 chart: XYChart3D;
101 /**
102 * Invoked when 3D-related settings change, like depth or angle.
103 *
104 * @param event Event
105 */
106 protected handle3DChanged(event: AMEvent<Sprite, ISpriteEvents>["propertychanged"]): void;
107}