default: off

enum: all trace debug info warn error fatal off

type: string

key: loggerLevel


description: Forces a specific namespace for connectors that perform namespace auto-detection (Advanced).

key: namespace


enum: win linux network oob storage aix hpux solaris tru64 vmx

key: hostType


default: Hardware problem on \${FQDN\} with \${MONITOR_NAME\}.\${NEWLINE\}\${NEWLINE\}\${ALERT_DETAILS\}\${NEWLINE\}\${NEWLINE\}\${FULLREPORT\}

key: hardwareProblemTemplate


type: number string boolean

type: object

key: keyValuePairVariables


type: integer

description: The upper bound of acceptable port numbers.

description: The port number to use if no free ports could be found.

description: The lower bound of acceptable port numbers.

key: generatorPort


description: An integer value indicating the high-end of the range to generate the random number in. If not explicitly provided, defaults to int.MaxValue.

description: An integer value indicating the low-end of the range to generate the random number in.

key: generatorRandom


enum: choice bool float int hex text

pattern: ^(integer|string)$

description: Indicates limitations on the valid values a symbol may be assigned. When specified, the symbol value is attempted to be converted to this type. The datatype "choice" is supported only for parameter symbols and requires providing symbols.choices configuration for the symbol.

key: datatype


type: boolean

description: If true, use UTC time. If false, use local time.

description: The format string to use when converting the date-time to a string representation.

key: generatorNow


required: sourceVariableName fallbackVariableName

description: The name of the symbol whose value will be inspected - if the value is effectively equal to the default value, the value of the symbol referred to by fallbackVariableName is used, otherwise the value of this symbol.

description: The value to consider as being the default - if the value of the symbol referred to by sourceVariableName is equal to this, the value of the symbol referred to in fallbackVariableName is used instead.

description: The name of the symbol to return the value of if the symbol referred to by sourceVariableName has a value equal to the value of defaultValue.

key: generatorCoalesce


description: The name of a different parameter in the template configuration. A copy of its value will be used by this generator's regex to generate the value for this parameter. The value of the source parameter is not modified.

required: regex replacement

description: The regular expression to use to locate the sequence to replace.

description: The replacement for any sequences matched by the supplied regular expression.

type: array

description: An ordered list of key-value pairs indicating the regex replacement actions. Each element of the list must contain exactly the keys 'regex' and 'replacement' - along with their values. These replacements will be applied to the result of the previous replacement (except the first, which acts on the original value from the source).

key: generatorRegex


description: The format of guid to be generated. Accepts a single value from ('n', 'd', 'b', 'p', 'x') for lowercase output or ('N', 'D', 'B', 'P', 'X') for uppercase output. The formats are defined in Guid.ToString() method documentation.

deprecationMessage: This property is not maintained and may be removed in the future. Use defaultFormat instead, or use 'guids' section.

key: generatorGuid


enum: ref const

description: "ref" to reference value from another symbol or "const" for string constant, defaults to "const".

description: Either name of another symbol or string constant.

description: All values to concatenate.

default: false

description: Indication whether null and empty strings should be removed from joining to prevent repetitive separators.

description: The value used as the separator between the values to be concatenated, notice that you can use "/" as folder separator also on Windows since File API will convert it into "\".

key: generatorJoin


description: The symbol to search for a match. Its value will be used by this generator's regex to evaluate if there is a match. The value of the source parameter is not modified.

description: The regular expression to use to match.

key: generatorRegexMatch


description: A guid string to be replaced in source files. Format and casing is not significant in the config as format and casing is preserved based on the particular guid in processed file(s).

key: guid


description: The constant value to be assigned to the symbol.

key: generatorConstant


description: The name of the symbol whose value should have its case changed.

description: Whether the case changed to should be lower case, if false, the value is made to be uppercase instead.

key: generatorCasing


