OptChartVega Module

class epyk.core.html.options.OptChartVega.EnumAggregateTypes(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
argmax()

An input data object containing the maximum field value.

Related Pages:

argmin()

An input data object containing the minimum field value.

Related Pages:

average()

The mean (average) field value. Identical to mean.

Related Pages:

ci0()

The lower boundary of the bootstrapped 95% confidence interval of the mean field value.

Related Pages:

ci1()

The upper boundary of the bootstrapped 95% confidence interval of the mean field value.

Related Pages:

count()

The total count of data objects in the group.

Related Pages:

distinct()

The count of distinct field values.

Related Pages:

max()

The maximum field value.

Related Pages:

mean()

The mean (average) field value.

Related Pages:

median()

The median field value.

Related Pages:

min()

The minimum field value.

Related Pages:

missing()

The count of null, undefined, or empty string (‘’) field values.

Related Pages:

product()

The product of field values. ≥ 5.10

Related Pages:

q1()

The lower quartile boundary of field values.

Related Pages:

q3()

The upper quartile boundary of field values.

Related Pages:

stderr()

The standard error of field values.

Related Pages:

stdev()

The sample standard deviation of field values.

Related Pages:

stdevp()

The population standard deviation of field values.

Related Pages:

sum()

The sum of field values.

Related Pages:

valid()

The count of field values that are not missing or NaN.

Related Pages:

values()

The list of data objects in the group.

Related Pages:

variance()

The sample variance of field values.

Related Pages:

variancep()

The population variance of field values.

Related Pages:

class epyk.core.html.options.OptChartVega.EnumAxisTypes(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
albers()

The Albers’ equal-area conic projection. This is a U.S.-centric configuration of “conicEqualArea”.

Related Pages:

albersUsa()

A U.S.-centric composite with projections for the lower 48 states, Hawaii, and Alaska (scaled to 0.35 times the true relative area).

Related Pages:

azimuthalEqualArea()

The azimuthal equal-area projection.

Related Pages:

azimuthalEquidistant()

The azimuthal equidistant projection.

Related Pages:

conicConformal()

The conic conformal projection. The parallels default to [30°, 30°] resulting in flat top.

Related Pages:

conicEqualArea()

The Albers’ equal-area conic projection.

Related Pages:

conicEquidistant()

The conic equidistant projection.

Related Pages:

equalEarth()

The Equal Earth projection, by Bojan Šavrič et al., 2018.

Related Pages:

equirectangular()

The equirectangular (plate carrée) projection, akin to using longitude, latitude directly.

Related Pages:

gnomonic()

The gnomonic projection.

Related Pages:

identity()

The identity transform, which can be used to translate, scale, and clip planar geometry. Also supports additional boolean reflectX and reflectY parameters. ≥ 3.3

Related Pages:

mercator()

The spherical Mercator projection. Uses a default clipExtent such that the world is projected to a square, clipped to approximately ±85° latitude.

Related Pages:

mollweide()

An equal-area, pseudocylindrical map projection generally used for global maps of the world or night sky. ≥ 5.9

Related Pages:

naturalEarth1()

The Natural Earth projection is a pseudocylindrical projection designed by Tom Patterson. It is neither conformal nor equal-area, but appealing to the eye for small-scale maps of the whole world. ≥ 4.0

Related Pages:

orthographic()

The orthographic projection.

Related Pages:

stereographic()

The stereographic projection.

Related Pages:

transverseMercator()

The transverse spherical Mercator projection. Uses a default clipExtent such that the world is projected to a square, clipped to approximately ±85° latitude.

Related Pages:

class epyk.core.html.options.OptChartVega.EnumMarks(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
arc()

Circular arcs, including pie and donut slices.

Related Pages:

area()

Filled areas with horizontal or vertical alignment.

Related Pages:

group()

Containers for other marks, useful for sub-plots.

Related Pages:

image()

Images, including icons or photographs.

Related Pages:

line()

Stroked lines, often used for showing change over time.

Related Pages:

path()

Arbitrary paths or polygons, defined using SVG path syntax.

Related Pages:

rect()

Rectangles, as in bar charts and timelines.

Related Pages:

rule()

Rules are line segments, often used for axis ticks and grid lines.

Related Pages:

shape()

A special variant of path marks for faster drawing of cartographic maps.

Related Pages:

symbol()

Plotting symbols, including circles, squares and other shapes.

Related Pages:

text()

Text labels with configurable fonts, alignment and angle.

Related Pages:

trail()

Lines that can change size based on underlying data.

Related Pages:

class epyk.core.html.options.OptChartVega.EnumOrients(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
bottom()

Place the legend below the bottom of the chart.

Related Pages:

bottom_left()

Place the legend inside the lower left corner of the chart.

Related Pages:

bottom_right()

Place the legend inside the lower right corner of the chart.

Related Pages:

left()

Place the legend to the left of the chart.

Related Pages:

none()

Do not perform automatic layout. Allows custom layout by setting the legendX and legendY properties of the legend.

Related Pages:

right()

Place the legend to the right of the chart.

Related Pages:

top()

Place the legend above the top of the chart.

Related Pages:

top_left()

Place the legend inside the upper left corner of the chart.

Related Pages:

top_right()

Place the legend inside the upper right corner of the chart.

Related Pages:

class epyk.core.html.options.Enums(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
property item

Return the option object on which the key, value will be added.

property key

Returns the predefined enumeration key which will be added with this object.

class epyk.core.html.options.OptChartVega.OptAxe(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property bandPosition

An interpolation fraction indicating where, for band scales, axis ticks should be positioned. A value of 0 places ticks at the left edge of their bands. A value of 0.5 places ticks in the middle of their bands.

Related Pages:

property domain

A boolean flag indicating if the domain (the axis baseline) should be included as part of the axis (default true).

Related Pages:

property domainCap

The stroke cap for the axis domain line. One of “butt” (default), “round” or “square”. ≥ 5.11

Related Pages:

property domainColor

Color of axis domain line.

Related Pages:

property domainDash

Stroke dash of axis domain lines (or [] for solid lines). ≥ 5.0

Related Pages:

property domainDashOffset

The pixel offset at which to start the domain dash array. ≥ 5.0

Related Pages:

property domainOpacity

Opacity of axis domain line. ≥ 4.1

Related Pages:

property domainWidth

Stroke width of axis domain line.

Related Pages:

property format

The format specifier pattern for axis labels. For numerical values, must be a legal d3-format specifier. For date-time values, must be a legal d3-time-format specifier or a TimeMultiFormat object.

Related Pages:

property formatType

Specifies the type of format to use (“number”, “time”, “utc”) for scales that do not have a strict domain data type. This property is useful for formatting date-time values for band or point scales. If specified, the format property must have a valid specifier pattern for the given type. Supported ≥ 5.1, UTC support ≥ 5.8.

Related Pages:

property grid

A boolean flag indicating if grid lines should be included as part of the axis (default false).

Related Pages:

property gridCap

The stroke cap for axis grid lines. One of “butt” (default), “round” or “square”. ≥ 5.11

Related Pages:

property gridColor

Color of axis grid lines.

Related Pages:

property gridDash

Stroke dash of axis grid lines (or [] for solid lines).

Related Pages:

property gridDashOffset

The pixel offset at which to start the grid dash array. ≥ 5.0

Related Pages:

property gridOpacity

Opacity of axis grid lines.

Related Pages:

property gridScale

The name of the scale to use for including grid lines. By default grid lines are driven by the same scale as the ticks and labels.

Related Pages:

property gridWidth

Stroke width of axis grid lines.

Related Pages:

property labelAlign

Horizontal text alignment of axis tick labels, overriding the default setting for the current axis orientation.

Related Pages:

property labelAngle

Angle in degrees of axis tick labels.

Related Pages:

property labelBaseline

Vertical text baseline of axis tick labels, overriding the default setting for the current axis orientation. One of alphabetic (default), top, middle, bottom, line-top, or line-bottom. The line-top and line-bottom values ≥ 5.10 operate similarly to top and bottom, but are calculated relative to the lineHeight rather than fontSize alone.

Related Pages:

property labelBound

Indicates if labels should be hidden if they exceed the axis range. If false (the default) no bounds overlap analysis is performed. If true, labels will be hidden if they exceed the axis range by more than 1 pixel. If this property is a number, it specifies the pixel tolerance: the maximum amount by which a label bounding box may exceed the axis range.

Related Pages:

property labelColor

Text color of axis tick labels.

Related Pages:

property labelFlush

Indicates if labels at the beginning or end of the axis should be aligned flush with the scale range. If a number, indicates a pixel distance threshold: labels with anchor coordinates within the threshold distance for an axis end-point will be flush-adjusted. If true, a default threshold of 1 pixel is used. Flush alignment for a horizontal axis will left-align labels near the beginning of the axis and right-align labels near the end. For vertical axes, bottom and top text baselines will be applied instead.

Related Pages:

property labelFlushOffset

Indicates the number of pixels by which to offset flush-adjusted labels (default 0). For example, a value of 2 will push flush-adjusted labels 2 pixels outward from the center of the axis. Offsets can help the labels better visually group with corresponding axis ticks.

Related Pages:

property labelFont

Font name for axis tick labels.

Related Pages:

property labelFontSize

Font size of axis tick labels.

Related Pages:

property labelFontStyle

Font style of axis tick labels (e.g., normal or italic). ≥ 5.0

Related Pages:

property labelFontWeight

Font weight of axis tick labels.

Related Pages:

property labelLimit

The maximum allowed length in pixels of axis tick labels.

Related Pages:

property labelLineHeight

Line height in pixels for multi-line label text or label text with “line-top” or “line-bottom” baseline. ≥ 5.10

Related Pages:

property labelOffset

Position offset in pixels to apply to labels, in addition to tickOffset. ≥ 5.10

Related Pages:

property labelOpacity

Opacity of axis tick labels. ≥ 4.1

Related Pages:

property labelOverlap

The strategy to use for resolving overlap of axis labels. If false (the default), no overlap reduction is attempted. If set to true or “parity”, a strategy of removing every other label is used (this works well for standard linear axes). If set to “greedy”, a linear scan of the labels is performed, removing any label that overlaps with the last visible label (this often works better for log-scaled axes).

Related Pages:

property labelPadding

The padding in pixels between labels and ticks.

Related Pages:

property labelSeparation

The minimum separation that must be between label bounding boxes for them to be considered non-overlapping (default 0). This property is ignored if labelOverlap resolution is not enabled. ≥ 5.0

Related Pages:

property labels

A boolean flag indicating if labels should be included as part of the axis (default true).

Related Pages:

property maxExtent

The maximum extent in pixels that axis ticks and labels should use. This determines a maximum offset value for axis titles.

Related Pages:

property minExtent

The minimum extent in pixels that axis ticks and labels should use. This determines a minimum offset value for axis titles.

Related Pages:

property offset

The orthogonal offset in pixels by which to displace the axis from its position along the edge of the chart.

Related Pages:

property orient

Required. The orientation of the axis. See the axis orientation reference.

Related Pages:

property position

The anchor position of the axis in pixels (default 0). For x-axes with top or bottom orientation, this sets the axis group x coordinate. For y-axes with left or right orientation, this sets the axis group y coordinate.

Related Pages:

property scale

Required. The name of the scale backing the axis component.

Related Pages:

property tickBand

Indicates the type of tick style to use in conjunction with band scales. One of “center” (default) to center ticks in the middle of the band interval, or “extent” to place ticks at band extents (interval boundaries). If specified, this property may override the settings of bandPosition, tickExtra, and tickOffset. ≥ 5.8

Related Pages:

property tickCap

The stroke cap for axis tick marks. One of “butt” (default), “round” or “square”. ≥ 5.11

Related Pages:

property tickColor

Color of axis ticks.

Related Pages:

property tickCount

A desired number of ticks, for axes visualizing quantitative scales. The resulting number may be different so that values are “nice” (multiples of 2, 5, 10) and lie within the underlying scale’s range. For scales of type time or utc, the tick count can instead be a time interval specifier. Legal string values are “millisecond”, “second”, “minute”, “hour”, “day”, “week”, “month”, and “year”. Alternatively, an object-valued interval specifier of the form {“interval”: “month”, “step”: 3} includes a desired number of interval steps. Here, ticks are generated for each quarter (Jan, Apr, Jul, Oct) boundary.

Related Pages:

property tickDash

Stroke dash of axis tick marks (or [] for solid lines). ≥ 5.0

Related Pages:

property tickDashOffset

The pixel offset at which to start the tick mark dash array. ≥ 5.0

Related Pages:

property tickExtra

Boolean flag indicating if an extra axis tick should be added for the initial position of the axis. This flag is useful for styling axes for band scales such that ticks are placed on band boundaries rather in the middle of a band. Use in conjunction with “bandPosition”: 1 and an axis “padding” value of 0.

Related Pages:

property tickMinStep

The minimum desired step between axis ticks, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value. ≥ 5.0

Related Pages:

property tickOffset

Position offset in pixels to apply to ticks, labels, and gridlines.

Related Pages:

property tickOpacity

Opacity of axis ticks. ≥ 4.1

Related Pages:

property tickRound

Boolean flag indicating if pixel position values should be rounded to the nearest integer.

Related Pages:

property tickSize

The length in pixels of axis ticks.

Related Pages:

property tickWidth

Width in pixels of axis ticks.

Related Pages:

property ticks

A boolean flag indicating if ticks should be included as part of the axis (default true).

Related Pages:

property title

A title for the axis (none by default). For versions ≥ 5.7, a string array specifies a title with multiple lines of text.

Related Pages:

property titleAlign

Horizontal text alignment of the axis title. One of “left”, “center”, or “right”. If specified, this value overrides automatic alignment based on the titleAnchor value.

Related Pages:

property titleAnchor

The anchor position for placing the axis title. One of “start”, “middle”, “end”, or null (default, for automatic determination). For example, with an orient of “bottom” these anchor positions map to a left-, center-, or right-aligned title. The anchor point is determined relative to the axis scale range. ≥ 5.0

Related Pages:

property titleAngle

Angle in degrees of the axis title.

Related Pages:

property titleBaseline

Vertical text baseline of the axis title. One of alphabetic (default), top, middle, bottom, line-top, or line-bottom. The line-top and line-bottom values ≥ 5.10 operate similarly to top and bottom, but are calculated relative to the lineHeight rather than fontSize alone.

Related Pages:

property titleColor

Text color of the axis title.

Related Pages:

property titleFont

Font name of the axis title.

Related Pages:

property titleFontSize

Font size of the axis title.

Related Pages:

property titleFontStyle

Font style of the axis title (e.g., normal or italic). ≥ 5.0

Related Pages:

property titleFontWeight

Font weight of axis title.

Related Pages:

property titleLimit

The maximum allowed length in pixels of the axis title.

Related Pages:

property titleLineHeight

Line height in pixels for multi-line title text or title text with “line-top” or “line-bottom” baseline. ≥ 5.7

Related Pages:

property titleOpacity

Opacity of axis title. ≥ 4.1

Related Pages:

property titlePadding

The padding in pixels between the axis labels and axis title.

Related Pages:

property titleX

Custom X position of the axis title relative to the axis group, overriding the standard layout.

Related Pages:

property titleY

Custom Y position of the axis title relative to the axis group, overriding the standard layout.

Related Pages:

property translate

Coordinate space translation offset for axis layout. By default, axes are translated by a 0.5 pixel offset for both the x and y coordinates in order to align stroked lines with the pixel grid. However, for vector graphics output these pixel-specific adjustments may be undesirable, in which case translate can be changed (for example, to zero). ≥ 5.8

Related Pages:

property values

Explicitly set the visible axis tick and label values. The array entries should be legal values in the backing scale domain.

Related Pages:

property zindex

The integer z-index indicating the layering of the axis group relative to other axis, mark, and legend groups. The default value is 0 and axes and grid lines are drawn behind any marks defined in the same specification level. Higher values (1) will cause axes and grid lines to be drawn on top of marks.

Related Pages:

class epyk.core.html.options.OptChartVega.OptData(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property async_loading

≥ 5.9 A boolean flag (default false) indicating if dynamic data loading or reformatting should occur asynchronously. If true, dataflow evaluation will complete, data loading will occur in the background, and the dataflow will be re-evaluated when loading is complete. If false, dataflow evaluation will block until loading is complete and then continue within the same evaluation cycle. The use of async can allow multiple dynamic datasets to be loaded simultaneously while still supporting interactivity. However, the use of async can cause datasets to remain empty while the rest of the dataflow is evaluated, potentially affecting downstream computation.

Related Pages:

property name

Required. A unique name for the data set.

Related Pages:

property source

The name of one or more data sets to use as the source for this data set. The source property is useful in combination with a transform pipeline to derive new data. If string-valued, indicates the name of the source data set. If array-valued, specifies a collection of data source names that should be merged (unioned) together.

Related Pages:

property url

A URL from which to load the data set. Use the format property to ensure the loaded data is correctly parsed. If the format property is not specified, the data is assumed to be in a row-oriented JSON format.

Related Pages:

property values

The full data set, included inline. The values property allows data to be included directly within the specification itself. While most commonly an array of objects, other data types (such as CSV strings) may be used, subject to the format settings.

Related Pages:

class epyk.core.html.options.OptChartVega.OptEncoding(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property size

//vega.github.io/vega-lite/examples/circle_github_punchcard.html

Returns:

Type:

https

property x

OptEncodingAxe

Type:

rtype

class epyk.core.html.options.OptChartVega.OptEncodingAxe(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property aggregates

Graphical marks visually encode data using geometric primitives such as rectangles, lines, and plotting symbols.

Related Pages:

property axis

OptEncodingAxe

Type:

rtype

property legend

OptLegend

Type:

rtype

class epyk.core.html.options.OptChartVega.OptLabel(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property interactive

Related Pages:

https://vega.github.io/vega/docs/axes/

property name

Related Pages:

https://vega.github.io/vega/docs/axes/

property update

OptUpdate

Type:

rtype

class epyk.core.html.options.OptChartVega.OptLegend(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property clipHeight

The height in pixels to clip symbol legend entries and limit their size. By default no clipping is performed.

Related Pages:

property columnPadding

The horizontal padding in pixels between symbol legend entries.

Related Pages:

property columns

The number of columns in which to arrange symbol legend entries. A value of 0 or lower indicates a single row with one column per entry. The default is 0 for horizontal symbol legends and 1 for vertical symbol legends.

Related Pages:

property cornerRadius

Corner radius for the full legend.

Related Pages:

property direction

The direction of the legend, one of “vertical” (default) or “horizontal”.

Related Pages:

property encode

OptLegendEncode

Type:

rtype

property fill

The name of a scale that maps to a fill color.

Related Pages:

property fillColor

Background fill color for the full legend.

Related Pages:

property format

The format specifier pattern for legend labels. For numerical values, must be a legal d3-format specifier. For date-time values, must be a legal d3-time-format specifier or a TimeMultiFormat object.

Related Pages:

property formatType

Specifies the type of format to use (“number”, “time”, “utc”) for scales that do not have a strict domain data type. This property is useful for formatting date-time values for ordinal scales. If specified, the format property must have a valid specifier pattern for the given type. Supported ≥ 5.1, UTC support ≥ 5.8.

Related Pages:

property gradientLength

The length in pixels of the primary axis of a color gradient. This value corresponds to the height of a vertical gradient or the width of a horizontal gradient.

Related Pages:

property gradientOpacity

Opacity of the color gradient. ≥ 4.1

Related Pages:

property gradientStrokeColor

Stroke color of the color gradient border.

Related Pages:

property gradientStrokeWidth

Stroke width of the color gradient border.

Related Pages:

property gradientThickness

The thickness in pixels of the color gradient. This value corresponds to the width of a vertical gradient or the height of a horizontal gradient.

Related Pages:

property gridAlign

The alignment to apply to symbol legends rows and columns. The supported string values are all, each (the default), and none. For more information, see the grid layout documentation.

Related Pages:

property labelAlign

Horizontal text alignment for legend labels.

Related Pages:

property labelBaseline

Vertical text baseline for legend labels. One of alphabetic (default), top, middle, bottom, line-top, or line-bottom. The line-top and line-bottom values ≥ 5.10 operate similarly to top and bottom, but are calculated relative to the lineHeight rather than fontSize alone.

Related Pages:

property labelColor

Text color for legend labels.

Related Pages:

property labelFont

Font name for legend labels.

Related Pages:

property labelFontSize

Font size in pixels for legend labels.

Related Pages:

property labelFontStyle

Font style of legend labels (e.g., normal or italic). ≥ 5.0

Related Pages:

property labelFontWeight

Font weight of legend labels.

Related Pages:

property labelLimit

The maximum allowed length in pixels of legend labels.

Related Pages:

property labelOffset

Offset in pixels between legend labels their corresponding symbol or gradient.

Related Pages:

property labelOpacity

Opacity of legend labels. ≥ 4.1

Related Pages:

property labelOverlap

The strategy to use for resolving overlap of labels in gradient legends. If false, no overlap reduction is attempted. If set to true (default) or “parity”, a strategy of removing every other label is used. If set to “greedy”, a linear scan of the labels is performed, removing any label that overlaps with the last visible label.

Related Pages:

property labelSeparation

The minimum separation that must be between label bounding boxes for them to be considered non-overlapping (default 0). This property is ignored if labelOverlap resolution is not enabled. ≥ 5.0

Related Pages:

property legendX

The pixel x-coordinate of the legend group. Only applied if the orient value is “none”. ≥ 5.4

Related Pages:

property legendY

The pixel y-coordinate of the legend group. Only applied if the orient value is “none”. ≥ 5.4

Related Pages:

property offset

The offset in pixels by which to displace the legend from the data rectangle and axes. If provided, this value will override any values specified in the legend config. If multiple offset values are specified for a collection of legends with the same orient value, the maximum offset will be used.

Related Pages:

property opacity

The name of a scale that maps to an opacity value.

Related Pages:

property orient

The orientation of the legend, determining where the legend is placed relative to a chart’s data rectangle (default right). See the legend orientation reference.

Related Pages:

property padding

The padding between the border and content of the legend group.

Related Pages:

property rowPadding

The vertical padding in pixels between symbol legend entries.

Related Pages:

property shape

The name of a scale that maps to a shape value.

Related Pages:

property size

The name of a scale that maps to a size (area) value.

Related Pages:

property stroke

The name of a scale that maps to a stroke color.

Related Pages:

property strokeColor

Border stroke color for the full legend.

Related Pages:

property strokeDash

The name of a scale that maps to a stroke dash value.

Related Pages:

property strokeWidth

The name of a scale that maps to a stroke width value. ≥ 5.0

Related Pages:

property symbolDash

Stroke dash of symbol outlines (or [] for solid lines). ≥ 5.0

Related Pages:

property symbolDashOffset

The pixel offset at which to start the symbol dash array. ≥ 5.0

Related Pages:

property symbolFillColor

Fill color for legend symbols.

Related Pages:

property symbolLimit

The maximum number of allowed entries for a symbol legend. If the number of entries exceeds the limit, entries will be dropped and replaced with an ellipsis. ≥ 5.7

Related Pages:

property symbolOffset

Horizontal pixel offset for legend symbols.

Related Pages:

property symbolOpacity

Opacity of legend symbols. ≥ 4.1

Related Pages:

property symbolSize

Default symbol area size (in pixels2).

Related Pages:

property symbolStrokeColor

Stroke color for legend symbols.

Related Pages:

property symbolStrokeWidth

Default legend symbol stroke width.

Related Pages:

property symbolType

Default symbol mark shape type (such as “circle”) for legend symbols.

Related Pages:

property tickCount

The desired number of tick values for quantitative legends. For scales of type time or utc, the tick count can instead be a time interval specifier. Legal string values are “millisecond”, “second”, “minute”, “hour”, “day”, “week”, “month”, and “year”. Alternatively, an object-valued interval specifier of the form {“interval”: “month”, “step”: 3} includes a desired number of interval steps. Here, ticks are generated for each quarter (Jan, Apr, Jul, Oct) boundary.

Related Pages:

property tickMinStep

The minimum desired step between tick values for quantitative legends, in terms of scale domain values. For example, a value of 1 indicates that ticks should not be less than 1 unit apart. If tickMinStep is specified, the tickCount value will be adjusted, if necessary, to enforce the minimum step value. ≥ 5.0

Related Pages:

property title

The title for the legend (none by default). For versions ≥ 5.7, a string array specifies a title with multiple lines of text.

Related Pages:

property titleAlign

Horizontal text alignment of the legend title. One of “left”, “center”, or “right”. If specified, this value overrides automatic alignment based on the titleOrient and titleAnchor values.

Related Pages:

property titleAnchor

The anchor position for placing the legend title. One of “start”, “middle”, “end”, or null (default, for automatic determination). For example, with a titleOrient of “top” these anchor positions map to a left-, center-, or right-aligned title relative to the legend contents. ≥ 5.0

Related Pages:

property titleBaseline

Vertical text baseline of the legend title. One of alphabetic (default), top, middle, bottom, line-top, or line-bottom. The line-top and line-bottom values ≥ 5.10 operate similarly to top and bottom, but are calculated relative to the lineHeight rather than fontSize alone. If specified, this value overrides the automatic baseline based on the titleOrient and titleAnchor values.

Related Pages:

property titleColor

Text color of the legend title.

Related Pages:

property titleFont

Font name of the legend title.

Related Pages:

property titleFontSize

Font size in pixels of the legend title.

Related Pages:

property titleFontStyle

Font style of the legend title (e.g., normal or italic). ≥ 5.0

Related Pages:

property titleFontWeight

Font weight of the legend title.

Related Pages:

property titleLimit

The maximum allowed length in pixels of the legend title.

Related Pages:

property titleLineHeight

Line height in pixels for multi-line title text or title text with “line-top” or “line-bottom” baseline. ≥ 5.7

Related Pages:

property titleOpacity

Opacity of the legend title. ≥ 4.1

Related Pages:

property titleOrient

The orientation of the title legend, determining where it is placed relative to the legend contents. One of “top” (default), “left”, “bottom”, or “right”. ≥ 5.0

Related Pages:

property titlePadding

The padding between the legend title and entries.

Related Pages:

property type

The type of legend to include. One of symbol for discrete symbol legends, or gradient for a continuous color gradient. If gradient is used only the fill or stroke scale parameters are considered. If unspecified, the type will be inferred based on the scale parameters used and their backing scale types.

Related Pages:

property values

Explicitly set the visible legend values. The array entries should be legal values in the backing scale domain.

Related Pages:

property zindex

The integer z-index indicating the layering of the legend group relative to other axis, mark, and legend groups. The default value is 0.

Related Pages:

class epyk.core.html.options.OptChartVega.OptLegendEncode(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property labels

OptLabel

Type:

rtype

property symbols

OptLabel

Type:

rtype

class epyk.core.html.options.OptChartVega.OptMark(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property align

Related Pages:

https://vega.github.io/vega/docs/marks/

property dx

Related Pages:

https://vega.github.io/vega/docs/marks/

property interactive

A boolean flag (default true) indicating if the marks can serve as input event sources. If false, no mouse or touch events corresponding to the marks will be generated. This property can also take a Signal value to dynamically toggle interactive status.

Related Pages:

property name

A unique name for the mark. This name can be used to refer to these marks within an event stream definition. SVG renderers will add this name value as a CSS class name on the enclosing SVG group (g) element containing the mark instances.

Related Pages:

property role

A metadata string indicating the role of the mark. SVG renderers will add this role value (prepended with the prefix role-) as a CSS class name on the enclosing SVG group (g) element containing the mark instances. Roles are used internally by Vega to guide layout. Do not set this property unless you know which layout effect you are trying to achieve.

Related Pages:

property style

A string or array of strings indicating the name of custom styles to apply to the mark. A style is a named collection of mark property defaults defined within the configuration. These properties will be applied to the mark’s enter encoding set, with later styles overriding earlier styles. Any properties explicitly defined within the mark’s encode block will override a style default.

Related Pages:

property type

Required. The graphical mark type. Must be one of the supported mark types.

Related Pages:

property zindex

The integer z-index indicating the layering of this mark set relative to other marks, axes, or legends. The default value is 0; higher values (1) will cause this mark set to be drawn on top of other mark, axis, or legend definitions with lower z-index values. Note that this value applies to the all marks in a set, not individual mark items. To adjust the ordering of items within a set, use the zindex encoding channel.

Related Pages:

class epyk.core.html.options.OptChartVega.OptMarkClip(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property path

An SVG path string describing the clipping region. The path is assumed to lie relative to the coordinate system of the enclosing group.

Related Pages:

property sphere

The name of a cartographic projection with which to clip all marks to the projected sphere of the globe. This option is useful in conjunction with map projections that otherwise included projected content (such as graticule lines) outside the bounds of the globe.

Related Pages:

class epyk.core.html.options.OptChartVega.OptMarkFacet(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property data

Required. The name of the source data set from which the facet partitions are generated.

Related Pages:

property name

Required. The name of the generated facet data source. Marks defined with the faceted group mark can reference this data source to visualize the local data partition.

Related Pages:

class epyk.core.html.options.OptChartVega.OptMarkFrom(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property path

An SVG path string describing the clipping region. The path is assumed to lie relative to the coordinate system of the enclosing group.

Related Pages:

property sphere

The name of a cartographic projection with which to clip all marks to the projected sphere of the globe. This option is useful in conjunction with map projections that otherwise included projected content (such as graticule lines) outside the bounds of the globe.

Related Pages:

class epyk.core.html.options.OptChartVega.OptOpacity(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property test

Related Pages:

https://vega.github.io/vega/docs/axes/

property value

Related Pages:

https://vega.github.io/vega/docs/axes/

class epyk.core.html.options.OptChartVega.OptProjection(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property center

The projection’s center, a two-element array of longitude and latitude in degrees. The default value is [0, 0].

Related Pages:

property clipAngle

The projection’s clipping circle radius, specified as an angle in degrees. If null, switches to antimeridian cutting rather than small-circle clipping.

Related Pages:

property clipExtent

The projection’s viewport clip extent, as a set of pixel bounds. The extent bounds are specified as an array [[x0, y0], [x1, y1]], where x0 is the left-side of the viewport, y0 is the top, x1 is the right and y1 is the bottom. If null, no viewport clipping is performed.

Related Pages:

property extent

Used in conjunction with fit, provides the pixel area to which the projection should be automatically fit. The extent bounds are specified as an array [[x0, y0], [x1, y1]], where x0 is the left side of the extent, y0 is the top, x1 is the right and y1 is the bottom.

Related Pages:

property fit

GeoJSON data to which the projection should attempt to automatically fit the translate and scale parameters. If object-valued, this parameter should be a GeoJSON Feature or FeatureCollection. If array-valued, each array member may be a GeoJSON Feature, FeatureCollection, or a sub-array of GeoJSON Features.

Related Pages:

property name

Required. A unique name for the projection. Projections and scales share the same namespace; names must be unique across both.

Related Pages:

property parallels

For conic projections, the two standard parallels that define the map layout. The default depends on the specific conic projection used.

Related Pages:

property pointRadius

The default radius (in pixels) to use when drawing GeoJSON Point and MultiPoint geometries. This parameter sets a constant default value. To modify the point radius in response to data, see the corresponding parameter of the GeoPath and GeoShape transforms. The default value is 4.5.

Related Pages:

property precision

The threshold for the projection’s adaptive resampling in pixels. This value corresponds to the Douglas–Peucker distance. If precision is not specified, returns the projection’s current resampling precision which defaults to √0.5 ≅ 0.70710…

Related Pages:

property rotate

The projection’s three-axis rotation angles. The value must be a two- or three-element array of numbers [lambda, phi, gamma] specifying the rotation angles in degrees about each spherical axis. (These correspond to yaw, pitch and roll.) The default value is [0, 0, 0].

Related Pages:

property scale

The projection’s scale factor. The default scale is projection-specific. The scale factor corresponds linearly to the distance between projected points; however, scale factor values are not equivalent across projections.

Related Pages:

property size

Used in conjunction with fit, provides the width and height in pixels of the area to which the projection should be automatically fit. This parameter is equivalent to an extent of [[0,0], size].

Related Pages:

property translate

The projection’s translation offset as a two-element array [tx, ty]. If translate is not specified, returns the current translation offset which defaults to [480, 250]. The translation offset determines the pixel coordinates of the projection’s center. The default translation offset places (0°,0°) at the center of a 960×500 area.

Related Pages:

property type

The cartographic projection to use. The default is “mercator”. This value is case-insensitive, for example “albers” and “Albers” indicate the same projection type.

Related Pages:

class epyk.core.html.options.OptChartVega.OptRepeat(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartVega.OptScale(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property clamp

A boolean indicating if output values should be clamped to the range (default false). If clamping is disabled and the scale is passed a value outside the domain, the scale may return a value outside the range through extrapolation. If clamping is enabled, the output value of the scale is always within the scale’s range.

Related Pages:

property domainMax

Sets the maximum value in the scale domain, overriding the domain property. The domainMax property is only intended for use with scales having continuous domains.

Related Pages:

property domainMid

Inserts a single mid-point value into a two-element domain. The mid-point value must lie between the domain minimum and maximum values. This property can be useful for setting a midpoint for diverging color scales. The domainMid property is only intended for use with scales supporting continuous, piecewise domains.

Related Pages:

property domainMin

Sets the minimum value in the scale domain, overriding the domain property. The domainMin property is only intended for use with scales having continuous domains.

Related Pages:

property interpolate

The interpolation method for range values. By default, continuous scales use a general interpolator for numbers, dates, strings and colors (in RGB space) is used. For color ranges, this property allows interpolation in alternative color spaces. Legal values include rgb, hsl, hsl-long, lab, hcl, hcl-long, cubehelix and cubehelix-long (‘-long’ variants use longer paths in polar coordinate spaces). If object-valued, this property accepts an object with a string-valued type property and an optional numeric gamma property applicable to rgb and cubehelix interpolators. For more, see the d3-interpolate documentation.

Related Pages:

property name

Required. A unique name for the scale. Scales and projections share the same namespace; names must be unique across both.

Related Pages:

property nice

Extends the domain so that it starts and ends on nice round values (default false). This method typically modifies the scale’s domain, and may only extend the bounds to the nearest round value. Nicing is useful if the domain is computed from data and may be irregular. For example, for a domain of [0.201479…, 0.996679…], a nice domain might be [0.2, 1.0]. Domain values set via domainMin and domainMax (but not domainRaw) are subject to nicing. Using a number value for this parameter (representing a desired tick count) allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

Related Pages:

property padding

Expands the scale domain to accommodate the specified number of pixels on each of the scale range. The scale range must represent pixels for this parameter to function as intended. Padding adjustment is performed prior to all other adjustments, including the effects of the zero, nice, domainMin, and domainMax properties.

Related Pages:

property range

return:

property reverse

A boolean flag (default false) that reverses the order of the scale range.

Related Pages:

property round

A boolean flag (default false) that rounds numeric output values to integers. Helpful for snapping to a pixel grid.

Related Pages:

property type

The type of scale (default linear). See the scale type reference for more.

Related Pages:

property zero

Boolean flag indicating if the scale domain should include zero. The default value is true for linear, sqrt and pow, and false otherwise.

Related Pages:

class epyk.core.html.options.OptChartVega.OptScaleBand(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property align

The alignment of elements within the scale range. This value must lie in the range [0,1]. A value of 0.5 (default) indicates that the bands should be centered within the range. A value of 0 or 1 may be used to shift the bands to one side, say to position them adjacent to an axis. For more, see this explainer for D3 band align.

Related Pages:

property domainImplicit

A boolean flag (default false) indicating if an ordinal domain should be implicitly extended with new values. If false, the scale will return undefined for values not explicitly included in the domain. If true, new values will be appended to the domain and the matching range value will be returned.

Related Pages:

property padding

Sets paddingInner and paddingOuter to the same padding value (default 0). This value must lie in the range [0,1].

Related Pages:

property paddingInner

The inner padding (spacing) within each band step, as a fraction of the step size (default 0). This value must lie in the range [0,1].

Related Pages:

property paddingOuter

The outer padding (spacing) at the ends of the scale range, as a fraction of the step size (default 0). This value must lie in the range [0,1].

Related Pages:

class epyk.core.html.options.OptChartVega.OptScaleBins(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartVega.OptScaleDomain(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartVega.OptScalePoint(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property align

The alignment of elements within the scale range. This value must lie in the range [0,1]. A value of 0.5 (default) indicates that the points should be centered within the range. A value of 0 or 1 may be used to shift the points to one side, say to position them adjacent to an axis.

Related Pages:

property padding

An alias for paddingOuter (default 0). This value must lie in the range [0,1].

Related Pages:

property paddingOuter

The outer padding (spacing) at the ends of the scale range, as a fraction of the step size (default 0). This value must lie in the range [0,1].

Related Pages:

class epyk.core.html.options.OptChartVega.OptScaleQuantExpo(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property exponent

The exponent to use in the scale transform (default 1).

Related Pages:

class epyk.core.html.options.OptChartVega.OptScaleQuantLog(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property base

The base of the logarithm (default 10).

Related Pages:

class epyk.core.html.options.OptChartVega.OptScaleQuantLogScales(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property constant

A constant determining the slope of the symlog function around zero (default 1).

Related Pages:

class epyk.core.html.options.OptChartVega.OptScaleTime(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property nice

If specified, modifies the scale domain to use a more human-friendly value range. For time and utc scale types, the nice value can additionally be a string indicating the desired time interval.

Related Pages:

class epyk.core.html.options.OptChartVega.OptSignal(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptChartVega.OptSignalOnEvent(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property update

Update the object internal attributes.

Parameters:

vals – All the attributes to be added to the component

class epyk.core.html.options.OptChartVega.OptSpec(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_signal(name, value=None)

Signals are dynamic variables that parameterize a visualization and can drive interactive behaviors.

Usage:

https://vega.github.io/vega/docs/signals/
Parameters:

name – String. A unique name for the signal.

Return type:

OptSignal

class epyk.core.html.options.OptChartVega.OptTitle(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property align

Horizontal text alignment of the title and subtitle. If specified, this value overrides automatic alignment based on the anchor value.

Related Pages:

property anchor

The anchor position for placing the title and subtitle. One of start, middle (the default), or end. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

Related Pages:

property angle

Angle in degrees of the title and subtitle text.

Related Pages:

property baseline

Vertical baseline of the title and subtitle text. One of alphabetic (default), top, middle, bottom, line-top, or line-bottom. The line-top and line-bottom values ≥ 5.10 operate similarly to top and bottom, but are calculated relative to the lineHeight rather than fontSize alone.

Related Pages:

property color

Text color of the title text.

Related Pages:

property dx

Horizontal offset added to the title and subtitle x-coordinate. ≥ 5.2

Related Pages:

property dy

Vertical offset added to the title and subtitle y-coordinate. ≥ 5.2

Related Pages:

property font

Font name of the title text.

Related Pages:

property fontSize

Font size in pixels of the title text.

Related Pages:

property fontStyle

Font style of the title text (e.g., normal or italic). ≥ 5.0

Related Pages:

property fontWeight

Font weight of the title text.

Related Pages:

property frame

The reference frame for the anchor position, one of “bounds” (the default, to anchor relative to the full bounding box) or “group” (to anchor relative to the group width or height).

Related Pages:

property interactive

A boolean flag indicating if the title element should respond to input events such as mouse hover. Deprecated: use a custom encode block instead.

Related Pages:

property limit

The maximum allowed length in pixels of title and subtitle text.

Related Pages:

property lineHeight

Line height in pixels for multi-line title text or title text with “line-top” or “line-bottom” baseline. ≥ 5.7

Related Pages:

property name

A mark name property to apply to the title text mark. Deprecated: use a custom encode block instead.

Related Pages:

property offset

The orthogonal offset in pixels by which to displace the title from its position along the edge of the chart.

Related Pages:

property orient

The orientation of the title and subtitle relative to the chart. One of top (the default), bottom, left, or right.

Related Pages:

property style

A mark style property to apply to the title text mark. If not specified, a default style of “group-title” is applied. Deprecated: use a custom encode block instead.

Related Pages:

property subtitle

Optional subtitle text, placed beneath the primary text. A string array specifies multiple lines of text. ≥ 5.7

Related Pages:

property subtitleColor

Text color of the subtitle text. ≥ 5.7

Related Pages:

property subtitleFont

Font name of the subtitle text. ≥ 5.7

Related Pages:

property subtitleFontSize

Font size in pixels of the subtitle text. ≥ 5.7

Related Pages:

property subtitleFontStyle

Font style of the subtitle text (e.g., normal or italic). ≥ 5.7

Related Pages:

property subtitleFontWeight

Font weight of the subtitle text. ≥ 5.7

Related Pages:

property subtitleLineHeight

Line height in pixels for multi-line subtitle text. ≥ 5.7

Related Pages:

property subtitlePadding

Padding in pixels between title and subtitle text. ≥ 5.7

Related Pages:

property text

Required. The title text. For versions ≥ 5.7, a string array specifies multiple lines of text.

Related Pages:

property zindex

The integer z-index indicating the layering of the title group relative to other axis, mark, and legend groups. The default value is 0.

Related Pages:

class epyk.core.html.options.OptChartVega.OptTransAgg(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property cross

Indicates if the full cross-product of all groupby values should be included in the aggregate output (default false). If set to true, all possible combinations of groupby field values will be considered and zero count groups will be generated and returned for combinations that do not occur in the data itself. Cross-product output act as if the drop parameter is false. In the case of streaming updates, the number of output groups will increase if new groupby field values are observed; all prior groups will be retained. This parameter can be useful for generating facets that include groups for all possible partitions of the data.

Related Pages:

property drop

Indicates if empty (zero count) groups should be dropped (default true). When a data stream updates (for example, in response to interactive filtering), aggregation groups may become empty. By default, the group is removed from the output. However, in some cases (such as histograms), one may wish to retain empty groups.

Related Pages:

class epyk.core.html.options.OptChartVega.OptUpdate(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_opacity(value, test=None)
Return type:

OptOpacity

class epyk.core.html.options.Options(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property builder

Add a JavaScript Builder function to the options.

This will be used to automatically map the Python component to its corresponding JavaScript builder function used by the build method.

Usage:

but = page.ui.button()
but.options.builder = "Button"
Prop value:

The JavaScript builder function name.

property config_default

The default value for the configuration in case of template.

Default value is an empty string.

Usage:

component.options.config_default = {"value": "test"}
config_html()

Return the HTML options used by the python and passed to the HTML.

Those options will not be available in the JavaScript layer and they are only defined either to build the HTML from Python or to set some HTML properties.

The returned dictionary is a copy so it can be changed or used in other processes. To change the internal component property, the options property should be used.

config_js(attrs: Optional[dict] = None)

Return the JavaScript options used by the builders functions.

Builder functions can be defined in the framework or external from the various packages.

The returned dictionary is a copy so it can be changed or used in other processes. To change the internal component property, the options property should be used.

Parameters:

attrs – Optional. The extra or overridden options

custom_config(name: str, value: Any, js_type: bool = False)

Add a custom JavaScript configuration.

Usage:

chart = page.ui.charts.apex.scatter()
chart.options.chart.zoom.custom_config("test", False)
Parameters:

  • name – The key to be added to the attributes

  • value – String or JString. The value of the defined attributes

  • js_type – Optional. Specify if the parameter is a JavaScript fragment

details()

Retrieve the defined properties details.

This function will return a dictionary with all the component attributes (required and optional) ones. It will provide the full available description of those components.

Usage:

but = page.ui.button()
pprint.pprint(but.options.details(), indent=4)
from_json(vals: dict, schema: Optional[dict] = None)

Load the option schema for a component from a json string.

TODO: add more feature to handle functions and enumeration

Parameters:

  • vals – The input schema

  • schema – The full object schema

has_attribute(cls_obj, name: Optional[str] = None)

Add an extra sub layer to the data structure.

The key in the object representation will be the function name.

Parameters:

  • cls_obj – Class. The sub data class used in the structure definition

  • name – The sub attribute name

isJsContent(property_name: str)

Check if the content of a property is defined to always be a JavaScript fragment.

Thus the framework will not convert it to a Json content.

Usage:

div = page.ui.div()
print(div.options.isJsContent("inline"))
Parameters:

property_name – The property name

property managed

Boolean flag to set if the component needs to be added to the page.

If set to False the component has to be managed manually in the page.

Usage:

but = page.ui.button()
but.options.managed = False
Prop bool:

Flag to specify if this component is automatically managed by the page

optional()

Return all options not added to the HTML component by default.

Those are options which will impact either the Python or the JavaScript builders.

To get the full definition of options the details method should be used.

Usage:

but = page.ui.button()
pprint.pprint(but.options.optional(), indent=4)
property profile

Boolean flag to set if extra logs need to be displayed.

This could help in debugging, default is the page verbose flag (default is false).

Usage:

but = page.ui.button()
but.options.verbose = True
Prop flag:

Flag to display / hide warning logs generated by the framework.

required()

Return all the mandatory / required options with the default values.

Those options are added by the framework to provide a default for the HTML components but they can be changed.

System options are also added to this category as they are always available in any HTML components.

To get the full definition of options the details method should be used.

Usage:

but = page.ui.button()
pprint.pprint(but.options.required(), indent=4)
set_attrs(vals: dict)

Set the object internal attributes.

Parameters:

vals – All the attributes to be added to the component

property style

Change some CSS attributes to the internal HTML component.

Related Pages:

Prop values:

The CSS attributes.

update_config(attrs: dict)

Update the option configuration.

Parameters:

attrs – The attributes to set

property verbose

Boolean flag to set if extra logs need to be displayed.

This could help in debugging, default is the page verbose flag (default is false).

Usage:

but = page.ui.button()
but.options.verbose = True
Prop flag:

Boolean. Flag to display / hide warning logs generated by the framework.

class epyk.core.html.options.OptChartVega.OptionsChart(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property schema

The URL for the Vega schema.

https://vega.github.io/vega/docs/specification/

class epyk.core.html.options.OptChartVega.OptionsLayer(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_axe(scale, orient)

Axes visualize spatial scale mappings using ticks, grid lines and labels.

Related Pages:

Parameters:

  • scale – String. The name of the scale backing the axis component.

  • orient – String. The orientation of the axis.

Return type:

OptAxe

add_layer()
add_legend(kind, title=None)

Legends visualize scale mappings for visual values such as color, shape and size.

Related Pages:

Usage:

https://vega.github.io/vega/examples/interactive-legend/
Parameters:

  • kind – String. The type of legend to include.

  • title – String. The title for the legend (none by default).

Return type:

OptLegend

add_mark(kind)

Graphical marks visually encode data using geometric primitives such as rectangles, lines, and plotting symbols.

Usage:

https://vega.github.io/vega/docs/marks/
Parameters:

kind – String. The graphical mark type.

Return type:

OptMark

add_projection(name)

Cartographic projections map (longitude, latitude) pairs to projected (x, y) coordinates.

Related Pages:

Parameters:

name – String. A unique name for the projection.

Return type:

OptProjection

add_scale(name, range=None)

Scales map data values (numbers, dates, categories, etc.) to visual values (pixels, colors, sizes).

Related Pages:

Parameters:

  • name – String. A unique name for the scale.

  • range – String

Return type:

OptScale

add_signal(name, value=None)

Signals are dynamic variables that parameterize a visualization and can drive interactive behaviors.

Usage:

https://vega.github.io/vega/docs/signals/
Parameters:

name – String. A unique name for the signal.

Return type:

OptSignal

property autosize

Sets how the visualization size should be determined. If a string, should be one of pad (default), fit, fit-x, fit-y, or none. Object values can additionally specify parameters for content sizing and automatic resizing. See the autosize section below for more. If signal-valued ≥ 5.10, the provided expression is used as the update property for the underlying autosize signal definition, and should evaluate to a complete autosize object.

Related Pages:

property data

OptData

Type:

rtype

property description

A text description of the visualization. In versions ≥ 5.10, the description determines the aria-label attribute for the container element of a Vega view.

Related Pages:

property height

The height in pixels of the data rectangle. If signal-valued ≥ 5.10, the provided expression is used as the update property for the underlying height signal definition.

Related Pages:

property marks

Graphical marks visually encode data using geometric primitives such as rectangles, lines, and plotting symbols.

Related Pages:

property padding

The padding in pixels to add around the visualization. If a number, specifies padding for all sides. If an object, the value should have the format {“left”: 5, “top”: 5, “right”: 5, “bottom”: 5}. Padding is applied after autosize layout completes. If signal-valued ≥ 5.10, the provided expression is used as the update property for the underlying padding signal definition, and should evaluate to either a padding object or number.

Related Pages:

property repeat

OptData

Type:

rtype

property spec

OptSpec

Type:

rtype

property width

The width in pixels of the data rectangle. If signal-valued ≥ 5.10, the provided expression is used as the update property for the underlying width signal definition.

Related Pages: