{
    "componentChunkName": "component---src-templates-doc-page-jsx",
    "path": "/javascript-charts/api-create-update/",
    "result": {"data":{"markdownRemark":{"htmlAst":{"type":"root","children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Learn about creating and updating charts in more detail."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"creating-and-updating-charts","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#creating-and-updating-charts","ariaLabel":"creating and updating charts permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","dataPrefix":"fas","dataIcon":"link","className":["svg-inline--fa","fa-link"],"role":"img","xmlns":"http://www.w3.org/2000/svg","viewBox":"0 0 512 512"},"children":[{"type":"element","tagName":"path","properties":{"fill":"currentColor","d":"M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"},"children":[]}]}]},{"type":"text","value":"Creating and Updating Charts"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","javascript-only-section"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart"}]},{"type":"text","value":" exposes "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"create()"}]},{"type":"text","value":" and "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"update()"}]},{"type":"text","value":" static methods to perform chart initialisation and update based upon\nthe "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChartOptions"}]},{"type":"text","value":" configuration structure."}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Mutations to the previously used options object are not automatically picked up by the chart implementation,\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart.update()"}]},{"type":"text","value":" should be called for changes to be applied."}]},{"type":"element","tagName":"div","properties":{"className":["custom-block","note"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"NOTE: We expect the options supplied to "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart.update()"}]},{"type":"text","value":" to be the full configuration state to update\nto, not a partial configuration. Use "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart.updateDelta()"}]},{"type":"text","value":" to apply partial updates."}]}]}]},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart"}]},{"type":"text","value":" has the following API:\n"},{"type":"element","tagName":"api-documentation","properties":{"source":"charts-api/doc-interfaces.AUTO.json","section":"AgChart","names":"[\"create\", \"update\"]","config":"{ \"showSnippets\": false, \"lookupRoot\": \"charts-api\", \"suppressTypes\": [\"AgChartInstance\", \"AgChartOptions\", \"DeepPartial\"] }"},"children":[]}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","frameworks-only-section"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChartOptions"}]},{"type":"text","value":" are supplied to the AG Charts component, and mutations of the options trigger an update of the chart configuration."}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"See the "},{"type":"element","tagName":"a","properties":{"href":"/archive/29.2.0/charts-api/"},"children":[{"type":"text","value":"Options Reference"}]},{"type":"text","value":" for more detail about the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChartOptions"}]},{"type":"text","value":" structure."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The following example demonstrates both create and update cases:"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"Definition of an "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"options"}]},{"type":"text","value":" object used to create the initial chart state."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"Buttons that invoke mutations of the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"options"}]},{"type":"text","value":" and trigger update of the chart state."}]},{"type":"text","value":"\n"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"chart-example","properties":{"title":"Create and Update with AgChartOptions","name":"create-update","type":"generated"},"children":[]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","javascript-only-section"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"h2","properties":{"id":"delta-options-update","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#delta-options-update","ariaLabel":"delta options update permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","dataPrefix":"fas","dataIcon":"link","className":["svg-inline--fa","fa-link"],"role":"img","xmlns":"http://www.w3.org/2000/svg","viewBox":"0 0 512 512"},"children":[{"type":"element","tagName":"path","properties":{"fill":"currentColor","d":"M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"},"children":[]}]}]},{"type":"text","value":"Delta Options Update"}]},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart"}]},{"type":"text","value":" exposes an "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"updateDelta()"}]},{"type":"text","value":" static method to allow partial updates to a charts options.\n"},{"type":"element","tagName":"api-documentation","properties":{"source":"charts-api/doc-interfaces.AUTO.json","section":"AgChart","names":"[\"updateDelta\"]","config":"{ \"showSnippets\": false, \"lookupRoot\": \"charts-api\", \"suppressTypes\": [\"AgChartInstance\", \"AgChartOptions\", \"DeepPartial\"] }"},"children":[]}]},{"type":"element","tagName":"div","properties":{},"children":[{"type":"text","value":"To assist with state management, the complete applied options state can be retrieved by calling "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"getOptions()"}]},{"type":"text","value":" on the\n"},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChartInstance"}]},{"type":"text","value":":\n"},{"type":"element","tagName":"api-documentation","properties":{"source":"charts-api/doc-interfaces.AUTO.json","section":"AgChartInstance","names":"[\"getOptions\"]","config":"{ \"showSnippets\": false, \"lookupRoot\": \"charts-api\", \"suppressTypes\": [\"AgChartInstance\", \"AgChartOptions\", \"DeepPartial\"] }"},"children":[]}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"The following example demonstrates:"}]},{"type":"element","tagName":"ul","properties":{},"children":[{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"Retrieving current Chart configuration via "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"getOptions()"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"},{"type":"element","tagName":"li","properties":{},"children":[{"type":"text","value":"Mutation of the Chart configuration via "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"updateDelta()"}]},{"type":"text","value":"."}]},{"type":"text","value":"\n"}]},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"chart-example","properties":{"title":"Update with Partial AgChartOptions","name":"update-partial","type":"typescript"},"children":[]}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","frameworks-only-section"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"h2","properties":{"id":"delta-options-update-1","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#delta-options-update-1","ariaLabel":"delta options update 1 permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","dataPrefix":"fas","dataIcon":"link","className":["svg-inline--fa","fa-link"],"role":"img","xmlns":"http://www.w3.org/2000/svg","viewBox":"0 0 512 512"},"children":[{"type":"element","tagName":"path","properties":{"fill":"currentColor","d":"M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"},"children":[]}]}]},{"type":"text","value":"Delta Options Update"}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChart"}]},{"type":"text","value":" exposes an "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"updateDelta()"}]},{"type":"text","value":" static method to allow partial updates to an existing charts configuration:"}]},{"type":"element","tagName":"div","properties":{"className":["custom-block","note"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"updateDelta()"}]},{"type":"text","value":" should not be normally used with the AG Charts component; framework change detection and updates\nto the chart apply automatically after an options change."}]},{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"However when using "},{"type":"element","tagName":"a","properties":{"href":"/archive/29.2.0/integrated-charts-events/#accessing-chart-instance"},"children":[{"type":"text","value":"Integrated Charts"}]},{"type":"text","value":" it may be\nnecessary to use this API to perform chart updates in Grid callbacks."}]}]}]},{"type":"element","tagName":"div","properties":{},"children":[{"type":"element","tagName":"api-documentation","properties":{"source":"charts-api/doc-interfaces.AUTO.json","section":"AgChart","names":"[\"updateDelta\"]","config":"{ \"showSnippets\": false, \"lookupRoot\": \"charts-api\", \"suppressTypes\": [\"AgChartInstance\", \"AgChartOptions\", \"DeepPartial\"] }"},"children":[]}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"h2","properties":{"id":"destroying-charts","style":"position:relative;"},"children":[{"type":"element","tagName":"a","properties":{"href":"#destroying-charts","ariaLabel":"destroying charts permalink","className":["anchor","before"]},"children":[{"type":"element","tagName":"svg","properties":{"ariaHidden":"true","focusable":"false","dataPrefix":"fas","dataIcon":"link","className":["svg-inline--fa","fa-link"],"role":"img","xmlns":"http://www.w3.org/2000/svg","viewBox":"0 0 512 512"},"children":[{"type":"element","tagName":"path","properties":{"fill":"currentColor","d":"M326.612 185.391c59.747 59.809 58.927 155.698.36 214.59-.11.12-.24.25-.36.37l-67.2 67.2c-59.27 59.27-155.699 59.262-214.96 0-59.27-59.26-59.27-155.7 0-214.96l37.106-37.106c9.84-9.84 26.786-3.3 27.294 10.606.648 17.722 3.826 35.527 9.69 52.721 1.986 5.822.567 12.262-3.783 16.612l-13.087 13.087c-28.026 28.026-28.905 73.66-1.155 101.96 28.024 28.579 74.086 28.749 102.325.51l67.2-67.19c28.191-28.191 28.073-73.757 0-101.83-3.701-3.694-7.429-6.564-10.341-8.569a16.037 16.037 0 0 1-6.947-12.606c-.396-10.567 3.348-21.456 11.698-29.806l21.054-21.055c5.521-5.521 14.182-6.199 20.584-1.731a152.482 152.482 0 0 1 20.522 17.197zM467.547 44.449c-59.261-59.262-155.69-59.27-214.96 0l-67.2 67.2c-.12.12-.25.25-.36.37-58.566 58.892-59.387 154.781.36 214.59a152.454 152.454 0 0 0 20.521 17.196c6.402 4.468 15.064 3.789 20.584-1.731l21.054-21.055c8.35-8.35 12.094-19.239 11.698-29.806a16.037 16.037 0 0 0-6.947-12.606c-2.912-2.005-6.64-4.875-10.341-8.569-28.073-28.073-28.191-73.639 0-101.83l67.2-67.19c28.239-28.239 74.3-28.069 102.325.51 27.75 28.3 26.872 73.934-1.155 101.96l-13.087 13.087c-4.35 4.35-5.769 10.79-3.783 16.612 5.864 17.194 9.042 34.999 9.69 52.721.509 13.906 17.454 20.446 27.294 10.606l37.106-37.106c59.271-59.259 59.271-155.699.001-214.959z"},"children":[]}]}]},{"type":"text","value":"Destroying Charts"}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","javascript-only-section"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"div","properties":{},"children":[{"type":"text","value":"Charts can be destroyed by using the "},{"type":"element","tagName":"code","properties":{},"children":[{"type":"text","value":"AgChartInstance.destroy()"}]},{"type":"text","value":" method:\n"},{"type":"element","tagName":"api-documentation","properties":{"source":"charts-api/doc-interfaces.AUTO.json","section":"AgChartInstance","names":"[\"destroy\"]","config":"{ \"showSnippets\": false, \"lookupRoot\": \"charts-api\", \"suppressTypes\": [\"AgChartInstance\", \"AgChartOptions\", \"DeepPartial\"] }"},"children":[]}]}]}]},{"type":"text","value":"\n"},{"type":"element","tagName":"div","properties":{"className":["custom-block","frameworks-only-section"]},"children":[{"type":"element","tagName":"div","properties":{"className":["custom-block-body"]},"children":[{"type":"element","tagName":"p","properties":{},"children":[{"type":"text","value":"Charts are automatically destroyed when the AG Charts component is removed from the DOM."}]}]}]}],"data":{"quirksMode":false}},"frontmatter":{"title":"Create/Update","version":null,"enterprise":null,"description":null},"headings":[{"id":"creating-and-updating-charts","depth":2,"value":"Creating and Updating Charts"},{"id":"delta-options-update","depth":2,"value":"Delta Options Update"},{"id":"delta-options-update-1","depth":2,"value":"Delta Options Update"},{"id":"destroying-charts","depth":2,"value":"Destroying Charts"}]}},"pageContext":{"frameworks":["javascript","react","angular","vue"],"framework":"javascript","srcPath":"/charts-api-create-update","pageName":"charts-api-create-update"}},
    "staticQueryHashes": ["1766026005","699667431","940729948"]}