class MAGES::Analytics::Editor::MAGESAnalyticsEditor¶

Overview¶

The main analytics editor UI. More…

class MAGESAnalyticsEditor: public MAGES::Editor::BaseMAGESPanelPage
{
public:
    // classes

    class TitleContent;

    // properties

    override VisualElement Title;
    override int Order;

    // methods

    virtual override void Initialize(MAGESPanel panel);
    virtual override void Destroy();
    virtual override VisualElement CreateGUI(Bundle selectedBundle);
    virtual override bool TrySelect(Bundle selectedBundle);
    virtual override void OnSelectedBundleChanged(Bundle newSelection);
};

Inherited Members¶

public:
    // enums

    enum SideNavigationBarPlacement;

    // properties

    bool Visible;
    VisualElement Title;
    SideNavigationBarPlacement NavigationBarPlacement;
    int Order;
    bool ShowBundleSelectionUI;
    bool RequiresBundleSelection;

    // methods

    virtual void Initialize(MAGESPanel panel);
    virtual bool TrySelect(Bundle selectedBundle);
    virtual VisualElement CreateGUI(Bundle selectedBundle);
    virtual void Deselect();
    virtual void Destroy();
    virtual void OnSelectedBundleChanged(Bundle newSelection);

Detailed Documentation¶

The main analytics editor UI.

Methods¶

virtual override void Initialize(MAGESPanel panel)

Called when the MAGES Panel is opened.

Parameters:

virtual override void Destroy()

Called when the panel is destroyed.

virtual override VisualElement CreateGUI(Bundle selectedBundle)

Called after being selected to show the page’s GUI.

Parameters:

Returns:

The Page’s GUI.

virtual override bool TrySelect(Bundle selectedBundle)

Called when the user clicks on this page’s button in the MAGES Panel side navigation.

Parameters:

Returns:

true if the page can be selected.

virtual override void OnSelectedBundleChanged(Bundle newSelection)

Called when the user selects a new Bundle in the MAGES Panel.

Parameters: