enum: SCHEMA_TYPE_UNSPECIFIED 0 AVRO 1 JSONSCHEMA 2

markdownEnumDescriptions:
(or 0)
(or "SCHEMA_TYPE_UNSPECIFIED")
(or 1)
(or "AVRO")
(or 2)
(or "JSONSCHEMA")

enum: STATE_UNSPECIFIED 0 DRAFT 1 ACTIVE 2 ARCHIVED 3 IN_REVIEW 4 INCOMPLETE 5 APPROVED 6

markdownEnumDescriptions: (or 1) This schema is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or "DRAFT") This schema is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or 2) This schema is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "ACTIVE") This schema is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or 3) This schema is valid and complete has been active, but no more events can be sent using this schema. In-flight events are still processed.

markdownEnumDescriptions: (or "ARCHIVED") This schema is valid and complete has been active, but no more events can be sent using this schema. In-flight events are still processed.

markdownEnumDescriptions: (or 4) This schema is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or "IN_REVIEW") This schema is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or 5) This schema is still under construction.

markdownEnumDescriptions: (or "INCOMPLETE") This schema is still under construction.

markdownEnumDescriptions: (or 6) This schema is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "APPROVED") This schema is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

enum: STATE_UNSPECIFIED 0 DRAFT 1 IN_REVIEW 2 ACTIVE 3 ARCHIVED 4 INCOMPLETE 5 APPROVED 6

markdownEnumDescriptions: (or 1) This data contract is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or "DRAFT") This data contract is valid and complete, but has not been accepted yet, can still be modified and also deleted.

markdownEnumDescriptions: (or 2) This data contract is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or "IN_REVIEW") This data contract is in review. It can be used once it has been approved.

markdownEnumDescriptions: (or 3) This data contract is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "ACTIVE") This data contract is valid and complete can be used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or 4) This data contract is valid and complete has been active, but no more events can be sent using this data contract. In-flight events are still processed.

markdownEnumDescriptions: (or "ARCHIVED") This data contract is valid and complete has been active, but no more events can be sent using this data contract. In-flight events are still processed.

markdownEnumDescriptions: (or 5) This data contract is still under construction.

markdownEnumDescriptions: (or "INCOMPLETE") This data contract is still under construction.

markdownEnumDescriptions: (or 6) This data contract is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

markdownEnumDescriptions: (or "APPROVED") This data contract is approved and when activated can be used used for events and batch jobs. It cannot be modified or deleted.

title: Unknown field

title: string field = 1;

description: constraint: valid field path, follows avro constraints + slashes

title: string type = 2;

description:
constraint: one of the validator types. handled by code
This should become an enum

title: string value = 3;

description: constraint: a type specific definition

markdownEnumDescriptions:
(or 0)
(or "NULL_HANDLING_TYPE_UNSPECIFIED")
(or 1)
(or "DROP_RECORD")
(or 2)
(or "DEFAULT_VALUE")

title: Unknown field

title: google.protobuf.Timestamp create_time = 3;

description: The timestamp when this Schema was created.

title: string description = 2;

description: The description of this Schema. Used in the Portal. Markdown syntax is supported. This field can be modified.

title: string

title: repeated string domains = 6;

title: string icon_uri = 4;

description: The URI to the icon used with this Schema. This always an absolute URI, with the https scheme. Used in the Portal.

title: string

title: repeated string industries = 7;

title: strmprivacy.api.entities.v1.Label

title: repeated strmprivacy.api.entities.v1.Label labels = 5;

description: Generic (key/value) labels for this Schema.

title: string title = 1;

description: The human readable title of this Schema. Used in the Portal. Defaults to the Schema name. This field can be modified.

title: Unknown field

description: The timestamp when this Data Contract was created.

title: string description = 2;

description: The description of this Data Contract. Used in the Portal. Markdown syntax is supported. This field can be modified.

title: string

title: repeated string domains = 6;

title: string

title: repeated string industries = 7;

title: strmprivacy.api.entities.v1.Label

description: Generic (key/value) labels for this Data Contract.

title: string title = 1;

description: The human readable title of this Data Contract. Used in the Portal. Defaults to the Data Contract name if left unspecified. This field can be modified.

title: Unknown field

title: string field_name = 1;

description: Full reference to a (nested) field. For non-top-level fields (i.e. nested fields), each level should be separated by a forward slash. E.g. customer/id.

title: strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig null_handling_config = 5;

description: How null values should generally be dealt with for a field.

title: string

title: repeated string ordinal_values = 4;

description: If a field is of ordinal values, defines the possible values and their order.

title: strmprivacy.api.entities.v1.FieldMetadata.PersonalDataConfig personal_data_config = 2;

description: Metadata on the type of personal data this field may contain.

title: strmprivacy.api.entities.v1.StatisticalDataType statistical_data_type = 3;

description: The statistical data type of the field, e.g. nominal, ordinal, numerical.

title: Unknown field

title: string default_value = 2;

description: If the type is DEFAULT_VALUE, the desired default value must be specified.

title: strmprivacy.api.entities.v1.FieldMetadata.NullHandlingConfig.NullHandlingType type = 1;

title: Unknown field

title: string avro_name = 7;

description: avro compatible name set by creator OR derived from name

title: string doc = 6;

description:
constraints:
size < 5000

title: string name = 2;

description: constraints: same as SimpleSchemaDefinition

title: strmprivacy.api.entities.v1.SimpleSchemaNode

title: repeated strmprivacy.api.entities.v1.SimpleSchemaNode nodes = 5;

title: bool repeated = 3;

title: bool required = 4;

title: strmprivacy.api.entities.v1.SimpleSchemaNodeType type = 1;

title: Unknown field

title: string definition = 4;

description: constraints: is no longer required provided simple_schema is not empty.

title: string fingerprint = 5;

title: string id = 8;

description: The UUID of this schema

title: bool is_public = 3;

