MicroStrategy ONE

Define and Use Custom Properties for the React Format Panel

This feature is available starting in MicroStrategy 2021 Update 3.

The key used in the config file contains custom properties (propertyName). The propertyName is defined on rendering side, rather than Format panel side. In fact, all properties are declared, initialized, and used in the rendering logic. From the Format panel side, you need to look into the rendering logic to see what properties are being used and associate them with the UX design when binding them in the config file.

Each custom visualization extends CustomVisBase and uses the following APIs to define and use properties:

  • setDefaultPropertyValues
    Initially sets an object as a property group of <key, value> pairs.

  • setProperty
    Sets a single property and its value in run-time.

  • getProperty
    Sets a single property and its value.

This means you can look for all keys that are being used in setDefaultPropertyValues. Collect those keys into a properties array.