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 <Pivot> component

    The <Pivot> component embeds Flexmonster into a Vue 3 application.

    The simplest component usage

    To add an empty pivot table, specify the <Pivot> tag without any props and attributes:

    <Pivot/>

    Learn more about integration with Vue 3.

    Available props

    All the <Pivot> props are equivalent to the parameters of the new Flexmonster() API call. Check out the full list of available props.

    In addition to Flexmonster-specific props, you can also set standard HTML attributes (e.g., id, class, and style). They are not included in the component’s props but are available as fallthrough attributes.

    Passing props to <Pivot>

    Props can be passed as hardcoded values or as variables:

    Hardcoded value

    <Pivot
      report="https://cdn.flexmonster.com/reports/report.json"
    />

    In this example, the prop value is passed as a string. Learn how to pass values of different types.

    Variable

    To pass a prop as a variable, use the v-bind directive:

    <Pivot
      v-bind:report="report"
    />

    The specified variable (in our case, the report) should be defined in the <script> section of the file.

    Flexmonster and Vue lifecycle hooks

    Vue lifecycle hooks are not synchronized with Flexmonster's lifecycle. However, you can get information about Flexmonster's state using its events.

    To track the initialization of Flexmonster, use the ready or the reportcomplete event. Changes in Flexmonster's state (e.g., a report is changed) can be tracked via other Flexmonster events.

    Learn more about using Flexmonster events in Vue.

    Example

    The following example demonstrates how different <Pivot> props can be specified:

    <Pivot
      width="100%"
      height="500"
      toolbar
      report="https://cdn.flexmonster.com/reports/report.json"
      v-bind:customizeCell="customizeCellFunction"
      v-bind:reportcomplete="onReportComplete"
    />

    Note Here is the full list of available props.

    See also