description: (-- 'is' is intentional here (see https://google.aip.dev/140#booleans) --)

title: strmprivacy.api.entities.v1.SchemaMetadata metadata = 6;

title: strmprivacy.api.entities.v1.SchemaRef ref = 1;

title: strmprivacy.api.entities.v1.Schema.SimpleSchemaDefinition simple_schema = 7;

title: strmprivacy.api.entities.v1.Schema.State state = 2;

title: Unknown field

title: string handle = 1;

description: constraints: generic name constraint

title: string name = 2;

description: constraints: generic name constraint

title: strmprivacy.api.entities.v1.SchemaType schema_type = 4;

title: string version = 3;

description: constraints: `\d+\.\d+\.\d+

title: Unknown field

title: string handle = 1;

description: constraint: handle should already exist

title: string name = 2;

description: constraints: generic name constraint, unique within handle

title: string version = 3;

description: constraints: semantic version, e.g. 1.12.3

title: Unknown field

title: string gdpr_special_personal_data_type = 4;

description: The special sensitive data type as defined by the GDPR https://eur-lex.europa.eu/legal-content/EN/TXT/HTML/?uri=CELEX:32016R0679#d1e2051-1-1

title: bool is_pii = 1;

description: Currently, only string fields or repeated string fields can be marked as PII, since other data types cannot store an encrypted string.

title: bool is_quasi_id = 2;

description: A quasi identifier doesn't identify an individual directly, but combined with other QIs can result in a unique (direct) identifier.

title: int32 purpose_level = 3;

description: The purpose level as defined in the purpose level mapping of an organization.

enum: STATISTICAL_DATA_TYPE_UNSPECIFIED 0 NOMINAL 1 ORDINAL 2 NUMERICAL 3

title: Unknown field

title: bool is_public = 4;

title: string project_id = 11;

title: strmprivacy.api.entities.v1.DataContract.State state = 3;

title: strmprivacy.api.entities.v1.DataContractRef ref = 2;

title: strmprivacy.api.entities.v1.Schema schema = 9;

title: strmprivacy.api.entities.v1.FieldMetadata

title: repeated strmprivacy.api.entities.v1.FieldMetadata field_metadata = 12;

title: string creator_external_user_id = 13;

title: string id = 1;

title: strmprivacy.api.entities.v1.DataContractMetadata metadata = 8;

title: string data_subject_field = 10;

title: int32

title: map<string, int32> pii_fields = 6;

description:
PII Fields as a map, where the key is the field path (i.e. producerSessionId or customer/id) and the
 value is the purpose level, provided as an integer

deprecationMessage: Field "pii_fields" is marked as deprecated

title: strmprivacy.api.entities.v1.Validation

title: repeated strmprivacy.api.entities.v1.Validation validations = 7;

title: string key_field = 5;

title: Unknown field

title: string avro_name = 5;

description: avro compatible name set by creator OR derived from name (thus ignore_empty = true)

title: string doc = 3;

title: string name = 1;

description: constraints: printable characters

title: string namespace = 2;

description:
constraints:
dot separated sequence of name constraints
must be Avro compatible. When absent becomes <handle>.<name>.v<version>

title: repeated strmprivacy.api.entities.v1.SimpleSchemaNode nodes = 4;

description: constraints: overall size < 100000 TBD

enum: SIMPLE_SCHEMA_NODE_TYPE_UNSPECIFIED 0 STRING 1 BOOLEAN 2 FLOAT 3 INTEGER 4 LONG 5 NODE 10

title: Unknown field

title: string key = 1;

description: The key of the label.

title: string value = 2;

description: The value of the label. An empty string means there is no value.

title: strmprivacy.api.entities.v1.DataContract


type: object

type: string

type: array

type: boolean

type: integer

description: Sets a list of key:value tags on all spans.


vega-lite.json

$ref: #/definitions/TopLevelExtendedSpec

$ref: #/definitions/AggregateOp

enum: argmax argmin average count distinct max mean median min missing q1 q3 ci0 ci1 stdev stdevp sum valid values variance variancep

description: Array of objects that define fields to aggregate.

$ref: #/definitions/AggregatedFieldDef

description: The data fields to group by. If not specified, a single group containing all data objects will be used.

description: The output field names to use for each aggregated field.

description: The data field for which to compute aggregate function.

description:
The aggregation operations to apply to the fields, such as sum, average or count.
See the [full list of supported aggregation operations](https://vega.github.io/vega-lite/docs/aggregate.html#supported-aggregation-operations)
for more information.

required: op field as

enum: start middle end

$ref: #/definitions/Mark

$ref: #/definitions/MarkDef

description:
Determines how size calculation should be performed, one of `"content"` or `"padding"`. The default setting (`"content"`) interprets the width and height settings as the data rectangle (plotting) dimensions, to which padding is then added. In contrast, the `"padding"` setting includes the padding within the view size calculations, such that the width and height settings indicate the **total** intended size of the view.

__Default value__: `"content"`

enum: content padding

description:
A boolean flag indicating if autosize layout should be re-calculated on every view update.

__Default value__: `false`

$ref: #/definitions/AutosizeType

description:
The sizing format type. One of `"pad"`, `"fit"` or `"none"`. See the [autosize type](https://vega.github.io/vega-lite/docs/size.html#autosize) documentation for descriptions of each.

__Default value__: `"pad"`

enum: pad fit none

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

__Default value:__ `true`

description:
The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.

See the [format documentation](format.html) for more information.

__Default value:__  derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.

description:
A boolean flag indicating if grid lines should be included as part of the axis

__Default value:__ `true` for [continuous scales](scale.html#continuous) that are not binned; otherwise, `false`.

description:
The rotation angle of the axis labels.

__Default value:__ `-90` for nominal and ordinal fields; `0` otherwise.

type: number

description:
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.

__Default value:__ `false`.

type: boolean number

description:
Indicates if the first and last axis labels should be aligned flush with the scale range. Flush alignment for a horizontal axis will left-align the first label and right-align the last label. For vertical axes, bottom and top text baselines are applied instead. If this property is a number, it also indicates the number of pixels by which to offset the first and last labels; for example, a value of 2 will flush-align the first and last labels and also push them 2 pixels outward from the center of the axis. The additional adjustment can sometimes help the labels better visually group with corresponding axis ticks.

__Default value:__ `true` for axis of a continuous x-scale. Otherwise, `false`.

description:
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 labels that overlaps with the last visible label (this often works better for log-scaled axes).

__Default value:__ `true` for non-nominal fields with non-log scales; `"greedy"` for log scales; otherwise `false`.

description: The padding, in pixels, between axis and text labels.

description:
A boolean flag indicating if labels should be included as part of the axis.

__Default value:__  `true`.

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

__Default value:__ `undefined`.

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

__Default value:__ `30` for y-axis; `undefined` for x-axis.

description:
The offset, in pixels, by which to displace the axis from the edge of the enclosing group or data rectangle.

__Default value:__ derived from the [axis config](config.html#facet-scale-config)'s `offset` (`0` by default)

$ref: #/definitions/AxisOrient

description:
The orientation of the axis. One of `"top"`, `"bottom"`, `"left"` or `"right"`. The orientation can be used to further specialize the axis type (e.g., a y axis oriented for the right edge of the chart).

__Default value:__ `"bottom"` for x-axes and `"left"` for y-axes.

description:
The anchor position of the axis in pixels. For x-axis with top or bottom orientation, this sets the axis group x coordinate. For y-axis with left or right orientation, this sets the axis group y coordinate.

__Default value__: `0`

description: 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.

description: The size in pixels of axis ticks.

description: Boolean value that determines whether the axis should include ticks.

description:
A title for the field. If `null`, the title will be removed.

__Default value:__  derived from the field's name and transformation function (`aggregate`, `bin` and `timeUnit`).  If the field has an aggregate function, the function is displayed as a part of the title (e.g., `"Sum of Profit"`). If the field is binned or has a time unit applied, the applied function will be denoted in parentheses (e.g., `"Profit (binned)"`, `"Transaction Date (year-month)"`).  Otherwise, the title is simply the field name.

__Note__: You can customize the default field title format by providing the [`fieldTitle` property in the [config](config.html) or [`fieldTitle` function via the `compile` function's options](compile.html#field-title).

description: Max length for axis title if the title is automatically generated from the field's description.

description: The padding, in pixels, between title and axis.

$ref: #/definitions/DateTime

description: Explicitly set the visible axis tick values.

description:
A non-positive integer indicating z-index of the axis.
If zindex is 0, axes should be drawn behind all chart elements.
To put them in front, use `"zindex = 1"`.

__Default value:__ `1` (in front of the marks) for actual axis and `0` (behind the marks) for grids.

description: 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.

description:
Color of axis domain line.

__Default value:__  (none, using Vega default).

description:
Stroke width of axis domain line

__Default value:__  (none, using Vega default).

description: Color of gridlines.

description: The offset (in pixels) into which to begin drawing with the grid dash array.

description:
The stroke opacity of grid (value between [0,1])

__Default value:__ (`1` by default)

description: The grid width, in pixels.

description: The color of the tick label, can be in hex color code or regular color name.

description: The font of the tick label.

description: The font size of the label, in pixels.

description: Maximum allowed pixel width of axis tick labels.

description:
Whether month names and weekday names should be abbreviated.

__Default value:__  `false`

description: The color of the axis's tick.

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

description: The size in pixels of axis ticks.

description: The width, in pixels, of ticks.

description: Horizontal text alignment of axis titles.

description: Angle in degrees of axis titles.

description: Vertical text baseline for axis titles.

description: Color of the title, can be in hex color code or regular color name.

description: Font of the title. (e.g., `"Helvetica Neue"`).

description: Font size of the title.

description: Font weight of the title. (e.g., `"bold"`).

type: string number

description: Maximum allowed pixel width of axis titles.

description: X-coordinate of the axis title relative to the axis group.

description: Y-coordinate of the axis title relative to the axis group.

$ref: #/definitions/AxisConfig

description: Axis configuration, which determines default properties for all `x` and `y` [axes](axis.html). For a full list of axis configuration options, please see the [corresponding section of the axis documentation](axis.html#config).

$ref: #/definitions/VgAxisConfig

description: Specific axis config for axes with "band" scales.

description: Specific axis config for x-axis along the bottom edge of the chart.

description: Specific axis config for y-axis along the left edge of the chart.

description: Specific axis config for y-axis along the right edge of the chart.

description: Specific axis config for x-axis along the top edge of the chart.

description: X-axis specific config.

description: Y-axis specific config.

description: The horizontal alignment of the text. One of `"left"`, `"right"`, `"center"`.

description: The rotation angle of the text, in degrees.

description:
The vertical alignment of the text. One of `"top"`, `"middle"`, `"bottom"`.

__Default value:__ `"middle"`

description:
Offset between bar for binned field.  Ideal value for this is either 0 (Preferred by statisticians) or 1 (Vega-Lite Default, D3 example style).

__Default value:__ `1`

description:
Default color.  Note that `fill` and `stroke` have higher precedence than `color` and will override `color`.

__Default value:__ ■ `"#4682b4"`

__Note:__ This property cannot be used in a [style config](mark.html#style-config).

description:
The default size of the bars on continuous scales.

__Default value:__ `5`

description:
The size of the bars.  If unspecified, the default size is  `bandSize-1`,
which provides 1 pixel offset between bars.

description: The horizontal offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.

description: The vertical offset, in pixels, between the text label and its anchor point. The offset is applied after rotation by the _angle_ property.

description:
Default Fill Color.  This has higher precedence than config.color

__Default value:__ (None)

description:
The fill opacity (value between [0,1]).

__Default value:__ `1`

description:
Whether the mark's color should be used as fill color instead of stroke color.

__Default value:__ `true` for all marks except `point` and `false` for `point`.

__Applicable for:__ `bar`, `point`, `circle`, `square`, and `area` marks.

__Note:__ This property cannot be used in a [style config](mark.html#style-config).

description: The typeface to set the text in (e.g., `"Helvetica Neue"`).

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description:
The line interpolation method to use for line and area marks. One of the following:
- `"linear"`: piecewise linear segments, as in a polyline.
- `"linear-closed"`: close the linear segments to form a polygon.
- `"step"`: alternate between horizontal and vertical segments, as in a step function.
- `"step-before"`: alternate between vertical and horizontal segments, as in a step function.
- `"step-after"`: alternate between horizontal and vertical segments, as in a step function.
- `"basis"`: a B-spline, with control point duplication on the ends.
- `"basis-open"`: an open B-spline; may not intersect the start or end.
- `"basis-closed"`: a closed B-spline, as in a loop.
- `"cardinal"`: a Cardinal spline, with control point duplication on the ends.
- `"cardinal-open"`: an open Cardinal spline; may not intersect the start or end, but will intersect other control points.
- `"cardinal-closed"`: a closed Cardinal spline, as in a loop.
- `"bundle"`: equivalent to basis, except the tension parameter is used to straighten the spline.
- `"monotone"`: cubic interpolation that preserves monotonicity in y.

description: The maximum length of the text mark in pixels (default 0, indicating no limit). The text value will be automatically truncated if the rendered size exceeds the limit.

description:
The overall opacity (value between [0,1]).

__Default value:__ `0.7` for non-aggregate plots with `point`, `tick`, `circle`, or `square` marks or layered `bar` charts and `1` otherwise.

description:
The orientation of a non-stacked bar, tick, area, and line charts.
The value is either horizontal (default) or vertical.
- For bar, rule and tick, this determines whether the size of the bar and tick
should be applied to x or y dimension.
- For area, this property determines the orient property of the Vega output.
- For line, this property determines the sort order of the points in the line
if `config.sortLineBy` is not specified.
For stacked charts, this is always determined by the orientation of the stack;
therefore explicitly specified value will be ignored.

description: Polar coordinate radial offset, in pixels, of the text label from the origin determined by the `x` and `y` properties.

description:
The default symbol shape to use. One of: `"circle"` (default), `"square"`, `"cross"`, `"diamond"`, `"triangle-up"`, or `"triangle-down"`, or a custom SVG path.

__Default value:__ `"circle"`

description:
The pixel area each the point/circle/square.
For example: in the case of circles, the radius is determined in part by the square root of the size value.

__Default value:__ `30`

description:
Default Stroke Color.  This has higher precedence than config.color

__Default value:__ (None)

description: An array of alternating stroke, space lengths for creating dashed or dotted lines.

description: The offset (in pixels) into which to begin drawing with the stroke dash array.

description:
The stroke opacity (value between [0,1]).

__Default value:__ `1`

description: The stroke width, in pixels.

description: Depending on the interpolation type, sets the tension parameter (for line and area marks).

description: Placeholder text if the `text` channel is not specified

description: Polar coordinate angle, in radians, of the text label from the origin determined by the `x` and `y` properties. Values for `theta` follow the same convention of `arc` mark `startAngle` and `endAngle` properties: angles are measured in radians, with `0` indicating "north".

description:
The number base to use for automatic bin determination (default is base 10).

__Default value:__ `10`

description:
Scale factors indicating allowable subdivisions. The default value is [5, 2], which indicates that for base 10 numbers (the default base), the method may consider dividing bin sizes by 5 and/or 2. For example, for an initial step size of 10, the method can check if bin sizes of 2 (= 10/5), 5 (= 10/2), or 1 (= 10/(5*2)) might also satisfy the given constraints.

__Default value:__ `[5, 2]`

description:
Maximum number of bins.

__Default value:__ `6` for `row`, `column` and `shape` channels; `10` for other channels

description: A minimum allowable step size (particularly useful for integer values).

description: If true (the default), attempts to make the bin boundaries use human-friendly boundaries, such as multiples of ten.

description:
An exact step size to use between bins.

__Note:__ If provided, options such as maxbins will be ignored.

description: An array of allowable step sizes to choose from.

description:
By default, all data values are considered to lie within an empty selection.
When set to `none`, empty selections contain no data values.

description:
An array of encoding channels. The corresponding data field values
must match for a data tuple to fall within the selection.

description:
An array of field names whose values must match for a data tuple to
fall within the selection.

description:
A [Vega event stream](https://vega.github.io/vega/docs/event-streams/) (object or selector) that triggers the selection.
For interval selections, the event stream must specify a [start and end](https://vega.github.io/vega/docs/event-streams/#between-filters).

description:
With layered and multi-view displays, a strategy that determines how
selections' data queries are resolved when applied in a filter transform,
conditional encoding rule, or scale domain.

description: An object describing the data source

description: Description of this mark for commenting purpose.

description: Name of the visualization for later reference.

description: Title for the plot.

description: An array of data transformations such as filter and new field calculation.

description: Binning properties or boolean flag for determining whether to bin data or not.

description: A two-element (`[min, max]`) array indicating the range of desired bin values.

description: The output fields at which to write the start and end bin values.

description: An object indicating bin properties, or simply `true` for using default bin parameters.

description: The data field to bin.

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description: Size of the box and mid tick of a box plot

description: The stroke width, in pixels.

description: Box Config

description:
The fill color of the interval mark.

__Default value:__ `#333333`

description:
The fill opacity of the interval mark (a value between 0 and 1).

__Default value:__ `0.125`

description:
The stroke color of the interval mark.

__Default value:__ `#ffffff`

description:
An array of alternating stroke and space lengths,
for creating dashed or dotted lines.

description: The offset (in pixels) with which to begin drawing the stroke dash array.

description: The stroke opacity of the interval mark (a value between 0 and 1).

description: The stroke width of the interval mark.

description: The field for storing the computed formula value.

description: A string containing a Vega Expression. Use the variable `datum` to refer to the current data object.

description: Unit spec that can have a composite mark.

description:
Aggregation function for the field
(e.g., `mean`, `sum`, `median`, `min`, `max`, `count`).

__Default value:__ `undefined` (None)

description:
A flag for binning a `quantitative` field, or [an object defining binning parameters](bin.html#params).
If `true`, default [binning parameters](bin.html) will be applied.

__Default value:__ `false`

description:
__Required.__ A string defining the name of the field from which to pull a data value
or an object defining iterated values from the [`repeat`](repeat.html) operator.

__Note:__ `field` is not required if `aggregate` is `count`.

description:
An object defining properties of the legend.
If `null`, the legend for the encoding channel will be removed.

__Default value:__ If undefined, default [legend properties](legend.html) are applied.

description:
An object defining properties of the channel's scale, which is the function that transforms values in the data domain (numbers, dates, strings, etc) to visual values (pixels, colors, sizes) of the encoding channels.

__Default value:__ If undefined, default [scale properties](scale.html) are applied.

description: A [selection name](selection.html), or a series of [composed selections](selection.html#compose).

description:
Sort order for the encoded field.
Supported `sort` values include `"ascending"`, `"descending"` and `null` (no sorting).
For fields with discrete domains, `sort` can also be a [sort field definition object](sort.html#sort-field).

__Default value:__ `"ascending"`

description:
Time unit (e.g., `year`, `yearmonth`, `month`, `hours`) for a temporal field.
or [a temporal field that gets casted as ordinal](type.html#cast).

__Default value:__ `undefined` (None)

description: The encoded field's type of measurement (`"quantitative"`, `"temporal"`, `"ordinal"`, or `"nominal"`).

description: The [formatting pattern](format.html) for a text field. If not defined, this will be determined automatically.

description: A constant value in visual domain (e.g., `"red"` / "#0099ff" for color, values between `0` to `1` for opacity).

description: Area-Specific Config

description:
Sets how the visualization size should be determined. If a string, should be one of `"pad"`, `"fit"` or `"none"`.
Object values can additionally specify parameters for content sizing and automatic resizing.
`"fit"` is only supported for single and layered views that don't use `rangeStep`.

__Default value__: `pad`

description: X-axis specific config.

description: Y-axis specific config.

description:
CSS color property to use as the background of visualization.

__Default value:__ none (transparent)

description: Bar-Specific Config

description: Circle-Specific Config

description:
Default axis and legend title for count fields.

__Default value:__ `'Number of Records'`.

description:
Defines how Vega-Lite generates title for fields.  There are three possible styles:
- `"verbal"` (Default) - displays function in a verbal style (e.g., "Sum of field", "Year-month of date", "field (binned)").
- `"function"` - displays function using parentheses and capitalized texts (e.g., "SUM(field)", "YEARMONTH(date)", "BIN(field)").
- `"plain"` - displays only the field name without functions (e.g., "field", "date", "field").

description:
Defines how Vega-Lite should handle invalid values (`null` and `NaN`).
- If set to `"filter"` (default), all data items with null values are filtered.
- If `null`, all data items are included. In this case, invalid values will be interpreted as zeroes.

description: Legend configuration, which determines default properties for all [legends](legend.html). For a full list of legend configuration options, please see the [corresponding section of in the legend documentation](legend.html#config).

description: Line-Specific Config

description: Mark Config

description: D3 Number format for axis labels and text tables. For example "s" for SI units. Use [D3's number format pattern](https://github.com/d3/d3-format#locale_format).

description:
The default visualization padding, in pixels, from the edge of the visualization canvas to the data rectangle.  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}` to specify padding for each side of the visualization.

__Default value__: `5`

description: Point-Specific Config

description:
An object hash that defines default range arrays or schemes for using with scales.
For a full list of scale range configuration options, please see the [corresponding section of the scale documentation](scale.html#config).

description: Rect-Specific Config

description: Rule-Specific Config

description: Scale configuration determines default properties for all [scales](scale.html). For a full list of scale configuration options, please see the [corresponding section of the scale documentation](scale.html#config).

description: An object hash for defining default properties for each type of selections.

description: Square-Specific Config

description: Default stack offset for stackable mark.

description: An object hash that defines key-value mappings to determine default properties for marks with a given [style](mark.html#mark-def).  The keys represent styles names; the value are valid [mark configuration objects](mark.html#config).

description: Text-Specific Config

description: Tick-Specific Config

description:
Default datetime format for axis and legend labels. The format can be set directly on each axis and legend. Use [D3's time format pattern](https://github.com/d3/d3-time-format#locale_format).

__Default value:__ `'%b %d, %Y'`.

description: Title configuration, which determines default properties for all [titles](title.html). For a full list of title configuration options, please see the [corresponding section of the title documentation](title.html#config).

description: Default properties for [single view plots](spec.html#single).

description:
If set to auto (the default), perform automatic type inference to determine the desired data types.
Alternatively, a parsing directive object can be provided for explicit data types. Each property of the object corresponds to a field name, and the value to the desired data type (one of `"number"`, `"boolean"` or `"date"`).
For example, `"parse": {"modified_on": "date"}` parses the `modified_on` field in each input record a Date value.

For `"date"`, we parse data based using Javascript's [`Date.parse()`](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/parse).
For Specific date formats can be provided (e.g., `{foo: 'date:"%m%d%Y"'}`), using the [d3-time-format syntax](https://github.com/d3/d3-time-format#locale_format). UTC date format parsing is supported similarly (e.g., `{foo: 'utc:"%m%d%Y"'}`). See more about [UTC time](timeunit.html#utc)

description:
Type of input data: `"json"`, `"csv"`, `"tsv"`.
The default format type is determined by the extension of the file URL.
If no extension is detected, `"json"` will be used by default.

description:
Object for defining datetime in Vega-Lite Filter.
If both month and quarter are provided, month has higher precedence.
`day` cannot be combined with other date.
We accept string for month and day names.

description: Integer value representing the date from 1-31.

description: Value representing the day of a week.  This can be one of: (1) integer value -- `1` represents Monday; (2) case-insensitive day name (e.g., `"Monday"`);  (3) case-insensitive, 3-character short day name (e.g., `"Mon"`).   <br/> **Warning:** A DateTime definition object with `day`** should not be combined with `year`, `quarter`, `month`, or `date`.

description: Integer value representing the hour of a day from 0-23.

description: Integer value representing the millisecond segment of time.

description: Integer value representing the minute segment of time from 0-59.

description: One of: (1) integer value representing the month from `1`-`12`. `1` represents January;  (2) case-insensitive month name (e.g., `"January"`);  (3) case-insensitive, 3-character short month name (e.g., `"Jan"`).

description: Integer value representing the quarter of the year (from 1-4).

description: Integer value representing the second segment (0-59) of a time value

description: A boolean flag indicating if date time is in utc time. If false, the date time is in local time

description: Integer value representing the year.

description:
Color of the marks – either fill or stroke color based on mark type.
By default, `color` represents fill color for `"area"`, `"bar"`, `"tick"`,
`"text"`, `"circle"`, and `"square"` / stroke color for `"line"` and `"point"`.

__Default value:__ If undefined, the default color depends on [mark config](config.html#mark)'s `color` property.

_Note:_ See the scale documentation for more information about customizing [color scheme](scale.html#scheme).

description:
Additional levels of detail for grouping data in aggregate views and
in line and area marks without mapping data to a specific visual channel.

description:
Opacity of the marks – either can be a value or a range.

__Default value:__ If undefined, the default opacity depends on [mark config](config.html#mark)'s `opacity` property.

description:
Stack order for stacked marks or order of data points in line marks for connected scatter plots.

__Note__: In aggregate plots, `order` field should be `aggregate`d to avoid creating additional aggregation grouping.

description:
The symbol's shape (only for `point` marks). The supported values are
`"circle"` (default), `"square"`, `"cross"`, `"diamond"`, `"triangle-up"`,
or `"triangle-down"`, or else a custom SVG path string.
__Default value:__ If undefined, the default shape depends on [mark config](config.html#point-config)'s `shape` property.

description:
Size of the mark.
- For `"point"`, `"square"` and `"circle"`, – the symbol size, or pixel area of the mark.
- For `"bar"` and `"tick"` – the bar and tick's size.
- For `"text"` – the text's font size.
- Size is currently unsupported for `"line"`, `"area"`, and `"rect"`.

description: Text of the `text` mark.

description: The tooltip text to show upon mouse hover.

description: X coordinates of the marks, or width of horizontal `"bar"` and `"area"`.

description: X2 coordinates for ranged  `"area"`, `"bar"`, `"rect"`, and  `"rule"`.

description: Y coordinates of the marks, or height of vertical `"bar"` and `"area"`.

description: Y2 coordinates for ranged  `"area"`, `"bar"`, `"rect"`, and  `"rule"`.

description: Horizontal facets for trellis plots.

description: Vertical facets for trellis plots.

description: Text of the `text` mark.

description: The value that the field should be equal to.

description: Field to be filtered.

description: Time unit for the field to be filtered.

description: An object defining properties of a facet's header.

description:
Sort order for a facet field.
This can be `"ascending"`, `"descending"`.

description: Horizontal facets for trellis plots.

description: Vertical facets for trellis plots.

description: Unit spec that can have a composite mark and row or column channels.

description: Definition object for a data field, its type and transformation of an encoding channel.

description:
A FieldDef with Condition<ValueDef>
{
   condition: {value: ...},
   field: ...,
   ...
}

description:
One or more value definition(s) with a selection predicate.

__Note:__ A field definition's `condition` property can only contain [value definitions](encoding.html#value)
since Vega-Lite only allows at mosty  one encoded field per encoding channel.

description:
The `filter` property must be either (1) a filter object for [equal-filters](filter.html#equalfilter),
[range-filters](filter.html#rangefilter), [one-of filters](filter.html#oneoffilter), or [selection filters](filter.html#selectionfilter);
(2) a [Vega Expression](filter.html#expression) string,
where `datum` can be used to refer to the current data object; or (3) an array of filters (either objects or expression strings) that must all be true for a datum to pass the filter and be included.

description: An object describing the data source

description: An object that describes mappings between `row` and `column` channels and their field definitions.

description: Scale, axis, and legend resolutions for facets.

description: A specification of the view that gets faceted.

description: Title for the plot.

description: An object describing the data source

description: A list of views that should be concatenated and put into a row.

description: Scale, axis, and legend resolutions for horizontally concatenated charts.

description: Title for the plot.

description: An object describing the data source

description:
The height of a visualization.

__Default value:__
- If a view's [`autosize`](size.html#autosize) type is `"fit"` or its y-channel has a [continuous scale](scale.html#continuous), the height will be the value of [`config.view.height`](spec.html#config).
- For y-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the height is [determined by the range step, paddings, and the cardinality of the field mapped to y-channel](scale.html#band). Otherwise, if the `rangeStep` is `null`, the height will be the value of [`config.view.height`](spec.html#config).
- If no field is mapped to `y` channel, the `height` will be the value of `rangeStep`.

__Note__: For plots with [`row` and `column` channels](encoding.html#facet), this represents the height of a single view.

__See also:__ The documentation for [width and height](size.html) contains more examples.

description:
Layer or single view specifications to be layered.

__Note__: Specifications inside `layer` cannot use `row` and `column` channels as layering facet specifications is not allowed.

description: Scale, axis, and legend resolutions for layers.

description: Title for the plot.

description:
The width of a visualization.

__Default value:__ This will be determined by the following rules:

- If a view's [`autosize`](size.html#autosize) type is `"fit"` or its x-channel has a [continuous scale](scale.html#continuous), the width will be the value of [`config.view.width`](spec.html#config).
- For x-axis with a band or point scale: if [`rangeStep`](scale.html#band) is a numeric value or unspecified, the width is [determined by the range step, paddings, and the cardinality of the field mapped to x-channel](scale.html#band).   Otherwise, if the `rangeStep` is `null`, the width will be the value of [`config.view.width`](spec.html#config).
- If no field is mapped to `x` channel, the `width` will be the value of [`config.scale.textXRangeStep`](size.html#default-width-and-height) for `text` mark and the value of `rangeStep` for other marks.

__Note:__ For plots with [`row` and `column` channels](encoding.html#facet), this represents the width of a single view.

__See also:__ The documentation for [width and height](size.html) contains more examples.

description: An object describing the data source

description: An object that describes what fields should be repeated into views that are laid out as a `row` or `column`.

description: Scale and legend resolutions for repeated charts.

description: Title for the plot.

description: An object describing the data source

description: A key-value mapping between encoding channels and definition of fields.

description:
A string describing the mark type (one of `"bar"`, `"circle"`, `"square"`, `"tick"`, `"line"`,
`"area"`, `"point"`, `"rule"`, and `"text"`) or a [mark definition object](mark.html#mark-def).

description: A key-value mapping between selection names and definitions.

description: Title for the plot.

description: An object describing the data source

description: Title for the plot.

description: An object describing the data source

description: Scale, axis, and legend resolutions for vertically concatenated charts.

description: Title for the plot.

description: A list of views that should be concatenated and put into a column.

description: Headers of row / column channels for faceted plots.

description:
The formatting pattern for labels. This is D3's [number format pattern](https://github.com/d3/d3-format#locale_format) for quantitative fields and D3's [time format pattern](https://github.com/d3/d3-time-format#locale_format) for time field.

__Default value:__  derived from [numberFormat](config.html#format) config for quantitative fields and from [timeFormat](config.html#format) config for temporal fields.

description:
A title for the axis. Shows field name and its function by default.

__Default value:__  derived from the field's name and transformation function applied e.g, "field_name", "SUM(field_name)", "BIN(field_name)", "YEAR(field_name)".

description: An object that specifies the format for parsing the data values.

description:
The full data set, included inline. This can be an array of objects or primitive values or a string.
Arrays of primitive values are ingested as objects with a `data` property. Strings are parsed according to the specified format type.

enum: linear linear-closed step step-before step-after basis basis-open basis-closed cardinal cardinal-open cardinal-closed bundle monotone

description:
Establishes a two-way binding between the interval selection and the scales
used within the same view. This allows a user to interactively pan and
zoom the view.

description:
An interval selection also adds a rectangle mark to depict the
extents of the interval. The `mark` property can be used to customize the
appearance of the mark.

description:
When truthy, allows a user to interactively move an interval selection
back-and-forth. Can be `true`, `false` (to disable panning), or a
[Vega event stream definition](https://vega.github.io/vega/docs/event-streams/)
which must include a start and end event to trigger continuous panning.

__Default value:__ `true`, which corresponds to
`[mousedown, window:mouseup] > window:mousemove!` which corresponds to
clicks and dragging within an interval selection to reposition it.

description:
When truthy, allows a user to interactively resize an interval selection.
Can be `true`, `false` (to disable zooming), or a [Vega event stream
definition](https://vega.github.io/vega/docs/event-streams/). Currently,
only `wheel` events are supported.

__Default value:__ `true`, which corresponds to `wheel!`.

description:
The JSON property containing the desired data.
This parameter can be used when the loaded JSON file may have surrounding structure or meta-data.
For example `"property": "values.features"` is equivalent to retrieving `json.values.features`
from the loaded JSON object.

description: Properties of a legend or boolean flag for determining whether to show it.

description: Padding (in pixels) between legend entries in a symbol legend.

description:
The offset, in pixels, by which to displace the legend from the edge of the enclosing group or data rectangle.

__Default value:__  `0`

description:
The orientation of the legend, which determines how the legend is positioned within the scene. One of "left", "right", "top-left", "top-right", "bottom-left", "bottom-right", "none".

__Default value:__ `"right"`

description: The padding, in pixels, between the legend and axis.

description: The desired number of tick values for quantitative legends.

description:
The type of the legend. Use `"symbol"` to create a discrete legend and `"gradient"` for a continuous color gradient.

__Default value:__ `"gradient"` for non-binned quantitative fields and temporal fields; `"symbol"` otherwise.

description: Explicitly set the visible legend values.

description:
A non-positive integer indicating z-index of the legend.
If zindex is 0, legend should be drawn behind all chart elements.
To put them in front, use zindex = 1.

description: Corner radius for the full legend.

description: Background fill color for the full legend.

description: The height of the gradient, in pixels.

description: Text baseline for color ramp gradient labels.

description: The maximum allowed length in pixels of color ramp gradient labels.

description: Vertical offset in pixels for color ramp gradient labels.

description: The color of the gradient stroke, can be in hex color code or regular color name.

description: The width of the gradient stroke, in pixels.

description: The width of the gradient, in pixels.

description: The alignment of the legend label, can be left, middle or right.

description: The position of the baseline of legend label, can be top, middle or bottom.

description: The color of the legend label, can be in hex color code or regular color name.

description: The font of the legend label.

description:
The font size of legend label.

__Default value:__ `10`.

description: The offset of the legend label.

description: Border stroke color for the full legend.

description: Border stroke dash pattern for the full legend.

description: Border stroke width for the full legend.

description: The color of the legend symbol,

description: The size of the legend symbol, in pixels.

description: The width of the symbol's stroke.

description: Default shape type (such as "circle") for legend symbols.

description: Horizontal text alignment for legend titles.

description: Vertical text baseline for legend titles.

description: The color of the legend title, can be in hex color code or regular color name.

description: The font of the legend title.

description: The font size of the legend title.

description: The font weight of the legend title.

description: The padding, in pixels, between title and legend.

enum: left right top-left top-right bottom-left bottom-right none

enum: yearquarter yearquartermonth yearmonth yearmonthdate yearmonthdatehours yearmonthdatehoursminutes yearmonthdatehoursminutesseconds quartermonth monthdate hoursminutes hoursminutesseconds minutesseconds secondsmilliseconds

enum: year quarter month day date hours minutes seconds milliseconds

description: Secondary data source to lookup in.

description:
Fields in foreign data to lookup.
If not specified, the entire object is queried.

description: Key in data to lookup.

description:
The field or fields for storing the computed formula value.
If `from.fields` is specified, the transform will use the same names for `as`.
If `from.fields` is not specified, `as` has to be a string and we put the whole object into the data under the specified name.

description:
The default value to use if lookup fails.

__Default value:__ `null`

description: Secondary data reference.

description: Key in primary data source.

description: All types of primitive marks.

enum: area bar line point text tick rect rule circle square

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description: The stroke width, in pixels.

description: Area-Specific Config

description: Bar-Specific Config

description: Circle-Specific Config

description: Line-Specific Config

description: Mark Config

description: Point-Specific Config

description: Rect-Specific Config

description: Rule-Specific Config

description: Square-Specific Config

description: Text-Specific Config

description: Tick-Specific Config

description: Whether a mark be clipped to the enclosing group's width and height.

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description: The stroke width, in pixels.

description:
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 [style configuration](mark.html#style-config). If style is an array, later styles will override earlier styles. Any [mark properties](encoding.html#mark-prop) explicitly defined within the `encoding` will override a style default.

__Default value:__ The mark's name.  For example, a bar mark will have style `"bar"` by default.
__Note:__ Any specified style will augment the default style. For example, a bar mark with `"style": "foo"` will receive from `config.style.bar` and `config.style.foo` (the specified style `"foo"` has higher precedence).

description:
The mark type.
One of `"bar"`, `"circle"`, `"square"`, `"tick"`, `"line"`,
`"area"`, `"point"`, `"rule"`, and `"text"`.

description: Field definition of a mark property, which can contain a legend.

description:
When true, an invisible voronoi diagram is computed to accelerate discrete
selection. The data value _nearest_ the mouse cursor is added to the selection.

See the [nearest transform](nearest.html) documentation for more information.

description:
Controls whether data values should be toggled or only ever inserted into
multi selections. Can be `true`, `false` (for insertion only), or a
[Vega expression](https://vega.github.io/vega/docs/expressions/).

__Default value:__ `true`, which corresponds to `event.shiftKey` (i.e.,
data values are toggled when a user interacts with the shift-key pressed).

See the [toggle transform](toggle.html) documentation for more information.

description: An object that specifies the format for parsing the data.

description: Provide a placeholder name and bind data at runtime.

description: Field to be filtered

description:
A set of values that the `field`'s value should be a member of,
for a data item included in the filtered data.

description: time unit for the field to be filtered.

description: The sort order. One of `"ascending"` (default) or `"descending"`.

description:
An object defining properties of axis's gridlines, ticks and labels.
If `null`, the axis for the encoding channel will be removed.

__Default value:__ If undefined, default [axis properties](axis.html) are applied.

description:
Type of stacking offset if the field should be stacked.
`stack` is only applicable for `x` and `y` channels with continuous domains.
For example, `stack` of `y` can be used to customize stacking for a vertical bar chart.

`stack` can be one of the following values:
- `"zero"`: stacking with baseline offset at zero value of the scale (for creating typical stacked [bar](stack.html#bar) and [area](stack.html#area) chart).
- `"normalize"` - stacking with normalized domain (for creating [normalized stacked bar and area charts](stack.html#normalized). <br/>
-`"center"` - stacking with center baseline (for [streamgraph](stack.html#streamgraph)).
- `null` - No-stacking. This will produce layered [bar](stack.html#layered-bar-chart) and area chart.

__Default value:__ `zero` for plots with all of the following conditions are true:
(1) the mark is `bar` or `area`;
(2) the stacked measure channel (x or y) has a linear scale;
(3) At least one of non-position channels mapped to an unaggregated field that is different from x and y.  Otherwise, `null` by default.

description: Default range for _nominal_ (categorical) fields.

description: Default range for diverging _quantitative_ fields.

description: Default range for _quantitative_ heatmaps.

description: Default range for _ordinal_ fields.

description: Default range for _quantitative_ and _temporal_ fields.

description: Default range palette for the `shape` channel.

description: Field to be filtered

description:
An array of inclusive minimum and maximum values
for a field value of a data item to be included in the filtered data.

description: time unit for the field to be filtered.

description: Horizontal repeated views.

description: Vertical repeated views.

description: Reference to a repeated value.

description: Defines how scales, axes, and legends from different specs should be combined. Resolve is a mapping from `scale`, `axis`, and `legend` to a mapping from channels to resolutions.

description: The logarithm base of the `log` scale (default `10`).

description:
If `true`, values that exceed the data domain are clamped to either the minimum or maximum range value

__Default value:__ derived from the [scale config](config.html#scale-config)'s `clamp` (`true` by default).

description:
Customized domain values.

For _quantitative_ fields, `domain` can take the form of a two-element array with minimum and maximum values.  [Piecewise scales](scale.html#piecewise) can be created by providing a `domain` with more than two entries.
If the input field is aggregated, `domain` can also be a string value `"unaggregated"`, indicating that the domain should include the raw data values prior to the aggregation.

For _temporal_ fields, `domain` can be a two-element array minimum and maximum values, in the form of either timestamps or the [DateTime definition objects](types.html#datetime).

For _ordinal_ and _nominal_ fields, `domain` can be an array that lists valid input values.

The `selection` property can be used to [interactively determine](selection.html#scale-domains) the scale domain.

description: The exponent of the `pow` scale.

description: The interpolation method for range values. By default, 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](https://github.com/d3/d3-interpolate).

description:
Extending the domain so that it starts and ends on nice round values. 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]_.

For quantitative scales such as linear, `nice` can be either a boolean flag or a number. If `nice` is a number, it will represent a desired tick count. This allows greater control over the step size used to extend the bounds, guaranteeing that the returned ticks will exactly cover the domain.

For temporal fields with time and utc scales, the `nice` value can be a string indicating the desired time interval. Legal values are `"millisecond"`, `"second"`, `"minute"`, `"hour"`, `"day"`, `"week"`, `"month"`, and `"year"`. Alternatively, `time` and `utc` scales can accept an object-valued interval specifier of the form `{"interval": "month", "step": 3}`, which includes a desired number of interval steps. Here, the domain would snap to quarter (Jan, Apr, Jul, Oct) boundaries.

__Default value:__ `true` for unbinned _quantitative_ fields; `false` otherwise.

description:
For _[continuous](scale.html#continuous)_ scales, 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.

For _[band](scale.html#band)_ scales, shortcut for setting `paddingInner` and `paddingOuter` to the same value.

For _[point](scale.html#point)_ scales, alias for `paddingOuter`.

__Default value:__ For _continuous_ scales, derived from the [scale config](scale.html#config)'s `continuousPadding`.
For _band and point_ scales, see `paddingInner` and `paddingOuter`.

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

For point scale, this property is invalid as point scales do not have internal band widths (only step sizes between bands).

__Default value:__ derived from the [scale config](scale.html#config)'s `bandPaddingInner`.

description:
The outer padding (spacing) at the ends of the range of band and point scales,
as a fraction of the step size. This value must lie in the range [0,1].

__Default value:__ derived from the [scale config](scale.html#config)'s `bandPaddingOuter` for band scales and `pointPadding` for point scales.

description:
The range of the scale. One of:

- A string indicating a [pre-defined named scale range](scale.html#range-config) (e.g., example, `"symbol"`, or `"diverging"`).

- For [continuous scales](scale.html#continuous), two-element array indicating  minimum and maximum values, or an array with more than two entries for specifying a [piecewise scale](scale.html#piecewise).

- For [discrete](scale.html#discrete) and [discretizing](scale.html#discretizing) scales, an array of desired output values.

__Notes:__

1) For [sequential](scale.html#sequential), [ordinal](scale.html#ordinal), and discretizing color scales, you can also specify a color [`scheme`](scale.html#scheme) instead of `range`.

2) Any directly specified `range` for `x` and `y` channels will be ignored. Range can be customized via the view's corresponding [size](size.html) (`width` and `height`) or via [range steps and paddings properties](#range-step) for [band](#band) and [point](#point) scales.

description:
The distance between the starts of adjacent bands or points in [band](scale.html#band) and [point](scale.html#point) scales.

If `rangeStep` is `null` or if the view contains the scale's corresponding [size](size.html) (`width` for `x` scales and `height` for `y` scales), `rangeStep` will be automatically determined to fit the size of the view.

__Default value:__  derived the [scale config](config.html#scale-config)'s `textXRangeStep` (`90` by default) for x-scales of `text` marks and `rangeStep` (`21` by default) for x-scales of other marks and y-scales.

__Warning__: If `rangeStep` is `null` and the cardinality of the scale's domain is higher than `width` or `height`, the rangeStep might become less than one pixel and the mark might not appear correctly.

description:
If `true`, rounds numeric output values to integers. This can be helpful for snapping to the pixel grid.

__Default value:__ `false`.

description:
A string indicating a color [scheme](scale.html#scheme) name (e.g., `"category10"` or `"viridis"`) or a [scheme parameter object](scale.html#scheme-params).

Discrete color schemes may be used with [discrete](scale.html#discrete) or [discretizing](scale.html#discretizing) scales. Continuous color schemes are intended for use with [sequential](scales.html#sequential) scales.

For the full list of supported scheme, please refer to the [Vega Scheme](https://vega.github.io/vega/docs/schemes/#reference) reference.

description:
The type of scale.  Vega-Lite supports the following categories of scale types:

1) [**Continuous Scales**](scale.html#continuous) -- mapping continuous domains to continuous output ranges ([`"linear"`](scale.html#linear), [`"pow"`](scale.html#pow), [`"sqrt"`](scale.html#sqrt), [`"log"`](scale.html#log), [`"time"`](scale.html#time), [`"utc"`](scale.html#utc), [`"sequential"`](scale.html#sequential)).

2) [**Discrete Scales**](scale.html#discrete) -- mapping discrete domains to discrete ([`"ordinal"`](scale.html#ordinal)) or continuous ([`"band"`](scale.html#band) and [`"point"`](scale.html#point)) output ranges.

3) [**Discretizing Scales**](scale.html#discretizing) -- mapping continuous domains to discrete output ranges ([`"bin-linear"`](scale.html#bin-linear) and [`"bin-ordinal"`](scale.html#bin-ordinal)).

__Default value:__ please see the [scale type table](scale.html#type).

description:
If `true`, ensures that a zero baseline value is included in the scale domain.

__Default value:__ `true` for x and y channels if the quantitative field is not binned and no custom `domain` is provided; `false` otherwise.

__Note:__ Log, time, and utc scales do not support `zero`.

description:
Default inner padding for `x` and `y` band-ordinal scales.

__Default value:__ `0.1`

description:
Default outer padding for `x` and `y` band-ordinal scales.
If not specified, by default, band scale's paddingOuter is paddingInner/2.

description: If true, values that exceed the data domain are clamped to either the minimum or maximum range value

description:
Default padding for continuous scales.

__Default:__ `5` for continuous x-scale of a vertical bar and continuous y-scale of a horizontal bar.; `0` otherwise.

description:
The default max value for mapping quantitative fields to bar's size/bandSize.

If undefined (default), we will use the scale's `rangeStep` - 1.

description:
The default max value for mapping quantitative fields to text's size/fontSize.

__Default value:__ `40`

description:
Default max opacity for mapping a field to opacity.

__Default value:__ `0.8`

description: Default max value for point size scale.

description:
Default max strokeWidth for strokeWidth  (or rule/line's size) scale.

__Default value:__ `4`

description:
The default min value for mapping quantitative fields to bar and tick's size/bandSize scale with zero=false.

__Default value:__ `2`

description:
The default min value for mapping quantitative fields to tick's size/fontSize scale with zero=false

__Default value:__ `8`

description:
Default minimum opacity for mapping a field to opacity.

__Default value:__ `0.3`

description:
Default minimum value for point size scale with zero=false.

__Default value:__ `9`

description:
Default minimum strokeWidth for strokeWidth (or rule/line's size) scale with zero=false.

__Default value:__ `1`

description:
Default outer padding for `x` and `y` point-ordinal scales.

__Default value:__ `0.5`

description:
Default range step for band and point scales of (1) the `y` channel
and (2) the `x` channel when the mark is not `text`.

__Default value:__ `21`

description:
If true, rounds numeric output values to integers.
This can be helpful for snapping to the pixel grid.
(Only available for `x`, `y`, and `size` scales.)

description:
Default range step for `x` band and point scales of text marks.

__Default value:__ `90`

description:
Use the source data range before aggregation as scale domain instead of aggregated data for aggregate axis.

This is equivalent to setting `domain` to `"unaggregate"` for aggregated _quantitative_ fields by default.

This property only works with aggregate functions that produce values within the raw data domain (`"mean"`, `"average"`, `"median"`, `"q1"`, `"q3"`, `"min"`, `"max"`). For other aggregations that produce values outside of the raw data domain (e.g. `"count"`, `"sum"`), this property is ignored.

__Default value:__ `false`

enum: linear bin-linear log pow sqrt time utc sequential ordinal bin-ordinal point band

description: For sequential and diverging schemes only, determines the extent of the color range to use. For example `[0.2, 1]` will rescale the color scheme such that color values in the range _[0, 0.2)_ are excluded from the scheme.

description:
A color scheme name for sequential/ordinal scales (e.g., `"category10"` or `"viridis"`).

For the full list of supported scheme, please refer to the [Vega Scheme](https://vega.github.io/vega/docs/schemes/#reference) reference.

description:
The default definition for an [`interval`](selection.html#type) selection. All properties and transformations
for an interval selection definition (except `type`) may be specified here.

For instance, setting `interval` to `{"translate": false}` disables the ability to move
interval selections by default.

description:
The default definition for a [`multi`](selection.html#type) selection. All properties and transformations
for a multi selection definition (except `type`) may be specified here.

For instance, setting `multi` to `{"toggle": "event.altKey"}` adds additional values to
multi selections when clicking with the alt-key pressed by default.

description:
The default definition for a [`single`](selection.html#type) selection. All properties and transformations
  for a single selection definition (except `type`) may be specified here.

For instance, setting `single` to `{"on": "dblclick"}` populates single selections on double-click by default.

description:
The field name to extract selected values for, when a selection is [projected](project.html)
over multiple fields or encodings.

description: The name of a selection.

description:
The encoding channel to extract selected values for, when a selection is [projected](project.html)
over multiple fields or encodings.

description: The name of a selection.

description: Filter using a selection name.

enum: x y x2 y2 row column size shape color opacity text tooltip

description:
Establish a two-way binding between a single selection and input elements
(also known as dynamic query widgets). A binding takes the form of
Vega's [input element binding definition](https://vega.github.io/vega/docs/signals/#bind)
or can be a mapping between projected field/encodings and binding definitions.

See the [bind transform](bind.html) documentation for more information.

description:
The data [field](field.html) to sort by.

__Default value:__ If unspecified, defaults to the field specified in the outer data reference.

description:
An [aggregate operation](aggregate.html#ops) to perform on the field prior to sorting (e.g., `"count"`, `"mean"` and `"median"`).
This property is required in cases where the sort field and the data reference field do not match.
The input data objects will be aggregated, grouped by the encoded data field.

For a full list of operations, please see the documentation for [aggregate](aggregate.html#ops).

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description: Whether month names and weekday names should be abbreviated.

description: The stroke width, in pixels.

description:
The width of the ticks.

__Default value:__  2/3 of rangeStep.

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description: The stroke width, in pixels.

description:
Thickness of the tick mark.

__Default value:__  `1`

description: The output field to write the timeUnit value.

description: The data field to apply time unit.

description: The timeUnit.

description:
The anchor position for placing the title. One of `"start"`, `"middle"`, or `"end"`. For example, with an orientation of top these anchor positions map to a left-, center-, or right-aligned title.

__Default value:__ `"middle"` for [single](spec.html) and [layered](layer.html) views.
`"start"` for other composite views.

__Note:__ [For now](https://github.com/vega/vega-lite/issues/2875), `anchor` is only customizable only for [single](spec.html) and [layered](layer.html) views.  For other composite views, `anchor` is always `"start"`.

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

description: The orientation of the title relative to the chart. One of `"top"` (the default), `"bottom"`, `"left"`, or `"right"`.

description:
A [mark style property](config.html#style) to apply to the title text mark.

__Default value:__ `"group-title"`.

description: The title text.

description: URL to [JSON schema](http://json-schema.org/) for a Vega-Lite specification. Unless you have a reason to change this, use `https://vega.github.io/schema/vega-lite/v2.json`. Setting the `$schema` property allows automatic validation and autocomplete in editors that support JSON schema.

description: Vega-Lite configuration object.  This property can only be defined at the top-level of a specification.

description: An object describing the data source

description: Title for the plot.

description: An object describing the data source

description: Title for the plot.

description: An object describing the data source

description: Title for the plot.

description: An object describing the data source

description: Title for the plot.

description: An object describing the data source

description: Title for the plot.

description: An object describing the data source

description: Title for the plot.

description:
The name of the TopoJSON object set to convert to a GeoJSON feature collection.
For example, in a map of the world, there may be an object set named `"countries"`.
Using the feature property, we can extract this set and generate a GeoJSON feature object for each country.

description:
The name of the TopoJSON object set to convert to mesh.
Similar to the `feature` option, `mesh` extracts a named TopoJSON object set.
  Unlike the `feature` option, the corresponding geo data is returned as a single, unified mesh instance, not as individual GeoJSON features.
Extracting a mesh is useful for more efficiently drawing borders or other geographic elements that you do not need to associate with specific regions such as individual countries, states or counties.

description:
Constants and utilities for data type
 Data type based on level of measurement

description: An object that specifies the format for parsing the data file.

description:
An URL from which to load the data set. Use the `format.type` property
to ensure the loaded data is correctly parsed.

enum: utcyearquarter utcyearquartermonth utcyearmonth utcyearmonthdate utcyearmonthdatehours utcyearmonthdatehoursminutes utcyearmonthdatehoursminutesseconds utcquartermonth utcmonthdate utchoursminutes utchoursminutesseconds utcminutesseconds utcsecondsmilliseconds

enum: utcyear utcquarter utcmonth utcday utcdate utchours utcminutes utcseconds utcmilliseconds

description: Definition object for a constant value of an encoding channel.

description:
A ValueDef with Condition<ValueDef | FieldDef>
{
   condition: {field: ...} | {value: ...},
   value: ...,
}

description: A field definition or one or more value definition(s) with a selection predicate.

description: A constant value in visual domain.

description: A constant value in visual domain.

description:
Base object for Vega's Axis and Axis Config.
All of these properties are both properties of Vega's Axis and Axis Config.

description: The size in pixels of axis ticks.

description: Color of gridlines.

description: The grid width, in pixels.

description: The font of the tick label.

description: The font size of the label, in pixels.

description: The color of the axis's tick.

description: The size in pixels of axis ticks.

description: The width, in pixels, of ticks.

description: Angle in degrees of axis titles.

description: Vertical text baseline for axis titles.

description: Font size of the title.

description: Corner radius for the full legend.

description: The height of the gradient, in pixels.

description: The width of the gradient, in pixels.

description: The font of the legend label.

description: The offset of the legend label.

description: The color of the legend symbol,

description: The width of the symbol's stroke.

description: The font of the legend title.

description: The font size of the legend title.

description: The font weight of the legend title.

description: The font size, in pixels.

description: The font style (e.g., `"italic"`).

description: The font weight (e.g., `"bold"`).

description: The stroke width, in pixels.

description: Angle in degrees of title text.

description: Vertical text baseline for title text.

description: Text color for title text.

description: Font name for title text.

description:
Font size in pixels for title text.

__Default value:__ `10`.

description: Font weight for title text.

description: The maximum allowed length in pixels of legend labels.

description: Offset in pixels of the title from the chart body and axes.

description: Default title orientation ("top", "bottom", "left", or "right")

description: Whether the view should be clipped.

description:
The fill color.

__Default value:__ (none)

description:
The fill opacity (value between [0,1]).

__Default value:__ (none)

description:
The default height of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) y-scale with `rangeStep` = `null`.

__Default value:__ `200`

description:
The stroke color.

__Default value:__ (none)

description:
An array of alternating stroke, space lengths for creating dashed or dotted lines.

__Default value:__ (none)

description:
The offset (in pixels) into which to begin drawing with the stroke dash array.

__Default value:__ (none)

description:
The stroke opacity (value between [0,1]).

__Default value:__ (none)

description:
The stroke width, in pixels.

__Default value:__ (none)

description:
The default width of the single plot or each plot in a trellis plot when the visualization has a continuous (non-ordinal) x-scale or ordinal x-scale with `rangeStep` = `null`.

__Default value:__ `200`


enum: all insert delete select update truncate references trigger usage execute create

$ref: #/definitions/onePriv

$ref: #/definitions/schema

$ref: #/definitions/privileges

enum:
always
by default

description: 5 types: Base Type, Composite, Enum, Domain, Range

title: JSON schema for Pyrseas yaml files


fulibWorkflows.schema.json

title: JSON schema for fulibWorkflows

description: Schema for the generation file of fulibWorkflows

description: The title of your current workflow

description: Can be used to address data coming from another source

description: The service on which the following events are executed

description: A command send by a user

description: An event signalling that some system state is reached

description: The following steps define the reaction of a service to some triggering command or event

description: Defines the user who is going to perform an action

description: data object created within a service

description: Defines a ui page

description: Shows a problem/question in the workflow

description: Defines a ui page

$ref: #/$defs/workflowItem

$ref: #/$defs/externalSystemItem

$ref: #/$defs/serviceItem

$ref: #/$defs/commandItem

$ref: #/$defs/eventItem

$ref: #/$defs/policyItem

$ref: #/$defs/userItem

$ref: #/$defs/dataItem

$ref: #/$defs/pageItem

$ref: #/$defs/problemItem

$ref: #/$defs/divItem


haystack-pipeline.schema.json

description: Haystack Pipeline YAML file describing the nodes of the pipelines. For more info read the docs at: https://haystack.deepset.ai/components/pipelines#yaml-file-definitions

const: ignore

title: Haystack Pipeline


jsbeautifyrc.json

$ref: #/definitions/CHJProperties

$ref: #/definitions/HJProperties

$ref: #/definitions/CProperties

$ref: #/definitions/HProperties

$ref: #/definitions/JProperties

description: Indent size. [JS,CSS,HTML]

description: Indentation character. [JS,CSS,HTML]

description: Character(s) to use as line terminators. [JS,CSS,HTML]

description: Indent with tabs, overrides 'indent_size' and 'indent_char' [JS,CSS,HTML]

description: Ensure newline at end of file. [JS,CSS,HTML]

description: Preserve line-breaks. [JS,CSS,HTML]

description: Number of line-breaks to be preserved in one chunk. [JS,HTML]

description: [collapse|expand|end-expand|none][,preserve-inline]  [JS,HTML]

default: collapse

enum: collapse expand end-expand none collapse,preserve-inline expand,preserve-inline end-expand,preserve-inline none,preserve-inline

description: Wrap lines at next opportunity after N characters. [JS,HTML]

description: Add a newline between multiple selectors. [CSS]

description: Add a newline between CSS rules. [CSS]

description: (Deprecated: use space_around_combinator) [CSS]

description: Ensure space around selector separators (>+~). [CSS]

description: HTLM void elements - aka self-closing tags. [HTML]

default: area base br col embed hr img input keygen link menuitem meta param source track wbr !doctype ?xml ?php basefont isindex

description: Wrap attributes to new lines. [HTML]

default: auto

enum: auto force force-aligned force-expand-multiline

description: Indent wrapped attributes to after N characters. Defaults to 'indent_size'. [HTML]

description: Indent <head> and <body> sections. [HTML]

description: [keep|separate|normal] [HTML]

default: normal

enum: keep separate normal

description: List of tags that should not be reformatted. [HTML]

default: a abbr area audio b bdi bdo br button canvas cite code data datalist del dfn em embed i iframe img input ins kbd keygen label map mark math meter noscript object output progress q ruby s samp select small span strong sub sup svg template textarea time u var video wbr text acronym address big dt ins strike tt

description: List of tags whose content should not be reformatted. [HTML]

description: List of tags that should have an extra newline before them. [HTML]

default: head body /html

description: Indent elements within html <body> element. [HTML]

description: Indent elements within html <head> element. [HTML]

description: format and indent {{#foo}} and {{/foo}}. [HTML]

description: Initial indentation level. [JS]

description: Add padding spaces within parentheses, ie. f( a, b ). [JS]

description: Leave space in empty parentheses, ie. f( ). [JS]

description: Enable jslint-stricter mode. (Forces 'space_after_anon_function') [JS]

description: Add a space before an anonymous function's parens, ie. function (). [JS]

description: Break chained method calls across subsequent lines. [JS]

description: Preserve array indentation. [JS]

description: Preserve function indentation. [JS]

description: Ensure a space before conditional statement. [JS]

description: Decode printable characters encoded in xNN notation. [JS]

description: Put commas at the beginning of new line instead of end. [JS]

description: Move operators to before or after a new line, or keep as is. [JS]

default: before-newline

description: Pass E4X xml literals through untouched. [JS]

description: Unindent chained methods. [JS]

title: JSON schema for beautifyrc


crowdin.json

description: Configuration for Crowdin, a crowd-translation platform.

title: Project ID

title: Project ID Environment Variable

title: API Token

title: API Token Environment Variable

title: Base Path

title: Base Path Environment Variable

title: Base URL

format: uri

title: Base URL Environment Variable

title: Preserve Hierarchy

title: Commit Message

title: Append Commit Message

description: Replace the default commit message with the one specified in commit_message.

title: Export Languages

description: Specify a list of specific languages to export.

title: Language

title: Files

title: File

title: Source

title: Translation

title: Ignore

title: Translation Replace

title: Excluded Target Languages

title: Excluded Target Language

title: Scheme

title: Destination

title: Type

title: Update Option

title: Translate Content

description: Defines whether to translate texts placed inside the tags.

title: Translate Attributes

description: Defines whether to translate tags' attributes.

title: Content Segmentation

description: Defines whether to split long texts into smaller text segments.

title: Translatable Elements

description: An array of strings, where each item is the XPaths to DOM element that should be imported.

title: Translatable Element

title: Skip Untranslated Strings

title: Skip Untranslated Files

title: Export Only Approved

title: Escape Quotes

description: Defines whether a single quote should be escaped by another single quote or backslash in exported translations.

title: Escape Sepcial Characters

description: Defines whether any special characters (=, :, ! and #) should be escaped by backslash in exported translations.

title: First Line Contains Header

title: Language Mapping

title: Labels

title: Label


lego.json

description: This object or string represents the file format

$ref: #/$defs/fileFormat

description: This object represents a file format

description: Name of block file

description: Path to file template

description: An array of your app's blocks.

description: The name of the block type

description: Path relative to root where the block will be stored

description: Is this a file? or a folder? False by default.

description: Files making up the block

$ref: #/$defs/file

required: type path

description: An object mapping file objects to strings


$ref: #/definitions/dependencies

$ref: #/definitions/compilationOptions

type: string object

default: default

enum: default build

description: Restrict this dependency to matching only a Project or a Package

enum: project package

type: string array

description:
A command line script or scripts.

Available variables:
%project:Directory% - The project directory
%project:Name% - The project name
%project:Version% - The project version

description: Pairs of destination folders and glob patterns specifying additional files to include in the output NuGet package. (data type: JSON map). Example: { "tools/": "tools/**/*.*" }

description: Glob pattern to specify files to exclude from publish output. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to compile. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from compilation. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include in compilation (overrides 'compileExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to include as content. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from the content list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include as content (overrides 'contentExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from use for preprocessing. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include to use for preprocessing (overrides 'preprocessExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to include as resources. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from the resources list. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include as resources (overrides 'resourceExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to specify files to share with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Glob pattern to specify files to exclude from sharing with dependent projects. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Files to include for sharing with dependent projects (overrides 'sharedExclude'). (data type: string or array). Example: [ "Folder1/File1.ext", "Folder2/File2.ext" ]

description: Glob pattern to indicate files to exclude from other glob patterns, in addition to the default patterns specified in 'excludeBuiltIn'. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

description: Default glob pattern to indicate files to exclude from other glob patterns. (data type: string or array with glob pattern(s)). Example: [ "Folder1/*.ext", "Folder2/*.ext" ]

default: bin/** obj/** **/*.xproj

description: Configurations are named groups of compilation settings. There are two defaults built into the runtime: 'Debug' and 'Release'.

description: Copyright details for the package.

description: A URL for the image to use as the icon for the package. This should be a 32x32-pixel .png file that has a transparent background.

description: A link to the license for the package.

description: A Boolean value that specifies whether the client needs to ensure that the package license (described by licenseUrl) is accepted before the package is installed.

description: A URL for the home page of the package.

description: A short description of the package.

description: A space-delimited list of tags and keywords that describe the package.

description: The human-friendly title of the package

description: A description of the changes made in each release of the package.

description: The locale ID for the package, such as en-us.

description: The description of the project/package.

$ref: #/definitions/configType

description: Overrides the generated resource names with custom ones.

description: Contains information about the repository where the project is stored.

default: git

description: Scripts to execute during the various stages.

$ref: #/definitions/script

description: The version of the project/package. Examples: 1.2.3, 1.2.3-beta, 1.2.3-*

title: JSON schema for DNX project.json files


sponge-mixins.json

description: The dot-separated path to the mixin class relative to the specified package. The class must be annotated with @Mixin

description: Injection options

description: Sets the default minimum of injections that must be successfully applied per injector

description: Sets the default injector group

description: Registers injection points for this configuration

description: Sets the maximum allowed number of opcodes that can be shifted in @At annotations. This is hard capped at 5

description: Overwrite options

description: Sets whether the visibility of overwritten methods should be conformed to the target class

description: Sets whether overwriting methods must explicitly be declared through @Overwrite annotations

description: The name of a parent configuration that options get inherited from

description: Target selector. Either the specifies the phase directly or use "@env(PHASE)" separated by '&', '\', or ' '

description: Minimum version of the mixin subsystem required for this configuration

description: Minimum compatibility level required for mixins in this set

description: Determines whether mixin failures in this configuration are considered terminal and stop the game

description: The priority of this configuration. Will be inherited if smaller than 0

description: Default mixin priority for this configuration. Will be inherited if smaller than 0

description: The target package where the mixin classes reside

description: Mixin classes to load in all environments. Class names get prepended with the specified package

description: Mixin classes to load ONLY on client. Class names get prepended with the specified package

description: Mixin classes to load ONLY on server. Class names get prepended with the specified package

description: Sets whether targets' source files will be updated to the mixin source file

description: The path to the reference map resource to use for this configuration

description: Increases log detail level from DEBUG to INFO

description: Name of the mixin config plugin to use for this config