superset2/superset/examples/echarts_dashboard.py

# Licensed to the Apache Software Foundation (ASF) under one
# or more contributor license agreements.  See the NOTICE file
# distributed with this work for additional information
# regarding copyright ownership.  The ASF licenses this file
# to you under the Apache License, Version 2.0 (the
# "License"); you may not use this file except in compliance
# with the License.  You may obtain a copy of the License at
#
#   http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing,
# software distributed under the License is distributed on an
# "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
# KIND, either express or implied.  See the License for the
# specific language governing permissions and limitations
# under the License.
import json
import textwrap
from typing import List

from sqlalchemy import inspect

from superset import db, security_manager
from superset.connectors.sqla.models import SqlaTable
from superset.models.dashboard import Dashboard
from superset.models.slice import Slice
from superset.utils.core import DatasourceType

from ..utils.database import get_example_database
from .helpers import (
    get_slice_json,
    get_table_connector_registry,
    merge_slice,
    update_slice_ids,
)

DASH_SLUG = "echarts_dash"


def create_slices(tbl: SqlaTable) -> List[Slice]:
    admin = security_manager.find_user("admin")
    slice_props = dict(
        datasource_id=tbl.id,
        datasource_type=DatasourceType.TABLE,
        owners=[admin],
        created_by=admin,
    )

    defaults = {
        "limit": "25",
        "time_range": "100 years ago : now",
        "granularity_sqla": "ds",
        "groupby": ["gender"],
        "row_limit": "50000",
        "viz_type": "echarts_timeseries_bar",
    }

    slices = [
        Slice(
            **slice_props,
            slice_name="Time-Series Bar Chart V2",
            viz_type="echarts_timeseries_bar",
            params=get_slice_json(
                defaults,
                adhoc_filters=[
                    {
                        "clause": "WHERE",
                        "expressionType": "SIMPLE",
                        "filterOptionName": "filter_i7pmq9ob0vg_lvnj4s14yt",
                        "comparator": "10000",
                        "operator": ">",
                        "subject": "num_boys",
                    }
                ],
                viz_type="dist_bar",
                metrics=["sum__num"],
                groupby=["gender"],
            ),
        ),
    ]

    for slc in slices:
        merge_slice(slc)

    return slices


def load_echarts_dashboard() -> None:
    """Loading a dashboard featuring EChart charts"""

    database = get_example_database()
    engine = database.get_sqla_engine()
    schema = inspect(engine).default_schema_name

    tbl_name = "birth_names"
    table_exists = database.has_table_by_name(tbl_name, schema=schema)

    if table_exists:
        table = get_table_connector_registry()
        obj = (
            db.session.query(table)
            .filter_by(table_name=tbl_name, schema=schema)
            .first()
        )
        create_slices(obj)

    print("Creating the dashboard")

    db.session.expunge_all()
    dash = db.session.query(Dashboard).filter_by(slug=DASH_SLUG).first()

    if not dash:
        dash = Dashboard()

    js = textwrap.dedent(
        """\
{
    "CHART-dxV7Il74hH": {
      "children": [],
      "id": "CHART-dxV7Il74hH",
      "meta": {
        "chartId": 597,
        "height": 50,
        "sliceName": "Box plot",
        "width": 6
      },
      "type": "CHART"
    },
    "CHART-YyHWQacdcj": {
      "children": [],
      "id": "CHART-YyHWQacdcj",
      "meta": {
          "chartId": 15,
          "height": 50,
          "sliceName": "Participants",
          "width": 6
      },
      "type": "CHART"
    },
    "CHART-oWKBOJ6Ydh": {
      "children": [],
      "id": "CHART-oWKBOJ6Ydh",
      "meta":{
          "chartId": 16,
          "height": 50,
          "sliceName": "Genders",
          "width": 6
        },
      "type": "CHART"
    },
    "CHART-06Kg-rUggO": {
      "children": [],
      "id": "CHART-06Kg-rUggO",
      "meta": {
        "chartId": 617,
        "height": 50,
        "sliceName": "Number of Girls",
        "width": 6
      },
      "type": "CHART"
    },
    "CHART--wEhS-MDSg": {
      "children": [],
      "id": "CHART--wEhS-MDS",
      "meta": {
        "chartId": 2,
        "height": 50,
        "sliceName": "Energy Force Layout",
        "width": 6
      },
      "type": "CHART"
    },
    "CHART--LXvS-RDSu": {
      "children": [],
      "id": "CHART--LXvS-RDSu",
      "meta": {
        "chartId": 398,
        "height": 50,
        "sliceName": "Time-Series Bar Chart V2",
        "width": 6
      },
      "type": "CHART"
    },
    "GRID_ID": {
        "children": [
            "ROW-SytNzNA4X",
            "ROW-HkFFEzVRVm",
            "ROW-BytNzNA4Y"
        ],
        "id": "GRID_ID",
        "type": "GRID"
    },
    "HEADER_ID": {
        "id": "HEADER_ID",
        "meta": {
            "text": "ECharts Dashboard"
        },
        "type": "HEADER"
    },
    "ROOT_ID": {
        "children": [
            "GRID_ID"
        ],
        "id": "ROOT_ID",
        "type": "ROOT"
    },
    "ROW-HkFFEzVRVm": {
        "children": [
            "CHART-dxV7Il74hH",
            "CHART-oWKBOJ6Ydh"
        ],
        "id": "ROW-HkFFEzVRVm",
        "meta": {
            "background": "BACKGROUND_TRANSPARENT"
        },
        "type": "ROW"
    },
    "ROW-SytNzNA4X": {
        "children": [
            "CHART-06Kg-rUggO",
            "CHART-YyHWQacdcj"
        ],
        "id": "ROW-SytNzNA4X",
        "meta": {
            "background": "BACKGROUND_TRANSPARENT"
        },
        "type": "ROW"
    },
    "ROW-BytNzNA4Y": {
        "children": [
            "CHART--wEhS-MDSg",
            "CHART--LXvS-RDSu"
        ],
        "id": "ROW-BytNzNA4Y",
        "meta": {
            "background": "BACKGROUND_TRANSPARENT"
        },
        "type": "ROW"
    },
    "DASHBOARD_VERSION_KEY": "v2"
}
    """
    )

    pos = json.loads(js)
    dash.slices = update_slice_ids(pos)
    dash.dashboard_title = "ECharts Dashboard"
    dash.position_json = json.dumps(pos, indent=4)
    dash.slug = DASH_SLUG
    db.session.commit()