Zoom
Properties in the Zoom group configure the functionality provided the user in order to navigate the chart through zoom actions.
Zoomable
Flag to enable the user to zoom in and out of the chart.
Variable Name: | zoomable |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
zoomable | Boolean | Zoomable |
Zoom Type
Indicate the type of zoom to make available on the chart. Options include:
Mouse Wheel - If the user scrolling enabled for their mouse wheel or a gesture for scrolling enabled on their input device, scrolling will zoom in and out on the chart.
Zoom Buttons - Displays buttons in the chart area for zooming in and out.
Range Slider - Display a slider bar at the bottom of the chart, in order to select minimum and maximum values values for the value of the Catagories displayed
Brush - Allows the user to click and drag across the chart area, when the click is released, the chart will zoom into the selected area.
Variable Name: | zoomType |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
zoomType | String | Zoom Type |
Zoom In Button
Applied if Zoom Type is set to Zoom Buttons. Style and text value for the Zoom In button.
Variable Name: | zoomInButton |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
buttonValue | String | Text to display as the label of the Zoom In button. |
buttonCss | String | CSS style to apply to the Zoom In button. |
Zoom Out Button
Applied if Zoom Type is set to Zoom Buttons. Style and text value for the Zoom Out button.
Variable Name: | zoomOutButton |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
buttonValue | String | Text to display as the label of the Zoom Out button. |
buttonCss | String | CSS style to apply to the Zoom Out button. |
Show Slider Preview
Enables a preview of the range slider result. Applicable only if Zoom Type is set to Range Slider.
Variable Name: | showSliderPreview |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
showSliderPreview | Boolean | Show Slider Preview |
Default Zoom Range
Applied if Zoom Type is set to Range Slider. Indicates maximum value of the range slider. A value of 1 indicates a zoom level displaying the maximum amount of the chart area. A value of 0 indicates a zoom level displaying the smallest possible chart area. 0.5 would indicate a zoom level showing half the chart area.
Variable Name: | defaultZoomRange |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
defaultZoomRange | Float | Default Zoom Range |
Delay Zoom Event
Amount of time to delay firing the zoom event after the zoom level is changed. No zoom event will fire until the indicated amount of time has elapsed. This can be used to prevent many events from being fired in the case of the user quickly performing many successive zoom actions, and instead fire only a single event for the final zoom action.
Variable Name: | zoomEventDebounceDelay |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
zoomEventDebounceDelay | Long | Delay of Zoom Event |
Button Container Style
Applied if Zoom Type is set to Zoom Buttons. The CSS style to apply to the Zoom In and Zoom Out buttons.
Variable Name: | buttonContainerStyle |
Records: | 1 |
Record Format:
Field Name | Field Type | Field Description |
buttonContainerStyle | String | Button Container Style |
Public Events
[?]
Chart Zoomed
Fires after the user performs a zoom action and the time period indicated in Delay of Zoom Event has passed without any subsequent zoom actions being performed. Indicates the current zoom level.
Event name: chartZoomed
Event fields:
Field Description | Name | Type | Description |
Start Range | startRange | string | Indicates the lowest value displayed on the X axis at the current zoom level. |
End Range | endRange | string | Indicates the highest value displayed on the X axis at the current zoom level. |
Was this page helpful?