Struct
======

.. currentmodule:: deepfos.lib.deepchart

.. autoclass:: Struct

   :exclude-members:



图表数据源字段结构声明基类

    通常只需要继承该类并把字段定义成类属性，然后将该结构体传给
    :func:`as_datasource` 或 :class:`ChartEngine`。

    .. admonition:: 快速开始

        .. code-block:: python

            from deepfos.lib.deepchart import Struct, Date, Number, Dimension, Text, as_datasource

            class SalesStruct(Struct):
                bill_date = Date(description='单据日期')
                amount    = Number(description='金额')
                org       = Dimension('org_dim', path='/主数据', name='org')
                remark    = Text(description='备注')

            @as_datasource(struct=SalesStruct)
            def get_sales(params):
                # params 由前端自动传入
                import pandas as pd
                df = pd.read_csv('sales.csv')
                return df

    .. note::
        字段声明顺序即为图表数据源的列顺序；
        ``Dimension``、``SmartList`` 类字段会自动附带元素绑定信息，
        前端可用于维度选择器渲染。

    See Also:
        - :func:`as_datasource`
        - :class:`ChartEngine`

    

.. autosummary::