markdownDescription: The recommended action for users to take after installing your app. [Read about post-install actions](https://stripe.com/docs/stripe-apps/post-install-actions).

description: The recommended action for users to take after installing your app. Read about post-install actions: https://stripe.com/docs/stripe-apps/post-install-actions

key: postInstallActionType


description: Attach a comment directly to a value. This comment may be included in generated output on platforms that support it.

key: comment


description: Specifies a protocol by name or number.

key: protocol


description: Specifies a fully qualified domain name with two or more labels.

key: fqdn


description: Specifies an IP address or CIDR IP address range expression.

key: address


description: Specifies a port or port range.

key: port


key: Links


enum: SEMVER CALVER CHRONVER JAVA_RUNTIME JAVA_MODULE CUSTOM


key: Jdeps


key: Architecture


key: Append


key: Category


enum: ALWAYS NEVER RELEASE PRERELEASE RELEASE_PRERELEASE SNAPSHOT

key: Active


key: ApplicationPackage


key: ArtifactOverride


enum: MSIX MSI APPX EXE ZIP INNO NULLSOFT WIX BURN PWA


key: Launcher


enum: ASC BAT CMD DEB DMG EXE JAR MSI NUGET PKG PS1 RPM SH SIG TAR TAR_BZ2 TAR_GZ TAR_XZ TAR_ZST TBZ2 TGZ TXZ ZIP ZST

key: FileType


key: Buildx


enum: INTERACTIVE SILENT SILENT_WITH_PROGRESS


enum: FREEDESKTOP GNOME KDE ELEMENTARY

key: Runtime


enum: NONE CLI DESKTOP WEB MOBILE

key: Stereotype


description: The friendly name of the command.

description: The arguments to pass to the executable file.

description: Specify a relative or absolute directory path.

description: The name of the executable file name. Example: "cmd.exe".

key: commands


description: A Visual Studio event that a command can be bound to.

key: vsbindings


title: target

key: Target


description: Base class for an event callback for an extension

description: The uri of the endpoint that is hit when an event occurs

key: ExtensionEventCallback


description: (optional) Language of this asset. Localized files are served based on the Accept-Language header. Leave blank to signify this file is in the default (or fallback) language. Localized versions of the same file should have the same assetType.

description: (optional) Specify the value of the Type attribute of the asset entry in the VSIX manifest. Can also be an array of strings, in which case multiple asset entries get added for this file. Defaults to the packagePath.

description: (optional) MIME type of the file. Defaults to a best guess based on the file extension and OS settings.

description: (optional) Set to true if you want your file to be URL-addressable. Defaults to false.

description: (optional) Path to the resource within the package. Defaults to the relative path on disk from your root directory.

description: Path to resource on disk, which can be relative to your root directory.

title: file

key: File


type: number

description: The type of value used for a property

key: ContributionPropertyType


title: content

description: A content file that describes the extension to users.

description: The path to the file in the extension.

key: Content


description: The absolute URL of the link.

title: link

key: Link


description: Represents different ways of including contributions based on licensing

key: ContributionLicensingBehaviorType


title: badge

description: A link to external metadata badge.

description: Link the user navigates to when selecting the badge.

description: The absolute URL of the badge image to be displayed.

description: Description of the badge, to be displayed on hover.

key: Badge


description: Specifies a constraint that can be used to dynamically include/exclude a given contribution

description: Constraints can be optionally be applied to one or more of the relationships defined in the contribution. If no relationships are defined then all relationships are associated with the constraint. This means the default behaviour will eliminate the contribution from the tree completely if the constraint is applied.

description: If true, negate the result of the filter (include the contribution if the applied filter returns false instead of true)

description: An optional property that can be specified to group constraints together. All constraints within a group are AND'd together (all must be evaluate to True in order for the contribution to be included). Different groups of constraints are OR'd (only one group needs to evaluate to True for the contribution to be included).

description: Name of the IContributionFilter plugin

description: Fully qualified identifier of a shared constraint

description: Properties that are fed to the contribution filter class

key: ContributionConstraint


description: Optional command attributes.

description: A short description of how to use this command.

description: A no-permission message.

description: The permission required to use the command.

description: A user-friendly description for a command.

type: string array

description: Alternate command names a user may use instead.

key: command


enum: never on-failure on-unhealthy always

key: restartPolicy


enum: black red green yellow blue magenta cyan white bold default reverse underline strikethrough

key: color


description:
A title
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields

title: title

key: custom-commands-prompts-title-property


description:
A key
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields

title: key

key: custom-commands-prompts-key-property


enum: input confirm menu menuFromCommand

description:
A type
https://github.com/jesseduffield/lazygit/blob/master/docs/Custom_Command_Keybindings.md#common-fields

title: type

key: custom-commands-prompts-type-property


description:
pattern_syntax allows user to define named capture group
expressions for future use in grok patterns. Regexp must be a
valid RE2 expression.


description:
Statics is a list of directives that will be evaluated when the
node is considered successful. Each entry of the list is
composed of a target (where to write) and a source (what data to
write).

key: statics


required: name key value

description: The name of the stash. Distinct parsers can manipulate the same cache

description: The expression that defines the string that will be used as a key.

pattern: ^(LFU|LRU|ARC)$

description: The caching strategy to be used : LFU, LRU or ARC (see gcache doc for details). Defaults to LRU.

description: The time to leave of items. Default strategy is LRU.

description: The maximum size of the cache.

description:
The stash section allows a parser to capture data, that can be
later accessed/populated via GetFromStash and SetInStash expr
helpers. Each list item defines a capture directive that is
stored in a separate cache (string:string), with its own maximum
size, eviction rules etc.

key: stash


pattern: ^(LRU|LFU|ARC)$

description: Strategy for cache behavior. See https://pkg.go.dev/github.com/bluele/gcache

description: destination to store the downloaded file to

description: Duration after which cache elements expire

description: url to download file from

pattern: ^(string|regexp)$

description:
The type is mandatory if you want to evaluate the data in
the file, and should be regex for valid (re2) regular
expression per line or string for string per line. The
regexps will be compiled, the strings will be loaded into
a list and both will be kept in memory. Without specifying
a type, the file will be downloaded and stored as file and
not in memory.

description: Maximum size of the cache

description:
data allows user to specify an external source of data. This
section is only relevant when cscli is used to install parser
from hub, as it will download the source_url and store it to
dest_file. When the parser is not installed from the hub,
CrowdSec won't download the URL, but the file must exist for the
parser to be loaded correctly.

key: data


required: extension progId

description: Content type of the file with this extension.

description: The file extension.

description: Indicates whether this file association is used for display icons only.

description: Perceived type of the file with this extension.

description: The matching /progId/id that's associated with this file extension.

description: The registry path to where this file association should be registered with default program.

key: fileAssociation


description: Indicates if extensions should always be shown in Windows Explorer.

description: The name of progId.

description: Icon handler GUID.

description: DDE topic name.

description: Id for localization purpose only.

description: App user model ID for taskbar and jump list grouping.

description: The unique identifier.

description: Indicates whether silent default takeover is allowed.

description: CLSID for the progId

description: The path to the executable.

description: Default icon resource DLL path.

description: DDE application name.

description: Default icon position.

description: Indicates whether application needs to support DDE.

description: Arguments to pass to the executable.

key: progIds


description: The registry path to where this url association should be registered with default program.

description: Id for localization purpose only.

description: The name of the association.

description: The matching /progId/id that's associated with this protocol.

description: The URL protocol to associate.

key: urlAssociation


description: Key/value pairs that provide additional information about the object.

description: A set of distinct strings that provide additional information.

key: propertyBag


description: CoreJS Module

enum: transform-template-literals transform-literals transform-function-name transform-arrow-functions transform-block-scoped-functions transform-classes transform-object-super transform-shorthand-properties transform-duplicate-keys transform-computed-properties transform-for-of transform-sticky-regex transform-dotall-regex transform-unicode-regex transform-spread transform-parameters transform-destructuring transform-block-scoping transform-typeof-symbol transform-new-target transform-regenerator transform-exponentiation-operator transform-async-to-generator proposal-async-generator-functions proposal-object-rest-spread proposal-unicode-property-regex proposal-json-strings proposal-optional-catch-binding transform-named-capturing-groups-regex transform-member-expression-literals transform-property-literals transform-reserved-words proposal-nullish-coalescing-operator proposal-optional-chaining proposal-class-properties proposal-numeric-separator proposal-private-methods transform-unicode-escapes

description: Feature

key: featureOrModule


description: single query

description: multiple queries

description: Query

key: envQuery


description: The name of the extension, or a mapping of the extension to the required version constraint.

key: VersionConstraint


description: URI-like type value of the page object

key: pageObjectType


description: summary of the functionality and use cases

title: Root element description

type: object string

key: rootDescription


enum: actionable clickable editable draggable touchable

key: type


description: track miscellaneous information for the page object

title: Page Object Metadata

key: metadata


description: summary at the method or element level

title: Method description

key: methodDescription


description: String where "${key1} ${key2}" will be expanded into "value1 value2"


examples: ALL actionlint ansible-lint autopep8 bandit black black-py brakeman buf-breaking buf-format buf-lint buildifier cfnlint clang-format clang-tidy clippy cue-fmt detekt detekt-explicit detekt-gradle dotenv-linter eslint flake8 git-diff-check gitleaks gofmt goimports golangci-lint hadolint haml-lint include-what-you-use isort ktlint markdownlint mypy prettier pylint rubocop rubocop-fmt rufo rustfmt scalafmt semgrep shellcheck shfmt sql-formatter standardrb stylelint stylelint-fmt svgo taplo taplo-fmt terraform terraform-fmt terraform-validate tflint yamllint yapf

description:
List of linter IDs
To refer to all linters, use [ALL]


examples: ALL bazel-build bazel-workspace c c# c++ c++-header c++-source c-header c-source c/c++ c/c++-source css cue docker dotenv gemspec go graphql haml html java javascript json kotlin latex markdown php prettier_supported_configs proto python ruby rust sass scala shell sql starlark svg terraform toml typescript yaml zsh

description:
List of filetypes
To refer to all filetypes, use [ALL]


description: Access to the build cache node UI is disabled

const: disabled

key: UiAccessDisabled


description: Generated as startup credentials used for secure access to cache node UI

const: generated

key: UiAccessGenerated


description: Access to the build cache node UI is open for anyone

const: open

key: UiAccessOpen


description: Set the target cache size dynamically based on the disk volume's capacity

const: maxAvailable

key: TargetSizeMaxAvailable


description: Use a fixed target cache size

const: fixed

description: The total available size of the cache in MiB

key: TargetSizeFixed


required: production development

description: Resource type implementation configuration

key: resourceTypeImplementationConfiguration


description: A configuration describing the Core of this bounded context

$comment: This property is optional. The default value is "Core"

description: The entry point of the bounded context's Core.  A relative path to the folder

format: uri-reference

$comment: This schema definition allows only a set of core languages by hard coding it here in the enum property. Can probably be done better

description: Describes which programming language the Core is written in

key: coreConfiguration


required: type language entryPoint

description: The configuration of an interaction layer

description: The entry point of the interaction layer. A relative path to the folder

$comment: This schema definition allows only a set of types by hard coding it here in the enum property. Can probably be done better

description: The type of the interaction layer

description: The programming language of the interaction layer

$comment: This schema definition allows only a set of frameworks by hard coding it here in the enum property. Can probably be done better

description: The framework of the interaction layer

enum: react aurelia

key: interactionLayerConfiguration


title: The name of the related table.

title: The name of of the existing column that requires identifier mapping.

description: Defaults to the owning (parent) table schema.

title: The schema name of the related table.

required: name table

description: The 'JoinMapping' object defines one or more related table identifier mappings.

title: 'JoinMapping' object (database-driven)

key: JoinMapping


description: Defaults to 'Name'; i.e. assumes same name.

title: The name of the join to column.

title: The name of the join column (from the 'Join' table).

title: The SQL statement for the join on bypassing the corresponding 'ToColumn' specification.

description: The 'JoinOn' object defines the join on characteristics for a 'Join' object.

title: 'JoinOn' object (database-driven)

key: JoinOn


title: The name of the related table.

title: The schema name of the related table.

description: The 'TableMapping' object defines one or more related table identifier mappings.

title: 'TableMapping' object (database-driven)

key: TableMapping


enum: EQ NE LT LE GT GE LIKE

description: Defaults to 'EQ' where 'Value' is specified.

title: The where clause equality operator

description: The column name.

title: The column name.

description: This must be valid formatted/escaped SQL.

title: The comparison value

enum: ISNULL ISNOTNULL

description: This enables statements such as 'WHERE (COL IS NULL)' or 'WHERE (COL IS NULL OR COL = VALUE)' (where .

title: The where nullability clause operator

description: This should only be used where the column value is largely immutable; otherwise, unintended side-effects may occur. _NTangle_ uses the condition explictily and does not attempt to handle value change to infer creation or deletion of data as a result of the underlying change; as such, this should be used cautiously. Note that the 'where' is applied when querying the 'cdc.fn_cdc_get_all_changes_...' function, not the underlying table itself.

title: 'Where' object (database-driven)

key: Where


description: Encapsulates a message intended to be read by the end user.

description: An array of strings to substitute into the message string.

description: A plain text message string.

description: A rich text message string.

description: The resource id for a rich text message string.

description: The resource id for a plain text message string.

key: message


description: A logical location of a construct that produced a result.

description: The human-readable fully qualified name of the logical location.

description: The type of construct this logicalLocationComponent refers to. Should be one of 'function', 'member', 'module', 'namespace', 'package', 'parameter', 'resource', 'returnType', 'type', or 'variable', if any of those accurately describe the construct.

description: The machine-readable name for the logical location, such as a mangled function name provided by a C++ compiler that encodes calling convention, return type and other details along with the function name.

description: Identifies the key of the immediate parent of the construct in which the result was detected. For example, this property might point to a logical location that represents the namespace that holds a type.

description: Identifies the construct in which the result occurred. For example, this property might contain the name of a class or a method.

key: logicalLocation


description: Represents content from an external file.

description: UTF-8-encoded content from a text file.

description: MIME Base64-encoded content from a binary file, or from a text file in its original encoding.

key: fileContent


description: Information about a rule that can be configured at runtime.

default: warning

enum: note warning error open

description: Specifies the default severity level of the result.

description: Specifies whether the rule will be evaluated during the scan.

description: Contains configuration information specific to this rule.

description: A set of distinct strings that provide additional configuration information.

key: ruleConfiguration


description: Specifies the location of a file.

description: A string containing a valid relative or absolute URI.

description: A string which indirectly specifies the absolute URI with respect to which a relative URI in the "uri" property is interpreted.

key: fileLocation


required: value algorithm

description: A hash value of some file or collection of files, together with the hash function used to compute the hash.

description: The name of the hash function used to compute the hash value specified in the 'value' property.

description: The hash value of some file or collection of files, computed by the hash function named in the 'algorithm' property.

key: hash


description: The analysis tool that was run.

description: The name of the tool.

default: en-US

description: The tool language (expressed as an ISO 649 two-letter lowercase culture code) and region (expressed as an ISO 3166 two-letter uppercase subculture code associated with a country or region).

description: The tool version, in whatever format the tool natively provides.

description: The absolute URI from which the tool can be downloaded.

format: uri

description: The tool version in the format specified by Semantic Versioning 2.0.

description: The name of the tool along with its version and any other useful identifying information, such as its locale.

description: A version that uniquely identifies the SARIF logging component that generated this file, if it is versioned separately from the tool.

description: Key/value pairs that provide additional information about the tool.

description: A set of distinct strings that provide additional information.

description: The binary version of the tool's primary executable file (for operating systems such as Windows that provide that information).

key: tool


description: Specifies the information necessary to retrieve a desired revision from a version control system.

description: The date and time at which the revision was created.

format: date-time

description: A string that uniquely and permanently identifies the revision within the repository.

description: The absolute URI of the repository.

description: A tag that has been applied to the revision.

description: The name of a branch containing the revision.

description: Key/value pairs that provide additional information about the revision.

key: versionControlDetails


required: before after

description: Amount of time (ISO 8601 duration format) to sleep after function/subflow invocation. Does not apply if 'eventRef' is defined.

description: Amount of time (ISO 8601 duration format) to sleep before function/subflow invocation. Does not apply if 'eventRef' is defined.

key: sleep


description: Produce an event and set its data

description: Add additional event extension context attributes

type: string object

description: If String, expression which selects parts of the states data output to become the data of the produced event. If object a custom object to become the data of produced event.

description: References a name of a defined event

key: produceeventdef


description: Workflow expression to filter the state data input

description: Workflow expression that filters the state data output

key: statedatafilter


description: URI of the JSON Schema used to validate the workflow

description: Workflow data input schema definition

description: Determines if error should be thrown if there are validation errors

description: The JSON Schema object used to validate the workflow

key: validationSchema


description: Unique id of the sub-workflow to be invoked

description: Specifies a sub-workflow to be invoked

description: Version of the sub-workflow to be invoked

default: terminate

enum: continue terminate

description: If invoke is 'async', specifies how subflow execution should behave when parent workflow completes. Default is 'terminate'

default: sync

enum: sync async

description: Specifies if the subflow should be invoked sync or async

key: subflowref


description: Workflow expression that selects state data that the state action can use

description: If set to false, action data results are not added/merged to state data. In this case 'results' and 'toStateData' should be ignored. Default is true.

description: Workflow expression that filters the actions data results

description: Workflow expression that selects a state data element to which the action results should be added/merged into. If not specified, denote, the top-level state data element

key: actiondatafilter


description: Event References

description: Maximum amount of time (ISO 8601 format) to wait for the result event. If not defined it should default to the actionExecutionTimeout

description: Add additional extension context attributes to the produced event

description: Reference to the unique name of a 'produced' event definition

description: Reference to the unique name of a 'consumed' event definition

description: If string type, an expression which selects parts of the states data output to become the data (payload) of the event referenced by 'produceEventRef'. If object type, a custom object to become the data (payload) of the event referenced by 'produceEventRef'.

key: eventref


description: Cron expression defining when workflow instances should be created (automatically)

description: Specific date and time (ISO 8601 format) when the cron expression invocation is no longer valid

description: Repeating interval (cron expression) describing when the workflow instance should be created

key: crondef


description: Workflow expression that filters the received event payload (default: '${ . }')

description: Workflow expression that selects a state data element to which the filtered event should be added/merged into. If not specified, denotes, the top-level state data element.

description: If set to false, event payload is not added/merged to state data. In this case 'data' and 'toStateData' should be ignored. Default is true.

key: eventdatafilter


description: Name of the referenced function

description: Function Reference

description: Specifies if the function should be invoked sync or async

description: Name of the referenced function

description: Only used if function type is 'graphql'. A string containing a valid GraphQL selection set

description: Function arguments/inputs

key: functionref


description:
Sets the secondary axis of a custom coordinate system. The actual secondary axis of the custom coordinate system might differ from the vector specified, since the secondary axis must be a unit vector perpendicular to the primary axis.

If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the secondary axis.

title: Secondary axis

key: spaceSecondaryAxis


description:
Used to specify which _set_ the exported parameter will use. In most cases, this will be either `left` or `right`.

If not set, the JSON output will use set: null.

title: Output set

key: set


project

category: Angle

description:
If set to a string, the angle will be calculated in two dimensions on the specified coordinate plane by ignoring the component of the input signals which is not part of the plane.

Using a PlaneSequence, projects the input vectors on the provided plane.

Note: _The projection is only applied for vector-based angles and is ignored when calculating joint angles._

title: project (Angle category option)

key: categoryOption Angle project


description:
Used to create a space that aligns with the specified segment. The resulting space will be rotated in 90 degree increments relative to the world space.

The rotation is based on the average orientation of the segment during a measurement.

title: Segment to align to

title: Align with segment

key: spaceAlignWithSegment


description: A parameter node defines steps used to calculate a value or a sequence of values. The result is exported to the global scope and exported in the resulting JSON file.

title: Marker node

key: marker


title: Event node

key: event


space

description:
This option lets you reference a space where you want the input data for the step to be translated into.

All named inputs will automatically be converted.

NOTE: This is not yet implemented for segments.

title: space (global option)

key: globalOption space


output

description:
If this option is set, the result of this step will be exposed on the local scope.

The value of this option will be the name of the output data and can be used to load the resulting data in other steps within the same output node.

You can also use the short-form "arrow syntax" to define an output.

title: output (global option)

key: globalOption output


title: Space node

key: space


rotationOrder

description:
The rotation order to use for calculating the Euler angle. Possible rotation orders are:

Cardan sequence: XYZ YZX ZXY XZY YXZ ZYX

Euler sequence: XYX XZX YXY YZY ZXZ ZYZ

title: rotationOrder (Angle category option)

key: categoryOption Angle rotationOrder


title: Parameter node

key: parameter


export

description:
If this option is set, the result of this step will be exposed on the global scope, as well as being exported to the resulting JSON file.

The value of this option will be the name of the exported data and can be used to load the resulting data in other steps.

title: export (global option)

key: globalOption export


description: Sets the origin of a custom coordinate system.

title: Origin

key: spaceOrigin


title: Marker node

key: segment


frameSequenceOrder

category: Arithmetic

description:
If set to any value but none, the input signals will pass through a function which returns a list of signals where each value is from a frame greater than or equal to the frame of the corresponding value from the preceding Signal.

If set to forward, it will start from the first value of the first (leftmost) input signal (operand) and the algorithm will look at subsequent operands (to the right) one "row" at a time.

Conversely, if set to reverse, the event sequencing uses the reverse order of operands and goes from right to left.

If a full "row" of values could not be matched, it is not included in the result, i.e., all operands will be of the same length.

This is useful, for example, when calculating the distance between two signals at a certain event.

The function will only apply if all input signals have applied a Frames filter, otherwise the signals are left untouched.

Example

subtract: [LeftFoot.y@LFS, RightFoot.y@RFS]            frameSequenceOrder: reverse

_Creates an event sequence from the inputs, starting from the second operand (RFS event) and creates event pairs RFS -> LFS out of the values. It then subtracts each frame from the RightFoot from the corresponding LeftFoot frame._

_If frameSequenceOrder had been set to forward, it would have created pairs going from LFS -> RFS instead._

_Using the frameSequenceOrder option ensures that the operands starts with the intended event and that both operands have the same length._

title: frameSequenceOrder (Arithmetic category option)


description:
Sets the primary axis of a custom coordinate system. The primary axis of the custom coordinate system will always be a unit vector with the same direction as this vector.

If more than one vectors is given, for example [myMarker1, myMarker2], the vector difference between the first two vectors is used as the primary axis.

title: Primary axis

key: spacePrimaryAxis


set

description:
Used to specify which set the exported parameter will use. In most cases, this will be either left or right.

This option is only used in two cases; where there is also an export option set, or on the last step in a list. In the latter case, the step's set is used only if there's no set defined on the parent output node.

If this option is not set, the JSON output will use set: null.

title: set (global option)

key: globalOption set


unwrap

description:
When set to true, an event, or a numeric value, the unwrap option shifts the angle phases in order to achieve a continuous curve, i.e., it tries to detect when an angle crosses over its available range (-PI to PI for radians, -180 to 180 degrees).

This allows for tracking angles on movements that goes outside of the typical angle range.

To do this, it looks for jumps between consecutive angles. If the jump is greater than a threshold of half the range (PI for radians, 180 for degrees), the angle is shifted by adding multiples of of the range until the jump no longer crosses the threshold.

The unwrap algorithm is run over all available components.

If set to true or 0, the algorithm aligns the unwrap to the start of the sequence. I.e., it assumes the first frame is correct in being within the original range and the following angles are moved to follow suit.

If set to an Event or a Number, the algorithm will assume that the corresponding frame is correct in being within the original range. All other angles will be shifted to follow suit. This enables tracking a rotational movement where the angle for a specific event is intended to be within the standard range (-PI to PI for radians, -180 to 180 degrees).

IF a supplied event has more than one instance, the first instance is used.

Note: _The unwrap algorithm is sensitive to noise, which may introduce unexpected artifacts. Please consider filtering the signal(s) before calculating its angle using unwrap._

title: unwrap (Angle category option)

type: string boolean number

key: categoryOption Angle unwrap


enum: xy yx xz yz zy

description:
Defines what axis the primary and secondary axis corresponds to. The first letter defines the name of the primary axis, and the second letter defines the name of the secondary axis.

Possible values:
xy - Primary axis: x, secondary axis: y
yx - Primary axis: y, secondary axis: x
xz - Primary axis: x, secondary axis: z
yz - Primary axis: y, secondary axis: z
zy - Primary axis: z, secondary axis: y

title: Order

key: spaceOrder


enum: first last

type: integer string

description: Out of a number of matching measurements, pick the nth match. Either a 1-based index, or the values `first` or `last` to select the first or last match, respectively.

title: Index filter

description: Target a measurement by name

title: Name filter

title: Field to match against

description: Target a measurement by a field value.

title: Field filter

description:
When importing a signal or defining an output node, you can specify a measurement from which the signal should be imported – or for which measurement an output node should run.

You can filter measurements by name and by field values and you can use wildcard characters `*` to formulate patterns to match partial values. The matching of values is case-insensitive.

When using a measurement filter, a list of matching measurements is created. By specifying the `index` option, you can define which of the matching measurements should apply.

title: Measurement filtering

key: where


useCycles

category: Aggregation

description:
If the signal has cycles defined, the aggregation will be run separately over each signal, and a list of values are returned, one for each cycle.

To avoid this behaviour, set useCycles to false.

For information on how to set event cycles on a signal, see the eventMask step.

title: useCycles (Aggregation category option)

type: string boolean

key: categoryOption Aggregation useCycles


description: define a template layer to import

key: ImportCfg


description: default answer for confirmation of execution

description: message to display

description: command to execute

key: ScriptCfg


title: CollectionStringModel

key: CollectionStringModel


title: Source

title: Version

enum: galaxy url file git dir subdirs

title: Type

title: Name

title: CollectionModel

key: CollectionModel


default: git

title: Scm

title: Src

default: master

title: Version

title: Name

title: Role

key: RoleModel


title: Include

title: IncludeModel

key: IncludeModel


enum: all runtime compile build contentFiles native analyzers none

key: libraryIncludeFlag


description:
A command line script or scripts.

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

key: script


description: Set this option to preserve reference assemblies and other context data to allow for runtime compilation

enum: portable full

description: [Deprecated] Options that are passed to the compiler. Use 'buildOptions' instead.

title: compilation options

key: compilationOptions


description: Sets the maximum number of threads for the thread pool.

description: Specifies the exact processors that garbage collector threads should use.

description: Specifies whether to affinitize garbage collection threads with processors. To affinitize a GC thread means that it can only run on its specific CPU. A heap is created for each GC thread.

description: Specifies the maximum commit size, in bytes, for the GC heap and GC bookkeeping.

description: Enables/disables concurrent garbage collection.

description: Specifies the list of processors to use for garbage collector threads.

description: Specifies the threshold size, in bytes, that causes objects to go on the large object heap (LOH).

description: Configures whether segments that should be deleted are put on a standby list for future use or are released back to the operating system (OS).

description: Limits the number of heaps created by the garbage collector.

description: Enables/disables server garbage collection.

description: Specifies the GC heap usage as a percentage of the total memory.

description: Sets the minimum number of threads for the thread pool.

title: config options

description: Determines if the framework version is strictly obeyed by the host.

description: Properties of the shared framework to use when activating the application.

title: framework options

title: runtime options

key: runtimeOptions


$comment: go tool dist list

description: Architecture

key: arch


description: OS mapping

description: Removal notes for this OS

description: string to insert

description: string to replace

description: List of from-to pairs for renaming links to binaries

description: Override for the global filename format

description: Download is a raw binary

description: Extraction has root directory, generally the same name as the archive

description: Installation notes for this OS


description: Operating system

enum: win macos linux

key: os


description: Configures the properties of the SIL Kit Logging Service

description: Enables receiving of remote log messages from other participants

description: Log name; Results in the following filename: <LogName>_%y-%m-%dT%h-%m-%s.txt

enum: Remote File Stdout

default: Info

enum: Critical Error Warn Info Debug Trace Off

key: Logging


description: Name of the network. Optional; Defaults to the endpoint name

key: Network


description: Time offset for a static symbol windows in macroticks (range 1 - 63)

description: Duration of a mini slot in macroticks (2 - 63)

description: Duration of a static slot in macroticks (range 3 - 664)

description: Duration of LOW Phase of a wakeup symbol in gdBit (range 15 - 60)

description: Time offset for a static slot in macroticks (range 1 - 63)

description: Maximum number of distinct sync frame identifiers present in a given cluster (range 2 - 15)

description: Number of macroticks per cycle (range 8 - 16000)

description: Threshold used for testing the vClockCorrectionFailed counter (range 1 - 15)

description: Upper limit for the startup listen timeout and wakeup listen timeout in the presence of noise; Used as a multiplier of pdListenTimeout (range 2 - 16)

description: Number of attempts for a cold start before giving up (range 2-31)

description: Duration of the idle phase within a dynamic slot in gdMiniSlots (range 0 - 2)

description: Number of mini slots (range 0 - 7988)

description: Length of the payload of a static frame in 16-Bits words (range 0 - 127)

description: Number of static slots in a cycle (range 2 - 1023)

description: Duration of the symbol window in macroticks (range 0 - 162)

description: Duration of TSS (Transmission Start Sequence) in gdBits (range 1 - 15)

description: Max cycle count value in a given cluster (range 7-63, must be an odd integer)

description: Duration of the idle of a wakeup symbol in gdBit (45 - 180)

description: Time offset for a mini slot in macroticks (range 1- 31)

key: FlexrayClusterParameters


description: Name of the communication channel between DataPublisher and DataSubscribers

key: Topic


description: Name of a trace source used as a simulation message source for this controller

enum: Send Receive Both

description: Filter messages to use from the trace source by their direction. May be Send, Receive or Both

description: Path of an MDF channel's source information object

description: Name of an MDF channel group

description: Path of an MDF channel group's source information object

description: Name of an MDF channel's source information object

description: Name of an MDF channel group's source information object

description: Name of an MDF channel in the trace source

key: Replay


description: Name of the RPC function called by RpcClients on RpcServers

key: RpcFunctionName


description: Free text commenting on or summarizing this configuration. Optional

key: Description


description: Name of the endpoint

key: Name


description: Start of the offset correction phase within the NIT, (7 - 15999 macroticks)

description: Controls the transition to halt state due to clock synchronization errors. (values 0, 1)

description: Shall the node enter key slot only mode after startup. (values 0, 1) (AUTOSAR pSingleSlotEnabled)

description: Number of repetitions of the wakeup symbol (range 0 - 63, value 0 or 1 prevents sending of WUP)

description: Key slot is used for sync (values 0, 1)

description: Number of samples per microtick (values 1, 2)

enum: A B

description: Channel used by the node to send a wakeup pattern

description: Allowed deviation for startup frames during integration in microticks (range 29 - 2743)

description: Slot ID of the key slot (range 0 - 1023; value 0 means that there is no key slot)

description: Required number of consecutive even / odd cycle pairs for normal passive to normal active (range 0 - 31)

description: Last mini slot which can be transmitted (range 0 - 7988)

enum: A B AB None

description: Channel(s) to which the controller is connected

description: Maximum permissible offset correction value (range 15 - 16082 microticks)

description: Key slot is used for startup (values 0, 1)

description: Offset between secondary time reference and MT boundary (range 0 - 239 microticks)

description: Maximum permissible rate correction value (range 3 - 3846 microticks)

description: Nominal number of microticks in the communication cycle (range 960 - 1280000)

description: Initial startup offset for frame reference point on channel B (range 2 - 68 macroticks)

description: Initial startup offset for frame reference point on channel A (range 2 - 68 macroticks)

description: Duration of a FlexRay microtick

description: Cluster drift damping factor for rate correction in microticks (range 0 - 10)

description: Duration of listen phase in microticks (range 1926 - 2567692)

key: FlexrayNodeParameters


description: Set the PPindicator

description: Header CRC, 11 bits

description: The slot Id of frame

description: Channel(s)

enum: SingleShot Continuous

description: SingleShot or Continuous transmission mode

description: Base offset for cycle multiplexing (values 0 - 63)

description: Repetition for cycle multiplexing (values 1, 2, 4, 8, 16, 32, 64)

key: FlexrayTxBufferConfigurations


description: Names of trace sinks to use

key: UseTraceSinks


required: builtin path

description: File within support pack

description: file path within zip file

description: builtin="true" means that a file path is relative to the platform directory within the SDK installation.builtin="false" means the file path is relative to the top level of the unzipped package

key: supportPackFile


description: Directory within support pack

description: directory path within zip file

key: supportPackDirectory


description: Represents the command-line argument placeholder that will be replaced at run-time by a boolean value specifying whether the caller has passed an argument for the specified optional input.

description: Name of the input.

key: IsPresentPlaceholder


description: Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file where the program should write its output data.

description: Name of the output.

key: OutputPathPlaceholder


description: Represents the command-line argument placeholder that will be replaced at run-time by the input argument value.

description: Name of the input.

key: InputValuePlaceholder


description: Represents the command-line argument placeholder that will be replaced at run-time by a local file path pointing to a file containing the input argument value.

description: Name of the input.

key: InputPathPlaceholder


description: Optional configuration that specifies how the task execution may be skipped if the output data exist in cache.

format: duration

key: CachingStrategySpec


description: Optional configuration that specifies how the task should be retried if it fails.

key: RetryStrategySpec


required: question answer

title: StoreInfoFaqQuestion

key: StoreInfoFaqQuestion


description: Overrides the shopware version constraint in the composer.json/manifest.xml file.

title: build

key: Build


description: Limit with RegEx which commits should be considered for the changelog generation.

description: Enables the changelog generation with OpenAI (Requires OPENAI_TOKEN environment variable).

description: Enables the changelog generation.

description: Allows to write RegEx groups into variables which can be used in the template.

description: Allows to override the Go template which renders the Changelog.

title: changelog

key: Changelog


title: Tags

key: tags


required: name prompt

title: Prompt

title: Name

title: Confirm

title: Default

title: Unsafe

title: Private

title: Encrypt

title: Salt Size


description: A string value pointing to a path from the root of the JAR to a nested JAR which should be loaded alongside the outer mod JAR

key: nestedJar


enum: * client server

description: The environment where this mod will be loaded

key: environment


default: default

description: The language adapter to use

description: The entrypoint function or class

description: The entrypoint function or class

key: entrypoint


x-intellij-html-description:
A version range or an array of those that match versions. The following variants are supported:

* matches any version.

Ranges following NPM semver specification:

>=, >, =, < and <

X-ranges to specify variable components, e.g. 1.x

tilde ranges that allow patch version changes, e.g. ~1.2.3

caret ranges that allow up to minor version changes, e.g. ^1.2.3

Exact string matches are always performed as well.

If an array of ranges is used, they're treated as in an "OR" relationship - only one of the ranges needs to match.

markdownDescription:
A version range or an array of those that match versions. The following variants are supported:

- `*` matches any version.
- Ranges following [NPM semver specification](https://docs.npmjs.com/about-semantic-versioning):
  - `>=`, `>`, `=`, `<` and `<=`
  - X-ranges to specify variable components, e.g. `1.x`
  - tilde ranges that allow patch version changes, e.g. `~1.2.3`
  - caret ranges that allow up to minor version changes, e.g. `^1.2.3`
- Exact string matches are always performed as well.

If an array of ranges is used, they're treated as in an "OR" relationship - only one of the ranges needs to match.

description:
A version range that matches versions. The following variants are supported:

- A single asterisk matches any version.
- Ranges following NPM semver specification including >=, >, =, <, <=, X-ranges (1.x), tilde ranges (fixed minor) and caret ranges (fixed major).
- Additionally exact string matches will always be performed.

key: versionRange


description: Custom contact or profile informations

description: Project source code repository. Must be a valid URL

description: IRC channel pertaining to the mod. Must be of a valid URL format

description: Project or user homepage. Must be a valid HTTP/HTTPS address

description: Contact e-mail pertaining to the mod

description: Project issue tracker. Must be a valid HTTP/HTTPS address

key: contactInfo


description: Action configuration

title: Action

required: id name trigger default_interval

description: Interval at which the schedule will run

description: Human readable description for the action

default: schedule

description: Trigger for the action

description: Path of the Micro that will handle the action request

description: Unique identifier for the action (needs to be unique across the app)

description: Human readable name for the action (needs to be unique across the app)

key: action


description: Environment variable

title: Env

description: Default value of the environment variable

description: Name of the environment variable

description: Human readable description

key: env


description: Specify environment variables to be injected when using --env

description: Start a script even if it is already running (only the script path is considered)

description: Specify environment variables to be injected (when passing --env)

description: Number of times a script is restarted when it exits in less than min_uptime

description: Enable or disable apm wrapping

description: Enable or disable the watch mode

description: Number of instances to be started in cluster mode

description: Interpreter absolute path. Defaults to node

description: Enable or disable the source map support

description: Set user id. Defaults to current user uid

description: Enable or disable auto restart after process failure

description: Format for log timestamps in moment.js format (eg YYYY-MM-DD HH:mm Z)

description: Rename the NODE_APP_INSTANCE environment variable. Defaults to NODE_APP_INSTANCE

description: Path of the script to launch

default: fork

enum: fork cluster

description: Set the execution mode

description: Shortcut to inject a PORT environment variable

description: Only kill the main process, not detached children

description: Time in ms before forcing a reload if app is still not listening/has still not sent ready

description: Minimum uptime of the app to be considered started (format is /[0-9]+(h|m|s)?/, for hours, minutes, seconds, default to ms)

description: If set to true, avoid to suffix logs file with the process id

description: File path where the pid of the started process is written by pm2. Defaults to ~/.pm2/pids/app_name-id.pid

description: Set group id. Defaults to current user gid

description: Object that will be used as an options with chokidar (refer to chokidar documentation)

description: A cron pattern to restart your app

description: Current working directory to start the process with. Defaults to CWD of the current environment (from your shell)

description: List of commands executed after a pull/upgrade operation performed from Keymetrics dashboard

description: Enable or disable the transaction tracing

description: Time in ms before sending the final SIGKILL signal after SIGINT

description: Arguments to pass to the script

description: Alias to combine_logs

description: File path for stderr (each line is appended to this file)

description: Enable or disable apm wrapping

description: Restart the app if an amount of memory is exceeded (format: /0-9?/ K for KB, 'M' for MB, 'G' for GB, default to B)

description: Time in ms to wait before restarting a crashing app

description: List of paths to ignore (regex)

description: Options to pass to the interpreter

description: Define a specific log output type

description: File path for stdout (each line is appended to this file)

description: Shutdown an application with process.send('shutdown') instead of process.kill(pid, SIGINT)

description: Process name in the process list. Defaults to script filename without the extension (app for app.js)

description: Append the environment name to the app name

description: Disable all logs storage

description: Specify the name of an environment variable to inject which increments for each cluster

description: Enable or disable the versioning metadatas (vizion library)

description: Make the process wait for a process.send('ready')

description: Excludes global variables starting with "REACT_" and will not allow their penetration into the cluster

key: app


description: post-deploy action

description: SSH options with no command-line flag, see 'man ssh'

description: GIT remote

description: SSH host

description: SSH user

description: SSH key path. Defaults to $HOME/.ssh

description: Post-setup commands or path to a script on the host machine

description: path in the server

description: Pre-setup command or path to a script on your local machine

description: GIT remote/branch

description: pre-deploy action

key: deploymentEnvironment


required: readModels eventStore

description: The configuration of a resource type

description: Configuration for the resource type for read models

description: Configuration for the resource type for the event store

key: resourceTypeConfiguration


required: Key Operator Value Effect TolerationSeconds

key: Toleration


required: Raw ContentEncoding ContentType

key: Unknown


required: APIGroup Kind Name

key: TypedLocalObjectReference


required: Server Path ReadOnly

key: NFSVolumeSource


key: RKETaint


required: service region url signing-region signing-method signing-name

key: ServiceOverride


key: SchedulerService


required: ClaimName ReadOnly

key: PersistentVolumeClaimVolumeSource


description: CIDR Range for Pods in cluster

description: Virtual IP range that will be used by Kubernetes services

key: KubeControllerService


description: Authorization mode used by kubernetes

description: Authorization mode options

key: AuthzConfig


required: DiskName DataDiskURI CachingMode FSType ReadOnly Kind

key: AzureDiskVolumeSource


key: VirtualCenterConfig


required: Type IntVal StrVal

key: IntOrString


required: Type QPS Burst CacheSize

key: Limit


description: Generate per node kubelet serving certificates created using kube-ca

description: Fail if swap is enabled

description: Cluster DNS service ip

description: Domain of the cluster (default: "cluster.local")

description: The image whose network/ipc namespaces containers in each pod will use

key: KubeletService


required: EndpointsName Path ReadOnly

key: GlusterfsVolumeSource


required: Repository Revision Directory

key: GitRepoVolumeSource


required: VolumePath FSType StoragePolicyName StoragePolicyID

key: VsphereVirtualDiskVolumeSource


required: Registry Volume ReadOnly User Group Tenant

key: QuobyteVolumeSource


required: Path Type

key: HostPathVolumeSource


required: PdID FSType

key: PhotonPersistentDiskVolumeSource


required: Group Resources ResourceNames

key: GroupResources


key: GlobalVsphereOpts


description: Cloud provider type used with calico

key: CalicoNetworkProvider


required: VolumeID FSType Partition ReadOnly

key: AWSElasticBlockStoreVolumeSource


required: Name Key Optional

key: ConfigMapKeySelector


required: DatasetName DatasetUUID

key: FlockerVolumeSource


description: See Issue #33128

description: overrides autodetection. v1 or v2. Defaults to auto

key: BlockStorageOpenstackOpts


required: PDName FSType Partition ReadOnly

key: GCEPersistentDiskVolumeSource


description: required

key: RouteOpenstackOpts


required: Key Path Mode

key: KeyToPath


required: min max

key: LinearAutoscalerParams


required: Audience ExpirationSeconds Path

key: ServiceAccountTokenProjection


key: AciNetworkProvider


required: Key Operator Values

key: LabelSelectorRequirement


required: CACertificates Services

description: Services to rotate their certs

description: Rotate CA Certificates

key: RotateCertificates


description: Ingress Controller image

description: Canal CNI image

description: Cni deployer container image for Cisco ACI

description: Weave Node image

description: OpenvSwitch container image for Cisco ACI

description: KubeDNS autoscaler image

description: Calico Controllers image

description: Pod infra container image

description: GBP Server container image for Cisco ACI

description: Alpine image

description: mcast daemon container image for Cisco ACI

description: rke-nginx-proxy image

description: rke-cert-deployer image

description: Opflex Server container image for Cisco ACI

description: Pod infra container image for Windows

description: Flannel CNI image

description: Weave CNI image

description: KubeDNS image

description: Canal Node Image

description: Nodelocal image

description: etcd image

description: Kubernetes image

description: Ingress Controller Backend image

description: host container image for Cisco ACI

description: Calico Node image

description: Ingress Webhook image

description: CalicoFlexVol image

description: Canal Controllers Image needed for Calico/Canal v3.14.0+

description: rke-service-sidekick image

description: Metrics Server image

description: Flannel image

description: opflex agent container image for Cisco ACI

description: CanalFlannel image

description: CoreDNS autoscaler image

description: Controller container image for Cisco ACI

description: Calicoctl image

description: KubeDNS side car image

description: DNSMasq image

description: CoreDNS image

description: Calico CNI image

description: CanalFlexVol image

key: RKESystemImages


key: WorkspaceVsphereOpts


required: cloud tenantId subscriptionId resourceGroup location vnetName vnetResourceGroup subnetName securityGroupName routeTableName primaryAvailabilitySetName vmType primaryScaleSetName aadClientId aadClientSecret aadClientCertPath aadClientCertPassword cloudProviderBackoff cloudProviderBackoffRetries cloudProviderBackoffExponent cloudProviderBackoffDuration cloudProviderBackoffJitter cloudProviderRateLimit cloudProviderRateLimitQPS cloudProviderRateLimitBucket useInstanceMetadata useManagedIdentityExtension maximumLoadBalancerRuleCount

description: The name of the security group attached to the cluster's subnet

description:
Use managed service identity for the virtual machine to access Azure ARM APIs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview
For user-assigned managed identity, need to set the below UserAssignedIdentityID

description: Backoff retry limit

description: The cloud environment identifier. Takes values from https://github.com/Azure/go-autorest/blob/ec5f4903f77ed9927ac95b19ab8e44ada64c1356/autorest/azure/environments.go#L13

description:
The ClientSecret for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md

description:
The Client ID of the user assigned MSI which is assigned to the underlying VMs
This's used for managed identity authentication: https://docs.microsoft.com/en-us/azure/active-directory/managed-service-identity/overview

description:
Excludes master nodes (labeled with `node-role.kubernetes.io/master`) from the backend pool of Azure standard loadbalancer, default(nil) to `true`
If want adding the master nodes to ALB, this should be set to `false` and remove the `node-role.kubernetes.io/master` label from master nodes

description: Backoff duration

description: The name of the resource group that the cluster is deployed in

description:
The type of azure nodes. Candidate valudes are: vmss and standard.
If not set, it will be default to standard.

description: Use instance metadata service where possible

description: The location of the resource group that the cluster is deployed in

description: Sku of Load Balancer and Public IP: `basic` or `standard`, default(blank) to `basic`

description: Backoff jitter

description: The ID of the Azure Subscription that the cluster is deployed in

description: (Optional in 1.6) The name of the route table attached to the subnet that the cluster is deployed in

description: The name of the resource group that the Vnet is deployed in

description: The name of the VNet that the cluster is deployed in

description:
The ClientID for an AAD application with RBAC access to talk to Azure RM APIs
This's used for service principal authentication: https://github.com/Azure/aks-engine/blob/master/docs/topics/service-principals.md

description: Rate limit Bucket Size

description: Backoff exponent

description: Rate limit QPS

description:
The password of the client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service

description: Enable exponential backoff to manage resource request retries

description:
(Optional) The name of the availability set that should be used as the load balancer backend
If this is set, the Azure cloudprovider will only add nodes from that availability set to the load
balancer backend pool. If this is not set, and multiple agent pools (availability sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (availability sets), you MUST set this field.

description:
The path of a client certificate for an AAD application with RBAC access to talk to Azure RM APIs
This's used for client certificate authentication: https://docs.microsoft.com/en-us/azure/active-directory/develop/active-directory-protocols-oauth-service-to-service

description: Maximum allowed LoadBalancer Rule Count is the limit enforced by Azure Load balancer, default(0) to 148

description: Enable rate limiting

description: The AAD Tenant ID for the Subscription that the cluster is deployed in

description:
The name of the scale set that should be used as the load balancer backend.
If this is set, the Azure cloudprovider will only add nodes from that scale set to the load
balancer backend pool. If this is not set, and multiple agent pools (scale sets) are used, then
the cloudprovider will try to add all nodes to a single backend pool which is forbidden.
In other words, if you use multiple agent pools (scale sets), you MUST set this field.

description: The name of the subnet that the cluster is deployed in

key: AzureCloudProvider


required: search-order request-timeout

key: MetadataOpenstackOpts


description: Ignore proxy environment variables

description: SSH Certificate

description: SSH Private Key

description: SSH Agent Auth enable

description: SSH Private Key Path

description: SSH Certificate Path

description: ssh User to Bastion Host

description: Address of Bastion Host

description: SSH Port of Bastion Host

key: BastionHost


required: APIVersion FieldPath

key: ObjectFieldSelector


required: SecretName ShareName ReadOnly

key: AzureFileVolumeSource


description: CacheTimeout controls how long to cache authentication decisions

description: ConfigFile is a multiline string that represent a custom webhook config file

key: AuthWebhookConfig


description:
Period of time in seconds given to each pod to terminate gracefully.
If negative, the default value specified in the pod will be used

description: Continue even if there are pods using emptyDir

description:
Drain node even if there are pods not managed by a ReplicationController, Job, or DaemonSet
Drain will not proceed without Force set to true if there are such pods

description: Time to wait (in seconds) before giving up for one try

description:
If there are DaemonSet-managed pods, drain will not proceed without IgnoreDaemonSets set to true
(even when set to true, kubectl won't delete pods - so setting default to true)

key: NodeDrainInput


required: auth-url username user-id password tenant-id tenant-name trust-id domain-id domain-name region ca-file

key: GlobalOpenstackOpts


required: VolumeID FSType ReadOnly

key: PortworxVolumeSource


required: zone vpc subnet-id routetable-id role-arn kubernetes-cluster-tag kubernetes-cluster-id disable-security-group-ingress elb-security-group disable-strict-zone-check

description: KubernetesClusterTag is the legacy cluster id we'll use to identify our cluster resources

description: RoleARN is the IAM role to assume when interaction with AWS APIs.

description:
TODO: Is there any use for this?  We can get it from the instance metadata service
Maybe if we're not running on AWS, e.g. bootstrap; for now it is not very useful

description:
During the instantiation of an new AWS cloud provider, the detected region
is validated against a known set of regions.

In a non-standard, AWS like environment (e.g. Eucalyptus), this check may
be undesirable.  Setting this to true will disable the check and provide
a warning that the check was skipped.  Please note that this is an
experimental feature and work-in-progress for the moment.  If you find
yourself in an non-AWS cloud and open an issue, please indicate that in the
issue body.

description: RouteTableID enables using a specific RouteTable

description:
The aws provider creates an inbound rule per load balancer on the node security
group. However, this can run into the AWS security group rule limit of 50 if
many LoadBalancers are created.

This flag disables the automatic ingress creation. It requires that the user
has setup a rule that allows inbound traffic on kubelet ports from the
local VPC subnet (so load balancers can access it). E.g. 10.82.0.0/16 30000-32000.

description: SubnetID enables using a specific subnet to use for ELB's

description:
The AWS VPC flag enables the possibility to run the master components
on a different aws account, on a different cloud provider or on-premises.
If the flag is set also the KubernetesClusterTag must be provided

description: KubernetesClusterID is the cluster id we'll use to identify our cluster resources

description:
AWS has a hard limit of 500 security groups. For large clusters creating a security group for each ELB
can cause the max number of security groups to be reached. If this is set instead of creating a new
Security group for each ELB this security group will be used instead.

key: GlobalAwsOpts


required: lb-version use-octavia subnet-id floating-network-id lb-method lb-provider create-monitor monitor-delay monitor-timeout monitor-max-retries manage-security-groups

description: overrides autodetection.

description: overrides autodetection. Only support v2.

description: If specified, will create floating ip for loadbalancer, or do not create floating ip.

description: default to ROUND_ROBIN.

description: uses Octavia V2 service catalog endpoint

key: LoadBalancerOpenstackOpts


required: APIVersion Kind Name UID Controller BlockOwnerDeletion

key: OwnerReference


required: TargetWWNs Lun FSType ReadOnly WWIDs

key: FCVolumeSource


description: Alternate cloud interface for flannel

key: FlannelNetworkProvider


key: KubeproxyService


required: Name ReadOnly MountPath SubPath MountPropagation SubPathExpr

key: ExtraVolumeMount


key: ECRCredentialPlugin


required: Name Key Optional

key: SecretKeySelector


description: Custom property defined for this schema.

description: Definition of an entity subtype.

description: Array of strings specifying which template schemas to apply to this type.

description: Definition of a template schema.

description: Template schemas that can be reused by entity subtypes.

description: Array of strings defining the entity subtypes defined by the schema.

key: entity


description: Removes the rule.

key: nullRule


enum: catch do else finally for function if try while

key: blockKeywords


enum: ArrayExpression ArrayPattern ArrowFunctionExpression AssignmentExpression AssignmentPattern BinaryExpression BlockStatement BreakStatement CallExpression CatchClause ClassBody ClassDeclaration ClassExpression ConditionalExpression ContinueStatement DebuggerStatement DoWhileStatement EmptyStatement ExportAllDeclaration ExportDefaultDeclaration ExportNamedDeclaration ExportSpecifier ExpressionStatement ForInStatement ForStatement FunctionDeclaration FunctionExpression Identifier IfStatement ImportDeclaration ImportDefaultSpecifier ImportNamespaceSpecifier ImportSpecifier LabeledStatement Literal LogicalExpression MemberExpression MethodDefinition NewExpression ObjectExpression ObjectPattern Program Property RestElement ReturnStatement SequenceExpression SpreadElement Super SwitchCase SwitchStatement TaggedTemplateExpression TemplateElement TemplateLiteral ThisExpression ThrowStatement TryStatement UnaryExpression UpdateExpression VariableDeclaration VariableDeclarator WhileStatement WithStatement

key: esprimaNodeTypes


enum: break case catch continue debugger default delete do else finally for function if in instanceof new return switch this throw try typeof var void while with

key: keywords


description: Number of elements to be skipped during return - used for pagination.

key: skip


type: boolean string

description: If true, this chat room (name, description and messages) non-participants can search for this room. If false, only participants can search for this room.

key: discoverable


description: A list of key-value pairs, describing additional properties of the room.


description: True if only one reply is expected to the form. Default is false

description: Form's id. The id should be the same as activity's one that sent the form.

key: form-replied-event-inner


required: user-id tenant-id

type: string integer

description: Member's user id.

description: Member's tenant id.

key: group-member


description: If true, this room is a cross-pod room.

key: cross-pod


description: Path to the file to be attached to the message. The path is relative to the workflows folder.

key: attachment-file


description: Inline template message content in string.

description: External message template file path.

description: The content of the message in MessageML format. Must contain at least one space. In case the content is a form, this latter's id should be the same as the activity one.

key: content-inner


description: Room's name. Room names will be considered the same if they only differ in capitalization and whitespace. E.g. "room1" and "R O O M 1" are considered the same. Also, room names must be shorter than 50 characters.

key: room-name


description: Token to authorize incoming http requests.

description: Event's identifier, should be unique across workflow. As it can be used as a variable identifier only alphanumerical characters are allowed.

key: request-received-event-inner


description: If true, any chat room participant can add new participants. If false, only owners can add new participants.

key: members-can-invite


description: Allow user to use Agent Encrypt endpoints.

description: Can Toggle Room's Share History Property.

description: Can integrate email service.

description: Must be recorded in meetings.

description: Enables Lite Mode.

description: Allows the user to chat in external IM/MIMs.

description: Allows the user to send files internally.

description: Allows the user to chat in private external rooms.

description: Allows the user to read wall posts.

description: Can suppress own messages.

description: Enable Media access on SDA.

description: Allows the user to use video in internal meetings on mobile.

description: Can switch to Client 2.0 experience.

description: Allows the user to create push signals.

description: Allows the user to share screens in internal meetings on mobile.

description: Enable Pointer Lock on SDA.

description: Allows the user to edit profile picture.

description: Allows the user to share screens in internal Meetings.

description: Allows the user to create internal public rooms.

description: Enable Full screen access on SDA.

description: Allows the user to share files externally.

description: Allows the user to view shared screens in internal meetings on mobile.

description: Allow notifications on SDA.

description: Allows the user to use audio in internal Meetings.

description: Can create datahose feeds.

description: Enable Developer Tools for SDA.

description: Can read from datahose feeds.

description: Enable location access on SDA.

description: Enable access to MIDI Sysex on SDA.

description: Allows the user to create multi-lateral room.

description: Allows the user to use video in internal Meetings.

description: Allows the user to join multi-lateral room.

description: Allows the user to use audio in internal meetings on mobile.

description: Allows the user to use Firehose.

description: Allows the user to have delegates.

description: Allows the user to view shared screens in internal Meetings.

description: Allows the user to write wall posts.

description: Can Use Swift Search.

description: Allow Opening External Apps from SDA.

description: Allows the user to manage signal subscriptions.

description: Feature entitlements to configure for the user.

key: entitlements-inner


$comment: Variable or email regex is accepted.

description: Email address, must be unique

key: email


description: Room's description.

key: room-description


enum: ACTIVE DELETED

description: Filter by status, active or deleted. If not specified both are returned.

description: Cursor that points to the end of the current page of data. If not present, the current page is the last page.

description: Numbers of items to return.

default: SDL

description: Group type id.

enum: ASC DESC

description: NOT SUPPORTED YET, currently ignored. Cursor that points to the start of the current page of data. If not present, the current page is the first page.

key: get-groups-inner


description: Business information

enum:
Healthcare
Consumer Non-Cyclicals
Transportation
Technology
Real Estate
Basic Materials
Financials
Energy & Utilities
Conglomerates
Consumer Cyclicals
Services

description: The user's job industries (one or more).

description: The user's division.

enum:
Collateral
Confirmation
Trade Processing
Pre-Matching
Margin
Matching
Claims Processing
Middle Office
Liquidity Management
Allocation
Trade Management
Regulatory Outreach
Settlements
Post Trade Management

description: The user's job functions (one or more).

enum:
Analyst
Other
Business Development Executive
Corporate Access
Developer
Director
Economist
Portfolio Manager
Project Manager
Research Analyst
Sales
Strategist
Trader

description: The user's job function.

description: The user's title.

enum:
Securities
Fixed Income
Equities

description: The user's instruments (one or more).

enum:
Equities
Cash Equities
Securities Lending
Fixed Income
Government Bonds
Prime Brokerage
Commodities
Municipal Bonds
Currencies
Corporate Bonds

description: The user's asset classes (one or more).

enum: BAU Escalation

description: The user's responsibilities (one or more).

description:
The user's company name.
If not specified, it is set with the default company name.

description: The user's location.

description: The user's department.

enum: EMEA NA APAC LATAM

description: The user's market coverage (one or more).

key: business


key: user-requested-join-room-event-inner


x-intellij-html-description:
If true, this is a public chatroom. If false, a private chatroom.
Note: Once this value is set for a room, it is read-only and can’t be updated.

key: public


description: If false, the room is not active anymore.

key: active


description: Group's unique identifier.

key: group-id


description: Event's identifier, should be unique across workflow. As it can be used as a variable identifier only alphanumerical characters are allowed.

key: user-left-room-event-inner


x-intellij-html-description:
If true, only stream owners can send messages.
Note: Once this value is set for a room, it is read-only and can’t be updated.

key: read-only


description: User id.

key: user-id


description: If true, new members can view the room chat history of the room.

key: view-history


description: Contains the host and the path to be targeted

$comment: String format is required for all content types except multipart/form-data

description: HTTP request body

$comment: Object format is required for multipart/form-data content type

description: HTTP request body

description: If enabled, the query parameters will be encoded in application/x-www-form-urlencoded

default: GET

enum: GET POST PUT DELETE PATCH HEAD OPTIONS

description: HTTP method to perform

description: HTTP request headers

key: execute-request-inner


description: Maximum number of elements to be returned - used for pagination.

key: limit


description: If true, it searches for active users only. If false, it searches for inactive users only. If not set, it searches for all users regardless of their status.

description: If true then a local DB search will be performed and only local pod users will be returned. If absent or false then a directory search will be performed and users from other pods who are visible to the calling user will also be returned.

key: search-user-inner


description: ISO 8601 date representing a point in time when the current activity should be executed.

key: at


key: tenants-users-list


x-intellij-language-injection: Groovy

description: Script to execute (only Groovy is supported)

key: execute-script-inner


description: Stream ids to sent the message to (blast message).

key: stream-ids


description: The user's work phone number.

key: phoneNumber


description: ISO 8601 repeating intervals to repeat the current activity.

key: repeat


description: Message content to listen to.

description: If true, the event is only triggered if the bot is mentioned.

key: message-received-event-inner


required: id type

default: TENANT

enum: TENANT PLATFORM USER

description: Owner type. Only TENANT supported now.

description: Owner id if the owner type is tenant (podId) or user (userId), otherwise null.

key: group-owner


x-intellij-html-description:
The roles object consists of the following possibilities:
For end-user accounts: INDIVIDUAL, ADMINISTRATOR, SUPER_ADMINISTRATOR, L1_SUPPORT, L2_SUPPORT, COMPLIANCE_OFFICER, SUPER_COMPLIANCE_OFFICER

For service accounts: INDIVIDUAL, USER_PROVISIONING, SCOPE_MANAGEMENT, CONTENT_MANAGEMENT, MALWARE_SCAN_MANAGER, MALWARE_SCAN_STATE_USER, AUDIT_TRAIL_MANAGEMENT

https://developers.symphony.com/restapi/reference#roles-object

key: roles-inner


key: user-joined-room-event-inner


x-intellij-html-description:
If true, users cannot copy content from this room.
Note: Once this value is set to true for a room, it is read-only and can’t be updated.

key: copy-protected


enum: SAVE EXTEND REVOKE

description:
A string indicating the action to be performed on the user's RSA.

The following actions can be performed on the user's active RSA key:
SAVE
REVOKE.

The following actions can be performed onto the user's rotated RSA key:
REVOKE
EXTEND.

description: An ISO 8601 timestamp containing the RSA key expiration date. This value is only set for rotated keys.

description: A string containing the user's RSA public key. The key must be 4096 bits. Only PKCS8 format is allowed.

key: key-inner


description: If true, this is a multilateral room where users belonging to more than 2 companies can be found.

key: multilateral-room


description: Old version backup name.

key: backupName


description: Execute script commands.

key: script


description: Delete localpath after deployment.

key: removeLocalDir


description: Buffer or string that contains a private key for either key-based or hostbased user authentication (OpenSSH format).

key: privateKey


description: Empty the old version before deploying the new version.

key: clearRemoteDir


description: For an encrypted privateKey, this is the passphrase used to decrypt it.

key: passphrase


enum: MyCode LibraryCode UnrelatedCode

key: classification


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

key: SingleDefChannel


enum: second minute hour day week month year

key: NiceTime


enum: utcyear utcquarter utcmonth utcday utcdate utchours utcminutes utcseconds utcmilliseconds

key: UtcSingleTimeUnit


description:
The stroke width, in pixels.

__Default value:__ (none)

description: Whether the view should be clipped.

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`

description:
The stroke 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 offset (in pixels) into which to begin drawing with the stroke dash array.

__Default value:__ (none)

description:
The stroke color.

__Default value:__ (none)

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

__Default value:__ (none)

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

__Default value:__ (none)

description:
The fill color.

__Default value:__ (none)

key: ViewConfig


enum: year quarter month day date hours minutes seconds milliseconds

key: LocalSingleTimeUnit


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

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

key: ValueDef


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)

enum: csv tsv

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.

key: CsvDataFormat


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: A minimum allowable step size (particularly useful for integer values).

description:
An exact step size to use between bins.

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

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

__Default value:__ `10`

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

description:
Maximum number of bins.

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

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

key: BaseBin


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.

key: JsonDataFormat


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

description: All types of primitive marks.

key: Mark


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

key: LegendOrient


enum: rgb cubehelix cubehelix-long

key: InterpolateParams


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

__Default value:__ `true`

description: Angle in degrees of axis titles.

description: Vertical text baseline for axis titles.

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

description:
Color of axis domain line.

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

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

__Default value:__  `true`.

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

description: The grid width, in pixels.

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 padding, in pixels, between title and axis.

description: Horizontal text alignment of axis titles.

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: Boolean value that determines whether the axis should include ticks.

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

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

description: Color of gridlines.

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 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: X-coordinate of the axis title relative to the axis group.

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

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

__Default value:__ (`1` by default)

description: The width, in pixels, of ticks.

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: Font size of the title.

description: The font of the tick label.

description:
The rotation angle of the axis labels.

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

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

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

description:
Stroke width of axis domain line

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

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: Y-coordinate of the axis title relative to the axis group.

description: The color of the axis's tick.

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`.

description: Maximum allowed pixel width of axis titles.

description: The size in pixels of axis ticks.

description: Maximum allowed pixel width of axis tick labels.

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

type: string number

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

key: VgAxisConfig


required: input options

type: string

key: VgRadioBinding


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

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

key: Header


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

key: Interpolate


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

key: SchemeParams


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

key: ScaleType


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

key: UtcMultiTimeUnit


enum: json csv tsv topojson

key: DataFormatType


enum: global union intersect

key: SelectionResolution


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

key: SelectionDomain


description: Reference to a repeated value.

enum: row column

key: RepeatRef


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

__Default value:__ `true`

description: Angle in degrees of axis titles.

description: Vertical text baseline for axis titles.

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

description:
Color of axis domain line.

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

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

__Default value:__  `true`.

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

description: The grid width, in pixels.

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

__Default value:__  `false`

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 padding, in pixels, between title and axis.

description: Horizontal text alignment of axis titles.

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: Boolean value that determines whether the axis should include ticks.

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

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

description: Color of gridlines.

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 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: X-coordinate of the axis title relative to the axis group.

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

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

__Default value:__ (`1` by default)

description: The width, in pixels, of ticks.

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: Font size of the title.

description: The font of the tick label.

description:
The rotation angle of the axis labels.

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

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.

key: AxisConfig