Skip to content

Latest commit

 

History

History
596 lines (428 loc) · 24.7 KB

glossary.rst

File metadata and controls

596 lines (428 loc) · 24.7 KB
Raw

Glossary

Basic Authentication

A simple method of authentication provided by most HTTP servers where a username and password are supplied. In terms of technical implementation, the HTTP request to the server contains a header field with Authorization: Basic <credentials> where <credentials> is the base-64 encoding of username:password.

Callback Function

A JavaScript function which is passed to Highcharts JS in the HighchartsOptions <highcharts_stock.options.HighchartsOptions> configuration which performs an action which affects the chart <charts>.

Typically, callback functions are used to define event handlers <event handler> or to define Highcharts formatters <formatter>.

  • Event Handler
  • Formatter
  • CallbackFunction <highcharts_stock.utility_classes.javascript_functions.CallbackFunction>
Cartesian Charts

Cartesian charts are charts that typically feature two or more axes, by common convention referred to as the X axis (classically represented as the horizontal axis) and the Y axis (classically represented as the vertical axis). If the chart features a third axis (for example in a three dimensional chart), it is commonly called the Z axis.

The location of a data point on a Cartesian chart is the intersection of its metric on one axis (typically the Y axis) and its dimension on the other axis (typically the X axis).

Cartesian Series

A Cartesian series is a series that can be visualized on a Cartesian chart <Cartesian charts>, which is typically characterized by several different properties including its metric and one or more dimensions <dimension>, and whose data points <data point> get visualized on their intersection.

Charts

The visualization of numerical, hierarchical, or sequential data in a somewhat graphical representation.

Color Axis

A color axis is an axis on the visualization that represents a value using its color. Typically, data point metric values are communicated using their position. However, they can also be communicated using the color in which they are rendered. A Color Axis <highcharts_stock.options.axes.color_axis.ColorAxis> is used to define the relationship between colors and metric values.

  • Color Axis <highcharts_stock.options.axes.color_axis.ColorAxis>
Data Point

A single value that is represented on a chart <charts>.

Data Label

The meta-data associated with a data point that is displayed on the chart. It will typically include labels, the value, and possibly some additional extraneous meta-data and will typically be displayed in a tooltip alongside the data point when user hovers their mouse over the data point.

Represented in Highcharts for Python by highcharts_stock.utility_classes.data_labels.DataLabel and also affected heavily by highcharts_stock.options.HighchartsOptions.tooltip.

  • highcharts_stock.utility_classes.data_labels.DataLabel
  • highcharts_stock.options.HighchartsOptions.tooltip
  • highcharts_stock.options.tooltips.Tooltip
Dependency Wheel

A dependency wheel chart is a type of flow diagram, where all nodes are laid out in a circle, and the flow between the are drawn as link bands.

  • DependencyWheelOptions <highcharts_stock.options.plot_options.dependencywheel.DependencyWheelOptions>
  • DependencyWheelSeries <highcharts_stock.options.series.dependencywheel.DependencyWheelSeries>
Diamond of Death

A multiple inheritance pattern that is considered an anti-pattern by the Python community because it creates difficult-to-maintain-and-debug complexity. The pattern involves the creation of one ancestor class (we'll call this class Ancestor), two child classes (we'll call them ChildA and ChildB, respectively), and a third grand-child class that inherits from both ChildA and ChildB.

This pattern is considered an anti-pattern because - absent a deep understanding of Python's :iabbr`MRO (Method Resolution Order)` - it is perceived as introducing ambiguity as to which ancestors methods will be executed when hoisting from the grand-child class.

Highcharts for Python - to minimize repetition of code and to keep the code base maintainable - does use this anti-pattern extensively, as discussed in greater detail in the contributors guidance <multiple_inheritance>.

  • Multiple Inheritance, DRY, and the Diamond of Death <multiple_inheritance>
Dimension

A way in which metrics <metric> can be organized or grouped. Typically a dimension can be the time period in which a metric was measured, recorded, or reported (e.g. "months" or "days"), or a dimension can be a category that sub-groups your metrics into subjects that you want to analyze (e.g. think "store locations" or "states").

Tip

In a chart <charts>, dimensions are often displayed along the x-axis.

Drilldown

The act of expanding a data point into a more granular view, typically by changing the properties (or interval) of a dimension.

For example:

  • if viewing a data point that presents a monthly value, drilling down into that data point may instead show a daily breakdown of the same metric
  • if viewing a data point that presents information at the level of a given state/province, drilling down into that data point may instead show a breakdown of the same metric grouped by city (within that state/province).

In Highcharts for Python, the drilldown capabilities are configured using the HighchartsOptions.drilldown <highcharts_stock.options.HighchartsOptions.drilldown> setting.

  • HighchartsOptions.drilldown <highcharts_stock.options.HighchartsOptions.drilldown>
  • Drilldown <highcharts_stock.options.drilldown.Drilldown>
Event Handler

A JavaScript function that receives information when an event of some sort has occurred and can take action in response to that event.

In Highcharts, this is typically seen as a callback function.

  • Callback Function
  • highcharts_stock.utility_classes.javascript_functions.CallbackFunction
Export Server

A server application which can receive requests to generate charts, produces those charts headlessly (without a UI), and returns a static export of the charts to the process that requested them.

The Highcharts Export Server is an application written and maintained by Highsoft, creators of Highcharts JS. It is available as a NodeJS application which can be deployed by organizations that license Highcharts.

In addition to the deployable Node Export Server, Highsoft also provides a Highsoft-hosted version of the export server. This Highsoft-provided server imposes rate limiting and other limitations, but can be used by licensees of Highcharts JS to programmatically generate downloadable static versions of their charts.

Format String

Format strings are templates for labels introduced in Highcharts for Python v.1.2. Since Highcharts (JS) v.11.1, format strings support logic.

We recommend using format strings if you:

  • Need to save the chart configuration to JSON.
  • Need to provide a GUI for end users so that callbacks are not practical, or XSS is a concern.
  • Need to send the charts over to our export server to execute (all callbacks are stripped out).
  • Are creating a wrapper for another programming language than JavaScript.

For a full overview over templating in format strings, please see the Highcharts (JS) Templating article.

Formatter

A particular type of callback function used extensively in Highcharts. In general terms, a formatter receives a context (for example a data point) and returns a string that has mutated the data point to apply some formatting.

For example, the data point might be a numerical value (500) to which the formatter function will append a suffix (miles) for display in the chart's data label.

  • Callback Function
  • highcharts_stock.utility_classes.javascript_functions.CallbackFunction
Gantt Chart

A type of chart <charts> which indicates the start and end of processes along a dimension of time, and may also indicate numerical values associated with that work along the same dimension.

Typically used in projcet management, Gantt Charts are useful for indicating dependencies and critical path for complex multi-faceted workstreams.

Gauge Chart

A type of chart <charts> which visualizes data as a position on a radial gauge. A classic example is a "spedometer" in a car, which depicts speed using the radial angle around the center point of the gauge.

  • GaugeOptions <highcharts_stock.options.plot_options.gauge.GaugeOptions>
  • SolidGaugeOptions <highcharts_stock.options.plot_options.gauge.SolidGaugeOptions>
  • GaugeSeries <highcharts_stock.options.series.gauge.GaugeSeries>
  • SolidGaugeSeries <highcharts_stock.options.series.gauge.SolidGaugeSeries>
JavaScript Object Literal Notation

A way of representing data in JavaScript as native JavaScript objects which is necessary to maximize value from Highcharts JS.

It is easiest to compare JavaScript object literal notation to the closely-related JSON (JavaScript Object Notation), though they are very different and serve very different purposes.

JavaScript Object Literal Notation is JavaScript source code. JSON is not. JSON is a way of encoding data into a text form that JavaScript is able to parse and deserialize. Because Highcharts JS relies heavily on JavaScriot object literal notation to support the definition of event handlers <event handler> and callback functions <callback function>, Highcharts for Python is designed to serialize and deserialize Python representations to/from their JavaScript object literal form.

Below is a comparison of a (similar) object represented in both JavaScript object literal notation and JSON, with further commentary:

JavaScriot Object Literal Notation JSON 
{
  myProperty: 'this is a property',
  anotherProperty: 123,
  aBooleanProperty: true,
  myCallback: function() { return true }
}
 




{


"myProperty": "this is a property", "anotherProperty": 123, "aBooleanProperty": true





}		






As you can see, the two forms are very similar. However, the JavaScript object literal notation has its keys directly accessible as properties of the object, while the JSON version has them represented as strings. Furthermore, because JSON is inherently a way of encoding data into strings, it is not wise to use it to transport functions which will then be executed by some other code (doing so is a dangerous security hole).






Caution




Typically, JSON can be converted to JavaScript object literal notation easily...but the opposite does not hold true.






Metaclass


A Python class that is used to define properties and methods - including abstract properties or methods which are not implemented in the metaclass itself - which are then inherited by sub-classes that derive from the metaclass.


