We have updated Flexmonster Software License Agreement, effective as of September 30, 2024. Learn more about what’s changed.
All documentation
  • Introduction
  • Connecting to data source
  • Browser compatibility
  • Documentation for older versions
  • The FlexmonsterComponent

    The FlexmonsterComponent embeds Flexmonster into a Blazor application.

    The simplest component usage

    To add an empty pivot table, specify the <FlexmonsterComponent/> tag without any parameters:

    <FlexmonsterComponent/>

    Learn more about integration with Blazor.

    Available parameters

    The FlexmonsterComponent’s parameters are equivalent to Flexmonster’s parameters, but with certain differences:

    • The Width and Height parameters have the string type and require a string value.
    • The FlexmonsterComponent does not support the following parameters:
      • customizeAPIRequest
      • customizeCell
      • customizeChartElement
      • customizeContextMenu
    • The FlexmonsterComponent has the JavaScriptHandler parameter, which is not available in the new Flexmonster() API call.
      With the JavaScriptHandler, you can use JavaScript to access Flexmonster features that are not supported in Blazor out of the box (e.g., Toolbar customization).
      See how to access Flexmonster functionality through JavaScript.

    Setting the FlexmonsterComponent's parameters

    The FlexmonsterComponent’s parameters can be set as variables or as hardcoded values:

    Variable

    Enclose the variable's name in double quotes ("") and add the @ prefix to it:

    <FlexmonsterComponent Report="@report"
                          Height="@height"
                          Width="@width"
                          Toolbar="@toolbar"
                          Accessibility="@accessibility"
    />

    The specified variables should be defined in the @code section of the component:

    @code {
      string report = "https://cdn.flexmonster.com/github/demo-report.json";
      string height = "600";
      string width = "100%";
      bool toolbar = true;
      AccessibilityOptions accessibility = new AccessibilityOptions();
    }

    In Blazor, you can also set parameters using attribute splatting.

    Hardcoded value

    String and boolean values are specified in the same way as in most programming languages:

    <FlexmonsterComponent Height="600"
                          Width="100%"
                          Toolbar=true
    />

    Note that when setting a report using a link, the link must be specified in the '@("<link-to-file>")' format:

    <FlexmonsterComponent
      Report='@("https://cdn.flexmonster.com/github/demo-report.json")'
    />

    To pass an object as a parameter value, specify the object in the "@(<object>)" format:

    <FlexmonsterComponent 
      Accessibility="@(new AccessibilityOptions())"
    />

    Learn more about component parameters in Blazor.

    See also