DrillableItems

You can enable eventing and drilling in a vizualization. Drilling is the process of 'zooming in' on a single measure value by filtering out all other data and breaking that value across a new attribute of interest.

To turn on eventing and drilling, specify at least one drillableItem.

Drillable items can consist of the following entities:

• Measures

• Attribute displayForms that are defined by their identifier or URI

  displayForm, or attribute label, is a different means of representing an attribute. For example, the Name attribute might have labels for Firstname and Lastname.

• Attribute values defined by their URI

Visualization points that intersect any defined measures, attributes, or attribute values become drillable and will emit events when interacted with.

NOTE: Visualizations created and saved in Analytical Designer contain URIs, not identifiers. When you set up drilling for such visualizations, use URIs in drillableItems and not identifiers.

Structure

drillableItems: [
    {
        identifier: <identifier>  // Measure or attribute displayForm identifier
        // or
        uri: <uri>    // Measure, attribute displayForm, or attribute value URI
    },
    ...
]

Example

{ identifier: 'label.owner.department' } // or { uri: '/gdc/md/workspaceHash/obj/1027' }

Set up drilling

To enable event drilling, extend the Visualization component with a drillableItems property.

In the drillableItems property, add an array of uris and/or identifiers of the measures and attributes that will become highlighted and drillable.

// This is an example of event drilling on the visualization from the GoodSales demo workspace.
<Visualization
  projectId="la84vcyhrq8jwbu4wpipw66q2sqeb923"
  identifier="aby3polcaFxy"
  drillableItems={[
    { identifier: 'label.owner.department' },
    { uri: '/gdc/md/la84vcyhrq8jwbu4wpipw66q2sqeb923/obj/9211' }
  ]}
/>

To catch events, add a listener to document:

document.addEventListener('drill',function(arg) { console.log(arg.detail); });

Each event is a JSON consisting of executionContext and drillableContext.

For more information, see Setting up Events for Drilling in Embedded Analytical Designer and KPI Dashboards.