Metaclasses are typically used as good DRY (Don't Repeat Yourself) programming and to ensure a consistent interface (standard methods) across multiple classes in your code.


In the Highcharts for Python toolkit, metaclasses are defined in the .metaclasses <highcharts_stock.metaclasses> module, and most inherit from the .metaclasses.HighchartsMeta <highcharts_stock.metaclasses.HighchartsMeta> class.




    

  • .metaclasses <highcharts_stock.metaclasses>
    • 

  • HighchartsMeta <highcharts_stock.metaclasses.HighchartsMeta>
    • 







Metric


The value of a measurement. Think of it as a "type" of number. A metric might be "number of miles", or "dollars spent", or "temperature". It is a value that can be measured and recorded, and which is typically visualized in charts.






Tip




In a chart <charts>, metrics are often displayed along the y-axis.






Metric Suffix


A symbol that is used to shorten numerical values that would otherwise have a lot of (typically repetitive) numbers. For example, if 10,000 were represented as 10k, the k would be considered the metric suffix.




    

  • Language.numeric_symbols <highcharts_stock.global_options.language.Language.numeric_symbols>
    • 







Network Graph


A network graph is a type of relationship chart, where connnections (links) attract nodes (points) and other nodes repulse each other.











    

  • NetworkGraphOptions <highcharts_stock.options.plot_options.networkgraph.NetworkGraphOptions>
    • 

  • NetworkGraphSeries <highcharts_stock.options.series.networkgraph.NetworkGraphSeries>
    • 









Oscillator








Caution




Oscillators are only available in Highcharts Stock for Python.








An oscillator is a type of technical indicator that is used to analyze bands and trend evolutions. Oscillators typically are visualized by adding high and low bands around the series being analyzed and then adding a trendline calculation that fluctuates between these bands.




    

  • Technical Indicator
    • 

  • Supported Visualizations <visualizations> > Technical Indicators <technical_indicator_visualizations>
    • 

  • Using Highcharts Stock for Python <using> > Using Technical Indicators <using_technical_indicators>
    • 









Plot Band


A banded area displayed on a chart <charts> bounded by two points on an axis. Typically used to either help highlight a particular range of values or to visually differentiate groupings of metrics <metric> along a dimension <dimension>.








Tip




A common use case is to specifically highlight a section of the chart in a range of interest along a particular axis.








    

  • PlotBand <highcharts_stock.options.axes.plot_bands.PlotBand>
    • 

  • NumericAxis.plot_bands <highcharts_stock.axes.numeric.NumericAxis.plot_bands>
    • 

  • Plot Line
    • 







Plot Line


A line drawn in the chart <charts>'s plot area spanning the plot area in a position relative to the axis. Typically used to demarcate a cut-off point or transition point along a range of values.




    

  • PlotLine <highcharts_stock.options.axes.plot_bands.PlotLine>
    • 

  • NumericAxis.plot_lines <highcharts_stock.axes.numeric.NumericAxis.plot_lines>
    • 

  • Plot Band
    • 







Polar Chart


A Polar chart is a radial chart <charts> that uses values and angles to show information as polar coordinates. While technically they are Cartesian charts (the X-axis is typically wrapped around their perimeter), they are usually treated and considered their own category of data visualization.




Sankey Chart


A sankey diagram is a type of flow diagram, in which the width of the link between two nodes is shown proportionally to the flow quantity.






Standard Sankey









Inverted Sankey









Sankey with Outgoing Links











    

  • SankeyOptions <highcharts_stock.options.plot_options.sankey.SankeyOptions>
    • 

  • SankeySeries <highcharts_stock.options.series.sankey.SankeySeries>
    • 







Series


A collection of data points <data point> that are expressed using a shared metric, along a shared dimension, or sharing a common property (e.g. a meta-data category that describes the scope of the data points).






Tip




Think of a "series" as one line on a line chart.






Shared Options


Shared Options are global configurations that are applied to all Highcharts visualizations that are displayed at the same time (on one web page, typically). They are typically used to practice good DRY (Don't Repeat Yourself) programming and to minimize the amount of code rendered in the page itself.


In the Highcharts for Python toolkit, shared options are managed through the SharedOptions <highcharts_stock.global_options.shared_options.SharedOptions> and SharedStockOptions <highcharts_stock.global_options.shared_options.SharedStockOptions> classes.




    

  • Using Highcharts Stock for Python <using> > Using Shared Options <shared_options>
    • 

  • .global_options.shared_options <highcharts_stock.global_options.shared_options>
    • 

  • SharedStockOptions <highcharts_stock.global_options.shared_options.SharedStockOptions>
    • 

  • SharedOptions <highcharts_stock.global_options.shared_options.SharedOptions>
    • 







SolidGauge


A solid gauge is a circular gauge where the value is indicated by a filled arc, and the color of the arc may variate with the value.











    

  • SolidGaugeOptions <highcharts_stock.options.plot_options.gauge.SolidGaugeOptions>
    • 

  • SolidGaugeSeries <highcharts_stock.options.series.gauge.SolidGaugeSeries>
    • 







Stem


In a BoxPlotSeries <highcharts_stock.options.series.boxplot.BoxPlotSeries> or similar, the vertical line extending from the box to the whiskers <whisker>.




    

  • BoxPlotSeries <highcharts_stock.options.series.boxplot.BoxPlotSeries>
    • 







Styled Mode


Styled mode is a method of adjusting the look and feel of your Highcharts charts using CSS styles as opposed to the explicit configuration in HighchartsOptions <highcharts_stock.options.HighchartsOptions>.


When it is enabled, styling configuration in your options will be ignored in favor of CSS styling. To enable it, set HighchartsOptions.chart.styled_mode <highcharts_stock.options.chart.ChartOptions.styled_mode> to True.






Caution




Highcharts for Python does not currently support the configuration of CSS styles when operating in styled mode. It is, however, an item on our roadmap (7).






    

  • ChartOptions.styled_mode <highcharts_stock.options.chart.ChartOptions.styled_mode>
    • 







Sunburst


A Sunburst displays hierarchical data, where a level in the hierarchy is represented by a circle. The center represents the root node of the tree. The visualization bears a resemblance to both treemap and pie charts.











    

  • SunburstOptions <highcharts_stock.options.plot_options.sunburst.SunburstOptions>
    • 

  • SunburstSeries <highcharts_stock.options.series.sunburst.SunburstSeries>
    • 









Technical Indicator








Caution




Technical indicators are only available in Highcharts Stock for Python.








Technical indicators are analyses performed on another series that can provide additional insights. For example, by looking at a linear regression of a time series you can gain insight into the overarching trend of the data.


Highcharts Stock for Python supports over 50 different technical indicators. Indicators differ from typical series in that they do not accept data of their own. They do not have a .data property, and do not receive their own data points. Instead, they are automatically calculated by Highcharts Stock by linking the indicator series to a main series on the chart itself.




    

  • Supported Visualizations <visualizations> > Technical Indicators <technical_indicator_visualizations>
    • 

  • Using Highcharts Stock for Python <using> > Using Technical Indicators <using_technical_indicators>
    • 

  • SeriesBase.add_indicator() <highcharts_stock.options.series.SeriesBase.add_indicator>
    • 

  • SeriesBase.get_indicator() <highcharts_stock.options.series.SeriesBase.get_indicator>
    • 

  • Chart.add_indicator() <highcharts_stock.chart.Chart.add_indicator>
    • 







Untrimmed








Note




This is a term that relates to Highcharts for Python's internal operations. If you are not contributing to the library, you don't need to worry about it.




An untrimmed dict <python:dict> representation of a Highcharts for Python object includes those properties that have None <python:None> values. In order to minimize data on the wire and maintain consistency with Highcharts JS, properties that have values of None <python:None> will be removed when serializing objects to JavaScript object literal notation or to JSON. The untrimmed object is the representation of the object before those properties are removed, where values of None <python:None> are still explicitly present.




    

  • Handling Default Values <handling_defaults>
    • 









Venn Diagram


A Venn diagram displays all possible logical relations between a collection of different sets. The sets are represented by circles, and the relation between the sets are displayed by the overlap or lack of overlap between them. The venn diagram is a special case of Euler diagrams, which can also be displayed by this series type.






Venn Diagram









Euler Diagram











    

  • VennOptions <highcharts_stock.options.plot_options.venn.VennOptions>
    • 

  • VennSeries <highcharts_stock.options.series.venn.VennSeries>
    • 







Whisker


In a BoxPlotSeries <highcharts_stock.options.series.boxplot.BoxPlotSeries> or similar, the horizontal lines marking low and high values




    

  • BoxPlotSeries <highcharts_stock.options.series.boxplot.BoxPlotSeries>
    • 







Wordcloud


A word cloud is a visualization of a set of words, where the size and placement of a word is determined by how it is weighted.











    

  • WordcloudOptions <highcharts_stock.options.plot_options.wordcloud.WordcloudOptions>
    • 

  • WordcloudSeries <highcharts_stock.options.series.wordcloud.WordcloudSeries>
    • 













fin