Skip to content

Insights

zehavibarak edited this page Feb 15, 2025 · 1 revision

Matrix

  "Views": [
    {
      "Template": "bizdoc-cube-matrix",
      "Type": "BizDoc.Configuration.Insights.CubeMatrix",
      "Name": "cubeTable",
      "Title": "CubeTable",
      "ResourceType": "BizDoc.Core.Resources.Strings",
      "Options": {
        "xAxis": "quarter",
        "Series": "balance",
        "Filters": ["year"]
      }
    },
]

Options

Name Usage
xAxis Required. An axis name
series Required. An axis name
filters Array of axes user filter
indices Index name or indices names
aggregate
sum Calculated row / column

sum

Parallel

View configuration:

    {
      "Template": "bizdoc-parallel-view",
      "Type": "BizDoc.Configuration.Insights.CubeParallel",
      "Name": "cube-parallel",
      "Title": "CubeParallel",
      "Options": {
        "xAxis": "quarter",
        "Indices": [
          "budget"
        ],
        "Series": "month",
        "aggregate": [
          "year",
          "month"
        ]
      }
    }

Sum

    {
      "Template": "bizdoc-cube-sum",
      "Type": "BizDoc.Configuration.Insights.CubeSummary",
      "Name": "cubeSummary",
      "Title": "Summary",
      "ResourceType": "BizDoc.Core.Resources.Strings",
      "Options": {
        "xAxis": "month",
        "parentAxis": "year",
        "aggregate": [
          "quarter"
        ]
      }
    },

Chart

Analytics chart based on common document axes.

    {
      "Template": "bizdoc-chart-view",
      "Type": "BizDoc.Configuration.Insights.CubeChart",
      "Name": "cubeChart",
      "Title": "CubeChart",
      "Options": {
        "xAxis": "quarter",
        "Indices": [
          "budget"
        ],
        "chartType": "StackingBar",
        "Series": [
          "month"
        ],
        "aggregate": [
          "year"
        ]
      }
    }

Options

Name Usage
xAxis
series
aggregate
chartType
indices

Pivot

View configuration:

    {
      "Template": "bizdoc-pivot-view",
      "Type": "BizDoc.Configuration.Insights.CubePivot",
      "Name": "cube-pivot",
      "Title": "CubePivot",
      "Options": {
        "chartType": "Bar",
        "xAxis": [
          "quarter",
          "month"
        ],
        "series": ["company", "department"]
      }
    }

Develop an insight

Backing server-side.

[Insight(Template = "app-my-view", Title = "My View")]
public class MyView : InsightBase {
}

Angular

import { InsightComponent, DocumentModel } from '@bizdoc/core';
@Component({ ... })
@BizDoc({ name: 'app-my-view' })
export class AppComponent implements InsightComponent {
  onBind(model: DocumentModel<any>) {
     ...
  }
}

Template name on both Angular side and server-side has to match.

Options

bizdoc.json Views.

  "Views": [
    {
      "Template": "app-my-view",
      "Type": "MyProject.MyView",
      "Name": "myView",
      "Title": "My View",
      "Options": {
      }
    }
]

Release Notes

Angular npm, Flutter pub.dev and Nuget packages.

Clone this wiki locally