Skip to content

Instantly share code, notes, and snippets.

@jakevdp
Last active September 6, 2016 04:02
Show Gist options
  • Star 0 You must be signed in to star a gist
  • Fork 0 You must be signed in to fork a gist
  • Save jakevdp/7e8652704661b449d78ddc6e58450c4f to your computer and use it in GitHub Desktop.
Save jakevdp/7e8652704661b449d78ddc6e58450c4f to your computer and use it in GitHub Desktop.
First attempt at auto-doc for altair API
Display the source blob
Display the rendered blob
Raw
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Display the source blob
Display the rendered blob
Raw
{
"cells": [
{
"cell_type": "markdown",
"metadata": {},
"source": [
"# Altair API Documentation\n",
"\n",
"*This is auto-generated from [Altair_DocGen.ipynb](Altair_DocGen.ipynb)*"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Top-Level Objects"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Chart\n",
"\n",
"*Chart*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **config**| *[Config](#Config)* | -- |\n",
"| **description**| *a unicode string* | -- |\n",
"| **encoding**| *[Encoding](#Encoding)* | -- |\n",
"| **mark**| *a unicode string* | One of ['area', 'bar', 'line', 'point', 'text', 'tick', 'rule', 'circle', 'square']. |\n",
"| **name**| *a unicode string* | -- |\n",
"| **transform**| *[Transform](#Transform)* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### FacetedChart\n",
"\n",
"*FacetedChart*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **config**| *[Config](#Config)* | -- |\n",
"| **description**| *a unicode string* | -- |\n",
"| **facet**| *[Facet](#Facet)* | -- |\n",
"| **name**| *a unicode string* | -- |\n",
"| **spec**| *any value or any value* | -- |\n",
"| **transform**| *[Transform](#Transform)* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### LayeredChart\n",
"\n",
"*LayeredChart*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **config**| *[Config](#Config)* | -- |\n",
"| **description**| *a unicode string* | -- |\n",
"| **layers**| *a list or None* | -- |\n",
"| **name**| *a unicode string* | -- |\n",
"| **transform**| *[Transform](#Transform)* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"## Other Objects"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Axis\n",
"\n",
"*Wrapper for Vega-Lite Axis definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **axisColor**| *a unicode string* | Color of axis line. |\n",
"| **axisWidth**| *a float* | Width of the axis line. |\n",
"| **characterWidth**| *a float* | Character width for automatically determining title max length. |\n",
"| **format**| *a unicode string* | The formatting pattern for axis labels. |\n",
"| **grid**| *a boolean* | A flag indicate if gridlines should be created in addition to ticks. |\n",
"| **gridColor**| *a unicode string* | Color of gridlines. |\n",
"| **gridDash**| *a list or None* | The offset (in pixels) into which to begin drawing with the grid dash array. |\n",
"| **gridOpacity**| *a float* | The stroke opacity of grid (value between [0,1]). |\n",
"| **gridWidth**| *a float* | The grid width, in pixels. |\n",
"| **labelAlign**| *a unicode string* | Text alignment for the Label. |\n",
"| **labelAngle**| *a float* | The rotation angle of the axis labels. |\n",
"| **labelBaseline**| *a unicode string* | Text baseline for the label. |\n",
"| **labelMaxLength**| *a float* | Truncate labels that are too long. |\n",
"| **labels**| *a boolean* | Enable or disable labels. |\n",
"| **layer**| *a unicode string* | A string indicating if the axis (and any gridlines) should be placed above or below the data marks. |\n",
"| **offset**| *a float* | The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle. |\n",
"| **orient**| *a unicode string* | The orientation of the axis. One of ['top', 'right', 'left', 'bottom']. |\n",
"| **properties**| *any value* | Optional mark property definitions for custom axis styling. |\n",
"| **shortTimeLabels**| *a boolean* | Whether month and day names should be abbreviated. |\n",
"| **subdivide**| *a float* | If provided, sets the number of minor ticks between major ticks (the value 9 results in decimal subdivision). |\n",
"| **tickColor**| *a unicode string* | The color of the axis's tick. |\n",
"| **tickLabelColor**| *a unicode string* | The color of the tick label, can be in hex color code or regular color name. |\n",
"| **tickLabelFont**| *a unicode string* | The font of the tick label. |\n",
"| **tickLabelFontSize**| *a float* | The font size of label, in pixels. |\n",
"| **tickPadding**| *a float* | The padding, in pixels, between ticks and text labels. |\n",
"| **tickSize**| *a float* | The size, in pixels, of major, minor and end ticks. |\n",
"| **tickSizeEnd**| *a float* | The size, in pixels, of end ticks. |\n",
"| **tickSizeMajor**| *a float* | The size, in pixels, of major ticks. |\n",
"| **tickSizeMinor**| *a float* | The size, in pixels, of minor ticks. |\n",
"| **tickWidth**| *a float* | The width, in pixels, of ticks. |\n",
"| **ticks**| *a float* | A desired number of ticks, for axes visualizing quantitative scales. |\n",
"| **title**| *a unicode string* | A title for the axis. |\n",
"| **titleColor**| *a unicode string* | Color of the title, can be in hex color code or regular color name. |\n",
"| **titleFont**| *a unicode string* | Font of the title. |\n",
"| **titleFontSize**| *a float* | Size of the title. |\n",
"| **titleFontWeight**| *a unicode string* | Weight of the title. |\n",
"| **titleMaxLength**| *a float* | Max length for axis title if the title is automatically generated from the field's description. |\n",
"| **titleOffset**| *a float* | A title offset value for the axis. |\n",
"| **values**| *a list or None* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### AxisConfig\n",
"\n",
"*Wrapper for Vega-Lite AxisConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **axisColor**| *a unicode string* | Color of axis line. |\n",
"| **axisWidth**| *a float* | Width of the axis line. |\n",
"| **characterWidth**| *a float* | Character width for automatically determining title max length. |\n",
"| **grid**| *a boolean* | A flag indicate if gridlines should be created in addition to ticks. |\n",
"| **gridColor**| *a unicode string* | Color of gridlines. |\n",
"| **gridDash**| *a list or None* | The offset (in pixels) into which to begin drawing with the grid dash array. |\n",
"| **gridOpacity**| *a float* | The stroke opacity of grid (value between [0,1]). |\n",
"| **gridWidth**| *a float* | The grid width, in pixels. |\n",
"| **labelAlign**| *a unicode string* | Text alignment for the Label. |\n",
"| **labelAngle**| *a float* | The rotation angle of the axis labels. |\n",
"| **labelBaseline**| *a unicode string* | Text baseline for the label. |\n",
"| **labelMaxLength**| *a float* | Truncate labels that are too long. |\n",
"| **labels**| *a boolean* | Enable or disable labels. |\n",
"| **layer**| *a unicode string* | A string indicating if the axis (and any gridlines) should be placed above or below the data marks. |\n",
"| **offset**| *a float* | The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle. |\n",
"| **properties**| *any value* | Optional mark property definitions for custom axis styling. |\n",
"| **shortTimeLabels**| *a boolean* | Whether month and day names should be abbreviated. |\n",
"| **subdivide**| *a float* | If provided, sets the number of minor ticks between major ticks (the value 9 results in decimal subdivision). |\n",
"| **tickColor**| *a unicode string* | The color of the axis's tick. |\n",
"| **tickLabelColor**| *a unicode string* | The color of the tick label, can be in hex color code or regular color name. |\n",
"| **tickLabelFont**| *a unicode string* | The font of the tick label. |\n",
"| **tickLabelFontSize**| *a float* | The font size of label, in pixels. |\n",
"| **tickPadding**| *a float* | The padding, in pixels, between ticks and text labels. |\n",
"| **tickSize**| *a float* | The size, in pixels, of major, minor and end ticks. |\n",
"| **tickSizeEnd**| *a float* | The size, in pixels, of end ticks. |\n",
"| **tickSizeMajor**| *a float* | The size, in pixels, of major ticks. |\n",
"| **tickSizeMinor**| *a float* | The size, in pixels, of minor ticks. |\n",
"| **tickWidth**| *a float* | The width, in pixels, of ticks. |\n",
"| **ticks**| *a float* | A desired number of ticks, for axes visualizing quantitative scales. |\n",
"| **titleColor**| *a unicode string* | Color of the title, can be in hex color code or regular color name. |\n",
"| **titleFont**| *a unicode string* | Font of the title. |\n",
"| **titleFontSize**| *a float* | Size of the title. |\n",
"| **titleFontWeight**| *a unicode string* | Weight of the title. |\n",
"| **titleMaxLength**| *a float* | Max length for axis title if the title is automatically generated from the field's description. |\n",
"| **titleOffset**| *a float* | A title offset value for the axis. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Bin\n",
"\n",
"*Wrapper for Vega-Lite Bin definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **base**| *a float* | The number base to use for automatic bin determination (default is base 10). |\n",
"| **div**| *a list or None* | Scale factors indicating allowable subdivisions. |\n",
"| **max**| *a float* | The maximum bin value to consider. |\n",
"| **maxbins**| *a float* | Maximum number of bins. |\n",
"| **min**| *a float* | The minimum bin value to consider. |\n",
"| **minstep**| *a float* | A minimum allowable step size (particularly useful for integer values). |\n",
"| **step**| *a float* | An exact step size to use between bins. |\n",
"| **steps**| *a list or None* | An array of allowable step sizes to choose from. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### CellConfig\n",
"\n",
"*Wrapper for Vega-Lite CellConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **clip**| *a boolean* | -- |\n",
"| **fill**| *a unicode string* | The fill color. |\n",
"| **fillOpacity**| *a float* | The fill opacity (value between [0,1]). |\n",
"| **height**| *a float* | -- |\n",
"| **stroke**| *a unicode string* | The stroke color. |\n",
"| **strokeDash**| *a list or None* | An array of alternating stroke, space lengths for creating dashed or dotted lines. |\n",
"| **strokeDashOffset**| *a float* | The offset (in pixels) into which to begin drawing with the stroke dash array. |\n",
"| **strokeOpacity**| *a float* | The stroke opacity (value between [0,1]). |\n",
"| **strokeWidth**| *a float* | The stroke width, in pixels. |\n",
"| **width**| *a float* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Color\n",
"\n",
"*Color*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **legend**| *[Legend](#Legend)* | -- |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Column\n",
"\n",
"*Column*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **axis**| *a boolean or any value* | -- |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Config\n",
"\n",
"*Wrapper for Vega-Lite Config definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **axis**| *[AxisConfig](#AxisConfig)* | Axis Config. |\n",
"| **background**| *a unicode string* | CSS color property to use as background of visualization. |\n",
"| **cell**| *[CellConfig](#CellConfig)* | Cell Config. |\n",
"| **facet**| *[FacetConfig](#FacetConfig)* | Facet Config. |\n",
"| **legend**| *[LegendConfig](#LegendConfig)* | Legend Config. |\n",
"| **mark**| *[MarkConfig](#MarkConfig)* | Mark Config. |\n",
"| **numberFormat**| *a unicode string* | D3 Number format for axis labels and text tables. |\n",
"| **scale**| *[ScaleConfig](#ScaleConfig)* | Scale Config. |\n",
"| **timeFormat**| *a unicode string* | Default datetime format for axis and legend labels. |\n",
"| **viewport**| *a float* | The width and height of the on-screen viewport, in pixels. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Data\n",
"\n",
"*Wrapper for Vega-Lite Data definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **formatType**| *a unicode string* | One of ['json', 'csv', 'tsv']. |\n",
"| **url**| *a unicode string* | A URL from which to load the data set. |\n",
"| **values**| *a list or None* | Pass array of objects instead of a url to a file. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Detail\n",
"\n",
"*Detail*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Encoding\n",
"\n",
"*Object for storing channel encodings*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **color**| *[Color](#Color)* | Color of the marks - either fill or stroke color based on mark type. |\n",
"| **column**| *[Column](#Column)* | Horizontal facets for trellis plots. |\n",
"| **detail**| *any value or any value* | -- |\n",
"| **label**| *[Label](#Label)* | -- |\n",
"| **opacity**| *[Opacity](#Opacity)* | Opacity of the marks - either can be a value or in a range. |\n",
"| **order**| *any value or any value* | -- |\n",
"| **path**| *any value or any value* | -- |\n",
"| **row**| *[Row](#Row)* | Vertical facets for trellis plots. |\n",
"| **shape**| *[Shape](#Shape)* | The symbol's shape (only for `point` marks). |\n",
"| **size**| *[Size](#Size)* | Size of the mark. |\n",
"| **text**| *[Text](#Text)* | Text of the `text` mark. |\n",
"| **x**| *[X](#X)* | X coordinates for `point`, `circle`, `square`, `line`, `rule`, `text`, and `tick` (or to width and height for `bar` and `area` marks). |\n",
"| **y**| *[Y](#Y)* | Y coordinates for `point`, `circle`, `square`, `line`, `rule`, `text`, and `tick` (or to width and height for `bar` and `area` marks). |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Facet\n",
"\n",
"*Object for storing channel encodings*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **column**| *[Column](#Column)* | -- |\n",
"| **row**| *[Row](#Row)* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### FacetConfig\n",
"\n",
"*Wrapper for Vega-Lite FacetConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **axis**| *[AxisConfig](#AxisConfig)* | Facet Axis Config. |\n",
"| **cell**| *[CellConfig](#CellConfig)* | Facet Cell Config. |\n",
"| **grid**| *[FacetGridConfig](#FacetGridConfig)* | Facet Grid Config. |\n",
"| **scale**| *[FacetScaleConfig](#FacetScaleConfig)* | Facet Scale Config. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### FacetGridConfig\n",
"\n",
"*Wrapper for Vega-Lite FacetGridConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **color**| *a unicode string* | -- |\n",
"| **offset**| *a float* | -- |\n",
"| **opacity**| *a float* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### FacetScaleConfig\n",
"\n",
"*Wrapper for Vega-Lite FacetScaleConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **padding**| *a float* | -- |\n",
"| **round**| *a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Formula\n",
"\n",
"*Wrapper for Vega-Lite Formula definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **expr**| *a unicode string* | A string containing an expression for the formula. |\n",
"| **field**| *a unicode string* | The field in which to store the computed formula value. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Label\n",
"\n",
"*Label*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Legend\n",
"\n",
"*Wrapper for Vega-Lite Legend definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **format**| *a unicode string* | An optional formatting pattern for legend labels. |\n",
"| **gradientHeight**| *a float* | The height of the gradient, in pixels. |\n",
"| **gradientStrokeColor**| *a unicode string* | The color of the gradient stroke, can be in hex color code or regular color name. |\n",
"| **gradientStrokeWidth**| *a float* | The width of the gradient stroke, in pixels. |\n",
"| **gradientWidth**| *a float* | The width of the gradient, in pixels. |\n",
"| **labelAlign**| *a unicode string* | The alignment of the legend label, can be left, middle or right. |\n",
"| **labelBaseline**| *a unicode string* | The position of the baseline of legend label, can be top, middle or bottom. |\n",
"| **labelColor**| *a unicode string* | The color of the legend label, can be in hex color code or regular color name. |\n",
"| **labelFont**| *a unicode string* | The font of the lengend label. |\n",
"| **labelFontSize**| *a float* | The font size of lengend lable. |\n",
"| **labelOffset**| *a float* | The offset of the legend label. |\n",
"| **margin**| *a float* | The margin around the legend, in pixels. |\n",
"| **offset**| *a float* | The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle. |\n",
"| **orient**| *a unicode string* | The orientation of the legend. |\n",
"| **padding**| *a float* | The padding, in pixels, between the lengend and axis. |\n",
"| **properties**| *any value* | Optional mark property definitions for custom legend styling. |\n",
"| **shortTimeLabels**| *a boolean* | Whether month names and weekday names should be abbreviated. |\n",
"| **symbolColor**| *a unicode string* | The color of the legend symbol,. |\n",
"| **symbolShape**| *a unicode string* | The shape of the legend symbol, can be the 'circle', 'square', 'cross', 'diamond', 'triangle-up', 'triangle-down'. |\n",
"| **symbolSize**| *a float* | The size of the lengend symbol, in pixels. |\n",
"| **symbolStrokeWidth**| *a float* | The width of the symbol's stroke. |\n",
"| **title**| *a unicode string* | A title for the legend. |\n",
"| **titleColor**| *a unicode string* | Optional mark property definitions for custom legend styling. |\n",
"| **titleFont**| *a unicode string* | The font of the legend title. |\n",
"| **titleFontSize**| *a float* | The font size of the legend title. |\n",
"| **titleFontWeight**| *a unicode string* | The font weight of the legend title. |\n",
"| **values**| *a list or None* | Explicitly set the visible legend values. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### LegendConfig\n",
"\n",
"*Wrapper for Vega-Lite LegendConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **gradientHeight**| *a float* | The height of the gradient, in pixels. |\n",
"| **gradientStrokeColor**| *a unicode string* | The color of the gradient stroke, can be in hex color code or regular color name. |\n",
"| **gradientStrokeWidth**| *a float* | The width of the gradient stroke, in pixels. |\n",
"| **gradientWidth**| *a float* | The width of the gradient, in pixels. |\n",
"| **labelAlign**| *a unicode string* | The alignment of the legend label, can be left, middle or right. |\n",
"| **labelBaseline**| *a unicode string* | The position of the baseline of legend label, can be top, middle or bottom. |\n",
"| **labelColor**| *a unicode string* | The color of the legend label, can be in hex color code or regular color name. |\n",
"| **labelFont**| *a unicode string* | The font of the lengend label. |\n",
"| **labelFontSize**| *a float* | The font size of lengend lable. |\n",
"| **labelOffset**| *a float* | The offset of the legend label. |\n",
"| **margin**| *a float* | The margin around the legend, in pixels. |\n",
"| **offset**| *a float* | The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle. |\n",
"| **orient**| *a unicode string* | The orientation of the legend. |\n",
"| **padding**| *a float* | The padding, in pixels, between the lengend and axis. |\n",
"| **properties**| *any value* | Optional mark property definitions for custom legend styling. |\n",
"| **shortTimeLabels**| *a boolean* | Whether month names and weekday names should be abbreviated. |\n",
"| **symbolColor**| *a unicode string* | The color of the legend symbol,. |\n",
"| **symbolShape**| *a unicode string* | The shape of the legend symbol, can be the 'circle', 'square', 'cross', 'diamond', 'triangle-up', 'triangle-down'. |\n",
"| **symbolSize**| *a float* | The size of the lengend symbol, in pixels. |\n",
"| **symbolStrokeWidth**| *a float* | The width of the symbol's stroke. |\n",
"| **titleColor**| *a unicode string* | Optional mark property definitions for custom legend styling. |\n",
"| **titleFont**| *a unicode string* | The font of the legend title. |\n",
"| **titleFontSize**| *a float* | The font size of the legend title. |\n",
"| **titleFontWeight**| *a unicode string* | The font weight of the legend title. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### MarkConfig\n",
"\n",
"*Wrapper for Vega-Lite MarkConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **align**| *a unicode string* | The horizontal alignment of the text. One of ['left', 'right', 'center']. |\n",
"| **angle**| *a float* | The rotation angle of the text, in degrees. |\n",
"| **applyColorToBackground**| *a boolean* | Apply color field to background color instead of the text. |\n",
"| **barSize**| *a float* | The size of the bars. |\n",
"| **barThinSize**| *a float* | The size of the bars on continuous scales. |\n",
"| **baseline**| *a unicode string* | The vertical alignment of the text. One of ['top', 'middle', 'bottom']. |\n",
"| **color**| *a unicode string* | Default color. |\n",
"| **dx**| *a float* | The horizontal offset, in pixels, between the text label and its anchor point. |\n",
"| **dy**| *a float* | The vertical offset, in pixels, between the text label and its anchor point. |\n",
"| **fill**| *a unicode string* | Default Fill Color. |\n",
"| **fillOpacity**| *a float* | -- |\n",
"| **filled**| *a boolean* | Whether the shape's color should be used as fill color instead of stroke color. |\n",
"| **font**| *a unicode string* | The typeface to set the text in . |\n",
"| **fontSize**| *a float* | The font size, in pixels. |\n",
"| **fontStyle**| *a unicode string* | The font style . One of ['normal', 'italic']. |\n",
"| **fontWeight**| *a unicode string* | The font weight . One of ['normal', 'bold']. |\n",
"| **format**| *a unicode string* | The formatting pattern for text value. |\n",
"| **interpolate**| *a unicode string* | The line interpolation method to use. One of ['linear', 'linear-closed', 'step', 'step-before', 'step-after', 'basis', 'basis-open', 'basis-closed', 'cardinal', 'cardinal-open', 'cardinal-closed', 'bundle', 'monotone']. |\n",
"| **lineSize**| *a float* | Size of line mark. |\n",
"| **opacity**| *a float* | -- |\n",
"| **orient**| *a unicode string* | The orientation of a non-stacked bar, tick, area, and line charts. |\n",
"| **radius**| *a float* | Polar coordinate radial offset, in pixels, of the text label from the origin determined by the x and y properties. |\n",
"| **ruleSize**| *a float* | Size of rule mark. |\n",
"| **shape**| *a unicode string* | The symbol shape to use. One of ['circle', 'square', 'cross', 'diamond', 'triangle-up', 'triangle-down']. |\n",
"| **shortTimeLabels**| *a boolean* | Whether month names and weekday names should be abbreviated. |\n",
"| **size**| *a float* | The pixel area each the point. |\n",
"| **stacked**| *a unicode string* | One of ['zero', 'center', 'normalize', 'none']. |\n",
"| **stroke**| *a unicode string* | Default Stroke Color. |\n",
"| **strokeDash**| *a list or None* | An array of alternating stroke, space lengths for creating dashed or dotted lines. |\n",
"| **strokeDashOffset**| *a float* | The offset (in pixels) into which to begin drawing with the stroke dash array. |\n",
"| **strokeOpacity**| *a float* | -- |\n",
"| **strokeWidth**| *a float* | -- |\n",
"| **tension**| *a float* | Depending on the interpolation type, sets the tension parameter. |\n",
"| **text**| *a unicode string* | Placeholder Text. |\n",
"| **theta**| *a float* | Polar coordinate angle, in radians, of the text label from the origin determined by the x and y properties. |\n",
"| **tickSize**| *a float* | The width of the ticks. |\n",
"| **tickThickness**| *a float* | Thickness of the tick mark. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Opacity\n",
"\n",
"*Opacity*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **legend**| *[Legend](#Legend)* | -- |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Order\n",
"\n",
"*Order*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *a unicode string* | One of ['ascending', 'descending', 'none']. |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Path\n",
"\n",
"*Path*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *a unicode string* | One of ['ascending', 'descending', 'none']. |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Row\n",
"\n",
"*Row*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **axis**| *a boolean or any value* | -- |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Scale\n",
"\n",
"*Wrapper for Vega-Lite Scale definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **bandSize**| *a float* | -- |\n",
"| **clamp**| *a boolean* | If true, values that exceed the data domain are clamped to either the minimum or maximum range value. |\n",
"| **domain**| *a unicode string or any value or any value* | -- |\n",
"| **exponent**| *a float* | Sets the exponent of the scale transformation. |\n",
"| **nice**| *a boolean or any value* | -- |\n",
"| **padding**| *a float* | Applies spacing among ordinal elements in the scale range. |\n",
"| **range**| *a unicode string or any value or any value* | -- |\n",
"| **round**| *a boolean* | If true, rounds numeric output values to integers. |\n",
"| **type**| *a unicode string* | One of ['linear', 'log', 'pow', 'sqrt', 'quantile', 'quantize', 'ordinal', 'time', 'utc']. |\n",
"| **useRawDomain**| *a boolean* | Uses the source data range as scale domain instead of aggregated data for aggregate axis. |\n",
"| **zero**| *a boolean* | If true, ensures that a zero baseline value is included in the scale domain. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### ScaleConfig\n",
"\n",
"*Wrapper for Vega-Lite ScaleConfig definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **bandSize**| *a float* | Default band size for (1) `y` ordinal scale, and (2) `x` ordinal scale when the mark is not `text`. |\n",
"| **barSizeRange**| *a list or None* | Default range for bar size scale. |\n",
"| **fontSizeRange**| *a list or None* | Default range for font size scale. |\n",
"| **nominalColorRange**| *a unicode string or any value* | -- |\n",
"| **opacity**| *a list or None* | Default range for opacity. |\n",
"| **padding**| *a float* | Default padding for `x` and `y` ordinal scales. |\n",
"| **pointSizeRange**| *a list or None* | Default range for bar size scale. |\n",
"| **round**| *a boolean* | If true, rounds numeric output values to integers. |\n",
"| **ruleSizeRange**| *a list or None* | Default range for rule stroke widths. |\n",
"| **sequentialColorRange**| *a unicode string or any value* | -- |\n",
"| **shapeRange**| *a unicode string or any value* | -- |\n",
"| **textBandWidth**| *a float* | Default band width for `x` ordinal scale when is mark is `text`. |\n",
"| **tickSizeRange**| *a list or None* | Default range for tick spans. |\n",
"| **useRawDomain**| *a boolean* | Uses the source data range as scale domain instead of aggregated data for aggregate axis. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Shape\n",
"\n",
"*Shape*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **legend**| *[Legend](#Legend)* | -- |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Size\n",
"\n",
"*Size*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **legend**| *[Legend](#Legend)* | -- |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### SortField\n",
"\n",
"*Wrapper for Vega-Lite SortField definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **field**| *a unicode string* | The field name to aggregate over. |\n",
"| **op**| *a unicode string* | The sort aggregation operator. One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **order**| *a unicode string* | One of ['ascending', 'descending', 'none']. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Text\n",
"\n",
"*Text*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Transform\n",
"\n",
"*Wrapper for Vega-Lite Transform definition.*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **calculate**| *a list or None* | Calculate new field(s) using the provided expresssion(s). |\n",
"| **filter**| *a unicode string* | A string containing the filter Vega expression. |\n",
"| **filterNull**| *a boolean* | Filter null values from the data. |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### X\n",
"\n",
"*X*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **axis**| *a boolean or any value* | -- |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
},
{
"cell_type": "markdown",
"metadata": {},
"source": [
"### Y\n",
"\n",
"*Y*\n",
"\n",
"| Trait | type | description |\n",
"|-------|------|-------------|\n",
"| **aggregate**| *a unicode string* | Aggregation function for the field . One of ['values', 'count', 'valid', 'missing', 'distinct', 'sum', 'mean', 'average', 'variance', 'variancep', 'stdev', 'stdevp', 'median', 'q1', 'q3', 'modeskew', 'min', 'max', 'argmin', 'argmax']. |\n",
"| **axis**| *a boolean or any value* | -- |\n",
"| **bin**| *a boolean or any value* | -- |\n",
"| **field**| *a unicode string* | Name of the field from which to pull a data value. |\n",
"| **scale**| *[Scale](#Scale)* | -- |\n",
"| **shorthand**| *a unicode string* | -- |\n",
"| **sort**| *any value or any value* | -- |\n",
"| **timeUnit**| *a unicode string* | Time unit for a `temporal` field . One of ['year', 'month', 'day', 'date', 'hours', 'minutes', 'seconds', 'milliseconds', 'yearmonth', 'yearmonthday', 'yearmonthdate', 'yearday', 'yeardate', 'yearmonthdayhours', 'yearmonthdayhoursminutes', 'yearmonthdayhoursminutesseconds', 'hoursminutes', 'hoursminutesseconds', 'minutesseconds', 'secondsmilliseconds']. |\n",
"| **title**| *a unicode string* | Title for axis or legend. |\n",
"| **type**| *a unicode string* | The encoded field's type of measurement. One of ['quantitative', 'ordinal', 'temporal', 'nominal']. |\n",
"| **value**| *a float or a unicode string or a boolean* | -- |\n"
]
}
],
"metadata": {
"kernelspec": {
"display_name": "Python [default]",
"language": "python",
"name": "python3"
},
"language": "python",
"language_info": {
"codemirror_mode": {
"name": "ipython",
"version": 3
},
"file_extension": ".py",
"mimetype": "text/x-python",
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.5.1"
},
"widgets": {
"state": {},
"version": "1.0.0"
}
},
"nbformat": 4,
"nbformat_minor": 0
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment