Skip to content

Latest commit

 

History

History
80 lines (64 loc) · 5.3 KB

File metadata and controls

80 lines (64 loc) · 5.3 KB
sidebar_label API overview
title API Overview
description You can have an API overview of JavaScript Pivot in the documentation of the DHTMLX JavaScript Pivot library. Browse developer guides and API reference, try out code examples and live demos, and download a free 30-day evaluation version of DHTMLX Pivot.

API overview

Pivot constructor

new pivot.Pivot("#root", {
    // configuration parameters
});

Parameters:

  • an HTML container (the ID of the HTML container)
  • an object of the configuration parameters (check here)

Pivot methods

Name Description
getTable() @getshort(../methods/gettable-method.md)
setConfig() @getshort(../methods/setconfig-method.md)
setLocale() @getshort(../methods/setlocale-method.md)
showConfigPanel() @getshort(../methods/showconfigpanel-method.md)

Pivot internal API

Event Bus methods

Name Description
api.detach() @getshort(../internal/detach-method.md)
api.exec() @getshort(../internal/exec-method.md)
api.intercept() @getshort(../internal/intercept-method.md)
api.on() @getshort(../internal/on-method.md)
api.setNext() @getshort(../internal/setnext-method.md)

State methods

Name Description
api.getReactiveState() @getshort(../internal/getreactivestate-method.md)
api.getState() @getshort(../internal/getstate-method.md)
api.getStores() @getshort(../internal/getstores-method.md)

Pivot events

Name Description
add-field @getshort(../events/add-field-event.md)
apply-filter @getshort(../events/apply-filter-event.md)
delete-field @getshort(../events/delete-field-event.md)
move-field @getshort(../events/move-field-event.md)
open-filter @getshort(../events/open-filter-event.md)
render-table @getshort(../events/render-table-event.md)
show-config-panel @getshort(../events/show-config-panel-event.md)
update-config @getshort(../events/update-config-event.md)
update-field @getshort(../events/update-value-event.md)

Pivot properties

Name Description
columnShape @getshort(../config/columnshape-property.md)
config @getshort(../config/config-property.md)
configPanel @getshort(../config/configpanel-property.md)
data @getshort(../config/data-property.md)
fields @getshort(../config/fields-property.md)
headerShape @getshort(../config/headershape-property.md)
limits @getshort(../config/limits-property.md)
locale @getshort(../config/locale-property.md)
methods @getshort(../config/methods-property.md)
predicates @getshort(../config/predicates-property.md)
readonly @getshort(../config/readonly-property.md)
tableShape @getshort(../config/tableshape-property.md)